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

zitadel.getOrg

Explore with Pulumi AI

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

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.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumi.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = Zitadel.GetOrg.Invoke(new()
    {
        Id = "123456789012345678",
    });

    return new Dictionary<string, object?>
    {
        ["org"] = @default,
    };
});
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := zitadel.LookupOrg(ctx, &zitadel.LookupOrgArgs{
			Id: "123456789012345678",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("org", _default)
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.ZitadelFunctions;
import com.pulumi.zitadel.inputs.GetOrgArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = ZitadelFunctions.getOrg(GetOrgArgs.builder()
            .id("123456789012345678")
            .build());

        ctx.export("org", default_);
    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumi/zitadel";

const default = zitadel.getOrg({
    id: "123456789012345678",
});
export const org = _default;
Copy
import pulumi
import pulumi_zitadel as zitadel

default = zitadel.get_org(id="123456789012345678")
pulumi.export("org", default)
Copy
variables:
  default:
    fn::invoke:
      Function: zitadel:getOrg
      Arguments:
        id: '123456789012345678'
outputs:
  org: ${default}
Copy

Using getOrg

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 getOrg(args: GetOrgArgs, opts?: InvokeOptions): Promise<GetOrgResult>
function getOrgOutput(args: GetOrgOutputArgs, opts?: InvokeOptions): Output<GetOrgResult>
Copy
def get_org(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetOrgResult
def get_org_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetOrgResult]
Copy
func LookupOrg(ctx *Context, args *LookupOrgArgs, opts ...InvokeOption) (*LookupOrgResult, error)
func LookupOrgOutput(ctx *Context, args *LookupOrgOutputArgs, opts ...InvokeOption) LookupOrgResultOutput
Copy

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

public static class GetOrg 
{
    public static Task<GetOrgResult> InvokeAsync(GetOrgArgs args, InvokeOptions? opts = null)
    public static Output<GetOrgResult> Invoke(GetOrgInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrgResult> getOrg(GetOrgArgs args, InvokeOptions options)
public static Output<GetOrgResult> getOrg(GetOrgArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zitadel:index/getOrg:getOrg
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
ID of the organization
Id This property is required. string
ID of the organization
id This property is required. String
ID of the organization
id This property is required. string
ID of the organization
id This property is required. str
ID of the organization
id This property is required. String
ID of the organization

getOrg Result

The following output properties are available:

Id string
ID of the organization
IsDefault bool
Indicates whether the org is the default org of the instance.
Name string
Name of the org.
PrimaryDomain string
Primary domain of the org
State string
State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
Id string
ID of the organization
IsDefault bool
Indicates whether the org is the default org of the instance.
Name string
Name of the org.
PrimaryDomain string
Primary domain of the org
State string
State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
id String
ID of the organization
isDefault Boolean
Indicates whether the org is the default org of the instance.
name String
Name of the org.
primaryDomain String
Primary domain of the org
state String
State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
id string
ID of the organization
isDefault boolean
Indicates whether the org is the default org of the instance.
name string
Name of the org.
primaryDomain string
Primary domain of the org
state string
State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
id str
ID of the organization
is_default bool
Indicates whether the org is the default org of the instance.
name str
Name of the org.
primary_domain str
Primary domain of the org
state str
State of the org, supported values: ORGSTATEUNSPECIFIED, ORGSTATEACTIVE, ORGSTATEINACTIVE, ORGSTATEREMOVED
id String
ID of the organization
isDefault Boolean
Indicates whether the org is the default org of the instance.
name String
Name of the org.
primaryDomain String
Primary domain of the org
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 v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse