1. Registry
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getClientGrantOrganizations
Viewing docs for Auth0 v3.51.0
published on Tuesday, Aug 18, 2026 by Pulumi
auth0 logo auth0 logo
Viewing docs for Auth0 v3.51.0
published on Tuesday, Aug 18, 2026 by Pulumi

    Data source to retrieve all organizations associated with a specific client grant (EA only).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const myClientGrantOrganizations = auth0.getClientGrantOrganizations({
        clientGrantId: "cgr_XXXXX",
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    my_client_grant_organizations = auth0.get_client_grant_organizations(client_grant_id="cgr_XXXXX")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := auth0.GetClientGrantOrganizations(ctx, &auth0.GetClientGrantOrganizationsArgs{
    			ClientGrantId: "cgr_XXXXX",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        var myClientGrantOrganizations = Auth0.GetClientGrantOrganizations.Invoke(new()
        {
            ClientGrantId = "cgr_XXXXX",
        });
    
    });
    
    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.GetClientGrantOrganizationsArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 myClientGrantOrganizations = Auth0Functions.getClientGrantOrganizations(GetClientGrantOrganizationsArgs.builder()
                .clientGrantId("cgr_XXXXX")
                .build());
    
        }
    }
    
    variables:
      myClientGrantOrganizations:
        fn::invoke:
          function: auth0:getClientGrantOrganizations
          arguments:
            clientGrantId: cgr_XXXXX
    
    pulumi {
      required_providers {
        auth0 = {
          source = "pulumi/auth0"
        }
      }
    }
    
    data "auth0_getclientgrantorganizations" "myClientGrantOrganizations" {
      client_grant_id = "cgr_XXXXX"
    }
    

    Using getClientGrantOrganizations

    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 getClientGrantOrganizations(args: GetClientGrantOrganizationsArgs, opts?: InvokeOptions): Promise<GetClientGrantOrganizationsResult>
    function getClientGrantOrganizationsOutput(args: GetClientGrantOrganizationsOutputArgs, opts?: InvokeOutputOptions): Output<GetClientGrantOrganizationsResult>
    def get_client_grant_organizations(client_grant_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetClientGrantOrganizationsResult
    def get_client_grant_organizations_output(client_grant_id: pulumi.Input[Optional[str]] = None,
                                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetClientGrantOrganizationsResult]
    func GetClientGrantOrganizations(ctx *Context, args *GetClientGrantOrganizationsArgs, opts ...InvokeOption) (*GetClientGrantOrganizationsResult, error)
    func GetClientGrantOrganizationsOutput(ctx *Context, args *GetClientGrantOrganizationsOutputArgs, opts ...InvokeOption) GetClientGrantOrganizationsResultOutput

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

    public static class GetClientGrantOrganizations 
    {
        public static Task<GetClientGrantOrganizationsResult> InvokeAsync(GetClientGrantOrganizationsArgs args, InvokeOptions? opts = null)
        public static Output<GetClientGrantOrganizationsResult> Invoke(GetClientGrantOrganizationsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetClientGrantOrganizationsResult> Invoke(GetClientGrantOrganizationsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetClientGrantOrganizationsResult> getClientGrantOrganizations(GetClientGrantOrganizationsArgs args, InvokeOptions options)
    public static Output<GetClientGrantOrganizationsResult> getClientGrantOrganizations(GetClientGrantOrganizationsArgs args, InvokeOptions options)
    public static Output<GetClientGrantOrganizationsResult> getClientGrantOrganizations(GetClientGrantOrganizationsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: auth0:index/getClientGrantOrganizations:getClientGrantOrganizations
      arguments:
        # arguments dictionary
    data "auth0_get_client_grant_organizations" "name" {
        # arguments
    }

    The following arguments are supported:

    ClientGrantId string
    The ID of the client grant to retrieve the associated organizations for.
    ClientGrantId string
    The ID of the client grant to retrieve the associated organizations for.
    client_grant_id string
    The ID of the client grant to retrieve the associated organizations for.
    clientGrantId String
    The ID of the client grant to retrieve the associated organizations for.
    clientGrantId string
    The ID of the client grant to retrieve the associated organizations for.
    client_grant_id str
    The ID of the client grant to retrieve the associated organizations for.
    clientGrantId String
    The ID of the client grant to retrieve the associated organizations for.

    getClientGrantOrganizations Result

    The following output properties are available:

    ClientGrantId string
    The ID of the client grant to retrieve the associated organizations for.
    Id string
    The provider-assigned unique ID for this managed resource.
    Organizations List<GetClientGrantOrganizationsOrganization>
    The list of organizations associated with the client grant.
    ClientGrantId string
    The ID of the client grant to retrieve the associated organizations for.
    Id string
    The provider-assigned unique ID for this managed resource.
    Organizations []GetClientGrantOrganizationsOrganization
    The list of organizations associated with the client grant.
    client_grant_id string
    The ID of the client grant to retrieve the associated organizations for.
    id string
    The provider-assigned unique ID for this managed resource.
    organizations list(object)
    The list of organizations associated with the client grant.
    clientGrantId String
    The ID of the client grant to retrieve the associated organizations for.
    id String
    The provider-assigned unique ID for this managed resource.
    organizations List<GetClientGrantOrganizationsOrganization>
    The list of organizations associated with the client grant.
    clientGrantId string
    The ID of the client grant to retrieve the associated organizations for.
    id string
    The provider-assigned unique ID for this managed resource.
    organizations GetClientGrantOrganizationsOrganization[]
    The list of organizations associated with the client grant.
    client_grant_id str
    The ID of the client grant to retrieve the associated organizations for.
    id str
    The provider-assigned unique ID for this managed resource.
    organizations Sequence[GetClientGrantOrganizationsOrganization]
    The list of organizations associated with the client grant.
    clientGrantId String
    The ID of the client grant to retrieve the associated organizations for.
    id String
    The provider-assigned unique ID for this managed resource.
    organizations List<Property Map>
    The list of organizations associated with the client grant.

    Supporting Types

    GetClientGrantOrganizationsOrganization

    Brandings List<GetClientGrantOrganizationsOrganizationBranding>
    How to style the login pages for this organization.
    DisplayName string
    Friendly name of the organization.
    IsAppEntitlementActive bool
    Whether this organization's app entitlement is active (EA only).
    Metadata Dictionary<string, string>
    Metadata associated with the organization.
    Name string
    The name of the organization.
    OrganizationId string
    The ID of the organization.
    ThirdPartyClientAccess string
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    TokenQuotas List<GetClientGrantOrganizationsOrganizationTokenQuota>
    The token quota configuration for this organization.
    Brandings []GetClientGrantOrganizationsOrganizationBranding
    How to style the login pages for this organization.
    DisplayName string
    Friendly name of the organization.
    IsAppEntitlementActive bool
    Whether this organization's app entitlement is active (EA only).
    Metadata map[string]string
    Metadata associated with the organization.
    Name string
    The name of the organization.
    OrganizationId string
    The ID of the organization.
    ThirdPartyClientAccess string
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    TokenQuotas []GetClientGrantOrganizationsOrganizationTokenQuota
    The token quota configuration for this organization.
    brandings list(object)
    How to style the login pages for this organization.
    display_name string
    Friendly name of the organization.
    is_app_entitlement_active bool
    Whether this organization's app entitlement is active (EA only).
    metadata map(string)
    Metadata associated with the organization.
    name string
    The name of the organization.
    organization_id string
    The ID of the organization.
    third_party_client_access string
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    token_quotas list(object)
    The token quota configuration for this organization.
    brandings List<GetClientGrantOrganizationsOrganizationBranding>
    How to style the login pages for this organization.
    displayName String
    Friendly name of the organization.
    isAppEntitlementActive Boolean
    Whether this organization's app entitlement is active (EA only).
    metadata Map<String,String>
    Metadata associated with the organization.
    name String
    The name of the organization.
    organizationId String
    The ID of the organization.
    thirdPartyClientAccess String
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    tokenQuotas List<GetClientGrantOrganizationsOrganizationTokenQuota>
    The token quota configuration for this organization.
    brandings GetClientGrantOrganizationsOrganizationBranding[]
    How to style the login pages for this organization.
    displayName string
    Friendly name of the organization.
    isAppEntitlementActive boolean
    Whether this organization's app entitlement is active (EA only).
    metadata {[key: string]: string}
    Metadata associated with the organization.
    name string
    The name of the organization.
    organizationId string
    The ID of the organization.
    thirdPartyClientAccess string
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    tokenQuotas GetClientGrantOrganizationsOrganizationTokenQuota[]
    The token quota configuration for this organization.
    brandings Sequence[GetClientGrantOrganizationsOrganizationBranding]
    How to style the login pages for this organization.
    display_name str
    Friendly name of the organization.
    is_app_entitlement_active bool
    Whether this organization's app entitlement is active (EA only).
    metadata Mapping[str, str]
    Metadata associated with the organization.
    name str
    The name of the organization.
    organization_id str
    The ID of the organization.
    third_party_client_access str
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    token_quotas Sequence[GetClientGrantOrganizationsOrganizationTokenQuota]
    The token quota configuration for this organization.
    brandings List<Property Map>
    How to style the login pages for this organization.
    displayName String
    Friendly name of the organization.
    isAppEntitlementActive Boolean
    Whether this organization's app entitlement is active (EA only).
    metadata Map<String>
    Metadata associated with the organization.
    name String
    The name of the organization.
    organizationId String
    The ID of the organization.
    thirdPartyClientAccess String
    Controls whether this organization can be used in user flows with third-party clients. Available values are allow or block.
    tokenQuotas List<Property Map>
    The token quota configuration for this organization.

    GetClientGrantOrganizationsOrganizationBranding

    Colors Dictionary<string, string>
    Color scheme used to customize the login pages.
    LogoUrl string
    URL of logo to display on login page.
    Colors map[string]string
    Color scheme used to customize the login pages.
    LogoUrl string
    URL of logo to display on login page.
    colors map(string)
    Color scheme used to customize the login pages.
    logo_url string
    URL of logo to display on login page.
    colors Map<String,String>
    Color scheme used to customize the login pages.
    logoUrl String
    URL of logo to display on login page.
    colors {[key: string]: string}
    Color scheme used to customize the login pages.
    logoUrl string
    URL of logo to display on login page.
    colors Mapping[str, str]
    Color scheme used to customize the login pages.
    logo_url str
    URL of logo to display on login page.
    colors Map<String>
    Color scheme used to customize the login pages.
    logoUrl String
    URL of logo to display on login page.

    GetClientGrantOrganizationsOrganizationTokenQuota

    client_credentials list(object)
    The token quota configuration for client credentials.
    clientCredentials List<Property Map>
    The token quota configuration for client credentials.

    GetClientGrantOrganizationsOrganizationTokenQuotaClientCredential

    Enforce bool
    Whether the quota is enforced.
    PerDay int
    Maximum number of issued tokens per day.
    PerHour int
    Maximum number of issued tokens per hour.
    Enforce bool
    Whether the quota is enforced.
    PerDay int
    Maximum number of issued tokens per day.
    PerHour int
    Maximum number of issued tokens per hour.
    enforce bool
    Whether the quota is enforced.
    per_day number
    Maximum number of issued tokens per day.
    per_hour number
    Maximum number of issued tokens per hour.
    enforce Boolean
    Whether the quota is enforced.
    perDay Integer
    Maximum number of issued tokens per day.
    perHour Integer
    Maximum number of issued tokens per hour.
    enforce boolean
    Whether the quota is enforced.
    perDay number
    Maximum number of issued tokens per day.
    perHour number
    Maximum number of issued tokens per hour.
    enforce bool
    Whether the quota is enforced.
    per_day int
    Maximum number of issued tokens per day.
    per_hour int
    Maximum number of issued tokens per hour.
    enforce Boolean
    Whether the quota is enforced.
    perDay Number
    Maximum number of issued tokens per day.
    perHour Number
    Maximum number of issued tokens per hour.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo auth0 logo
    Viewing docs for Auth0 v3.51.0
    published on Tuesday, Aug 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial