1. Packages
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getOrganization
Viewing docs for Auth0 v2.24.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-auth0

auth0.getOrganization

auth0 logo
Viewing docs for Auth0 v2.24.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-auth0

    Data source to retrieve a specific Auth0 organization by organization_id or name.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var some_organization_by_name = Auth0.GetOrganization.Invoke(new()
    {
        Name = "my-org",
    });

    var some_organization_by_id = Auth0.GetOrganization.Invoke(new()
    {
        OrganizationId = "org_abcdefghkijklmnopqrstuvwxyz0123456789",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.LookupOrganization(ctx, &auth0.LookupOrganizationArgs{
			Name: pulumi.StringRef("my-org"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = auth0.LookupOrganization(ctx, &auth0.LookupOrganizationArgs{
			OrganizationId: pulumi.StringRef("org_abcdefghkijklmnopqrstuvwxyz0123456789"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Auth0Functions;
import com.pulumi.auth0.inputs.GetOrganizationArgs;
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 some-organization-by-name = Auth0Functions.getOrganization(GetOrganizationArgs.builder()
            .name("my-org")
            .build());

        final var some-organization-by-id = Auth0Functions.getOrganization(GetOrganizationArgs.builder()
            .organizationId("org_abcdefghkijklmnopqrstuvwxyz0123456789")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const some-organization-by-name = auth0.getOrganization({
    name: "my-org",
});
const some-organization-by-id = auth0.getOrganization({
    organizationId: "org_abcdefghkijklmnopqrstuvwxyz0123456789",
});

    import pulumi
import pulumi_auth0 as auth0

some_organization_by_name = auth0.get_organization(name="my-org")
some_organization_by_id = auth0.get_organization(organization_id="org_abcdefghkijklmnopqrstuvwxyz0123456789")

    variables:
  some-organization-by-name:
    fn::invoke:
      Function: auth0:getOrganization
      Arguments:
        name: my-org
  some-organization-by-id:
    fn::invoke:
      Function: auth0:getOrganization
      Arguments:
        organizationId: org_abcdefghkijklmnopqrstuvwxyz0123456789

    Using getOrganization

    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 getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>
    def get_organization(name: Optional[str] = None,
                     organization_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(name: Optional[pulumi.Input[str]] = None,
                     organization_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]
    func LookupOrganization(ctx *Context, args *LookupOrganizationArgs, opts ...InvokeOption) (*LookupOrganizationResult, error)
func LookupOrganizationOutput(ctx *Context, args *LookupOrganizationOutputArgs, opts ...InvokeOption) LookupOrganizationResultOutput

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

    public static class GetOrganization 
{
    public static Task<GetOrganizationResult> InvokeAsync(GetOrganizationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationResult> Invoke(GetOrganizationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
public static Output<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)

    fn::invoke:
  function: auth0:index/getOrganization:getOrganization
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    OrganizationId string
    The ID of the organization. If not provided, name must be set.
    Name string
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    OrganizationId string
    The ID of the organization. If not provided, name must be set.
    name String
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organizationId String
    The ID of the organization. If not provided, name must be set.
    name string
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organizationId string
    The ID of the organization. If not provided, name must be set.
    name str
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organization_id str
    The ID of the organization. If not provided, name must be set.
    name String
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organizationId String
    The ID of the organization. If not provided, name must be set.

    getOrganization Result

    The following output properties are available:

    Brandings List<GetOrganizationBranding>
    Defines how to style the login pages.
    Connections List<GetOrganizationConnection>
    DisplayName string
    Friendly name of this organization.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members List<string>
    User ID(s) that are members of the organization.
    Metadata Dictionary<string, string>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    Name string
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    OrganizationId string
    The ID of the organization. If not provided, name must be set.
    Brandings []GetOrganizationBranding
    Defines how to style the login pages.
    Connections []GetOrganizationConnectionType
    DisplayName string
    Friendly name of this organization.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members []string
    User ID(s) that are members of the organization.
    Metadata map[string]string
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    Name string
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    OrganizationId string
    The ID of the organization. If not provided, name must be set.
    brandings List<GetOrganizationBranding>
    Defines how to style the login pages.
    connections List<GetOrganizationConnection>
    displayName String
    Friendly name of this organization.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<String>
    User ID(s) that are members of the organization.
    metadata Map<String,String>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name String
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organizationId String
    The ID of the organization. If not provided, name must be set.
    brandings GetOrganizationBranding[]
    Defines how to style the login pages.
    connections GetOrganizationConnection[]
    displayName string
    Friendly name of this organization.
    id string
    The provider-assigned unique ID for this managed resource.
    members string[]
    User ID(s) that are members of the organization.
    metadata {[key: string]: string}
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name string
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organizationId string
    The ID of the organization. If not provided, name must be set.
    brandings Sequence[GetOrganizationBranding]
    Defines how to style the login pages.
    connections Sequence[GetOrganizationConnection]
    display_name str
    Friendly name of this organization.
    id str
    The provider-assigned unique ID for this managed resource.
    members Sequence[str]
    User ID(s) that are members of the organization.
    metadata Mapping[str, str]
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name str
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organization_id str
    The ID of the organization. If not provided, name must be set.
    brandings List<Property Map>
    Defines how to style the login pages.
    connections List<Property Map>
    displayName String
    Friendly name of this organization.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<String>
    User ID(s) that are members of the organization.
    metadata Map<String>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name String
    The name of the organization. If not provided, organization_id must be set. For performance, it is advised to use the organization_id as a lookup if possible.
    organizationId String
    The ID of the organization. If not provided, name must be set.

    Supporting Types

    GetOrganizationBranding

    Colors Dictionary<string, string>
    LogoUrl string
    Colors map[string]string
    LogoUrl string
    colors Map<String,String>
    logoUrl String
    colors {[key: string]: string}
    logoUrl string
    colors Mapping[str, str]
    logo_url str
    colors Map<String>
    logoUrl String

    GetOrganizationConnection

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Viewing docs for Auth0 v2.24.3 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-auth0
      Try Pulumi Cloud free. Your team will thank you.