Docs Packages
  1. Packages
  2. Zitadel
  3. API Docs
  4. getOrgs
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.getOrgs

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

    Datasource representing an organization in ZITADEL, which is the highest level after the instance and contains several other resource including policies if the configuration differs to the default policies on the instance.

    Using getOrgs

    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 getOrgs(args: GetOrgsArgs, opts?: InvokeOptions): Promise<GetOrgsResult>
function getOrgsOutput(args: GetOrgsOutputArgs, opts?: InvokeOptions): Output<GetOrgsResult>
    def get_orgs(domain: Optional[str] = None,
             domain_method: Optional[str] = None,
             name: Optional[str] = None,
             name_method: Optional[str] = None,
             state: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetOrgsResult
def get_orgs_output(domain: Optional[pulumi.Input[str]] = None,
             domain_method: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             name_method: Optional[pulumi.Input[str]] = None,
             state: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetOrgsResult]
    func GetOrgs(ctx *Context, args *GetOrgsArgs, opts ...InvokeOption) (*GetOrgsResult, error)
func GetOrgsOutput(ctx *Context, args *GetOrgsOutputArgs, opts ...InvokeOption) GetOrgsResultOutput

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

    public static class GetOrgs 
{
    public static Task<GetOrgsResult> InvokeAsync(GetOrgsArgs args, InvokeOptions? opts = null)
    public static Output<GetOrgsResult> Invoke(GetOrgsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrgsResult> getOrgs(GetOrgsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: zitadel:index/getOrgs:getOrgs
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Domain string
    A domain of the org.
    DomainMethod string
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    Name string
    Name of the org.
    NameMethod string
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    State string
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    Domain string
    A domain of the org.
    DomainMethod string
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    Name string
    Name of the org.
    NameMethod string
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    State string
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    domain String
    A domain of the org.
    domainMethod String
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name String
    Name of the org.
    nameMethod String
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state String
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    domain string
    A domain of the org.
    domainMethod string
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name string
    Name of the org.
    nameMethod string
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state string
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    domain str
    A domain of the org.
    domain_method str
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name str
    Name of the org.
    name_method str
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state str
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    domain String
    A domain of the org.
    domainMethod String
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name String
    Name of the org.
    nameMethod String
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state String
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED

    getOrgs Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A set of all organization IDs.
    PrimaryDomain string
    Primary domain of the org
    Domain string
    A domain of the org.
    DomainMethod string
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    Name string
    Name of the org.
    NameMethod string
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    State string
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A set of all organization IDs.
    PrimaryDomain string
    Primary domain of the org
    Domain string
    A domain of the org.
    DomainMethod string
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    Name string
    Name of the org.
    NameMethod string
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    State string
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A set of all organization IDs.
    primaryDomain String
    Primary domain of the org
    domain String
    A domain of the org.
    domainMethod String
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name String
    Name of the org.
    nameMethod String
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state String
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A set of all organization IDs.
    primaryDomain string
    Primary domain of the org
    domain string
    A domain of the org.
    domainMethod string
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name string
    Name of the org.
    nameMethod string
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state string
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A set of all organization IDs.
    primary_domain str
    Primary domain of the org
    domain str
    A domain of the org.
    domain_method str
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name str
    Name of the org.
    name_method str
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state str
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A set of all organization IDs.
    primaryDomain String
    Primary domain of the org
    domain String
    A domain of the org.
    domainMethod String
    Method for querying orgs by domain, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    name String
    Name of the org.
    nameMethod String
    Method for querying orgs by name, supported values: TEXTQUERYMETHODEQUALS, TEXTQUERYMETHODEQUALSIGNORECASE, TEXTQUERYMETHODSTARTSWITH, TEXTQUERYMETHODSTARTSWITHIGNORECASE, TEXTQUERYMETHODCONTAINS, TEXTQUERYMETHODCONTAINSIGNORECASE, TEXTQUERYMETHODENDSWITH, TEXTQUERYMETHODENDSWITHIGNORECASE
    state String
    State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
    pulumiverse/pulumi-zitadel