1. Packages
  2. Zitadel
  3. API Docs
  4. getProjects
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse

zitadel.getProjects

Explore with Pulumi AI

zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse

Datasource representing the project, which can then be granted to different organizations or users directly, containing different applications.

Using getProjects

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProjects(args: GetProjectsArgs, opts?: InvokeOptions): Promise<GetProjectsResult>
function getProjectsOutput(args: GetProjectsOutputArgs, opts?: InvokeOptions): Output<GetProjectsResult>
Copy
def get_projects(name: Optional[str] = None,
                 name_method: Optional[str] = None,
                 org_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetProjectsResult
def get_projects_output(name: Optional[pulumi.Input[str]] = None,
                 name_method: Optional[pulumi.Input[str]] = None,
                 org_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetProjectsResult]
Copy
func GetProjects(ctx *Context, args *GetProjectsArgs, opts ...InvokeOption) (*GetProjectsResult, error)
func GetProjectsOutput(ctx *Context, args *GetProjectsOutputArgs, opts ...InvokeOption) GetProjectsResultOutput
Copy

> Note: This function is named GetProjects in the Go SDK.

public static class GetProjects 
{
    public static Task<GetProjectsResult> InvokeAsync(GetProjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectsResult> Invoke(GetProjectsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
public static Output<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zitadel:index/getProjects:getProjects
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name of the project
NameMethod string
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
OrgId Changes to this property will trigger replacement. string
ID of the organization
Name This property is required. string
Name of the project
NameMethod string
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
OrgId Changes to this property will trigger replacement. string
ID of the organization
name This property is required. String
Name of the project
nameMethod String
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
orgId Changes to this property will trigger replacement. String
ID of the organization
name This property is required. string
Name of the project
nameMethod string
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
orgId Changes to this property will trigger replacement. string
ID of the organization
name This property is required. str
Name of the project
name_method str
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
org_id Changes to this property will trigger replacement. str
ID of the organization
name This property is required. String
Name of the project
nameMethod String
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
orgId Changes to this property will trigger replacement. String
ID of the organization

getProjects Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the project
ProjectIds List<string>
A set of all project IDs.
NameMethod string
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
OrgId string
ID of the organization
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the project
ProjectIds []string
A set of all project IDs.
NameMethod string
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
OrgId string
ID of the organization
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the project
projectIds List<String>
A set of all project IDs.
nameMethod String
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
orgId String
ID of the organization
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the project
projectIds string[]
A set of all project IDs.
nameMethod string
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
orgId string
ID of the organization
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the project
project_ids Sequence[str]
A set of all project IDs.
name_method str
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
org_id str
ID of the organization
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the project
projectIds List<String>
A set of all project IDs.
nameMethod String
Method for querying projects by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
orgId String
ID of the organization

Package Details

Repository
zitadel pulumiverse/pulumi-zitadel
License
Apache-2.0
Notes
This Pulumi package is based on the zitadel Terraform Provider.
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse