1. Registry
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. OrganizationClient
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

    With this resource, you can manage the association between an organization and an application (client), controlling that application’s entitlement to the organization (EA only). This is distinct from auth0.OrganizationClientGrant, which associates an organization with a clientGrant (a client/audience/scopes triple used for client-credentials exchanges).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const myOrganization = new auth0.Organization("my_organization", {
        name: "my-organization",
        displayName: "My Organization",
    });
    const myClient = new auth0.Client("my_client", {name: "My Application"});
    // Entitle the application to the organization (EA only). This is distinct
    // from `auth0_organization_client_grant`, which associates the organization
    // with a client_grant instead of an application.
    const myOrgClient = new auth0.OrganizationClient("my_org_client", {
        organizationId: myOrganization.id,
        clientId: myClient.id,
        useForMemberAccess: true,
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    my_organization = auth0.Organization("my_organization",
        name="my-organization",
        display_name="My Organization")
    my_client = auth0.Client("my_client", name="My Application")
    # Entitle the application to the organization (EA only). This is distinct
    # from `auth0_organization_client_grant`, which associates the organization
    # with a client_grant instead of an application.
    my_org_client = auth0.OrganizationClient("my_org_client",
        organization_id=my_organization.id,
        client_id=my_client.id,
        use_for_member_access=True)
    
    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 {
    		myOrganization, err := auth0.NewOrganization(ctx, "my_organization", &auth0.OrganizationArgs{
    			Name:        pulumi.String("my-organization"),
    			DisplayName: pulumi.String("My Organization"),
    		})
    		if err != nil {
    			return err
    		}
    		myClient, err := auth0.NewClient(ctx, "my_client", &auth0.ClientArgs{
    			Name: pulumi.String("My Application"),
    		})
    		if err != nil {
    			return err
    		}
    		// Entitle the application to the organization (EA only). This is distinct
    		// from `auth0_organization_client_grant`, which associates the organization
    		// with a client_grant instead of an application.
    		_, err = auth0.NewOrganizationClient(ctx, "my_org_client", &auth0.OrganizationClientArgs{
    			OrganizationId:     myOrganization.ID().ToIDOutput().ToStringOutput(),
    			ClientId:           myClient.ID().ToIDOutput().ToStringOutput(),
    			UseForMemberAccess: pulumi.Bool(true),
    		})
    		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 myOrganization = new Auth0.Organization("my_organization", new()
        {
            Name = "my-organization",
            DisplayName = "My Organization",
        });
    
        var myClient = new Auth0.Client("my_client", new()
        {
            Name = "My Application",
        });
    
        // Entitle the application to the organization (EA only). This is distinct
        // from `auth0_organization_client_grant`, which associates the organization
        // with a client_grant instead of an application.
        var myOrgClient = new Auth0.OrganizationClient("my_org_client", new()
        {
            OrganizationId = myOrganization.Id,
            ClientId = myClient.Id,
            UseForMemberAccess = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.Organization;
    import com.pulumi.auth0.OrganizationArgs;
    import com.pulumi.auth0.Client;
    import com.pulumi.auth0.ClientArgs;
    import com.pulumi.auth0.OrganizationClient;
    import com.pulumi.auth0.OrganizationClientArgs;
    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) {
            var myOrganization = new Organization("myOrganization", OrganizationArgs.builder()
                .name("my-organization")
                .displayName("My Organization")
                .build());
    
            var myClient = new Client("myClient", ClientArgs.builder()
                .name("My Application")
                .build());
    
            // Entitle the application to the organization (EA only). This is distinct
            // from `auth0_organization_client_grant`, which associates the organization
            // with a client_grant instead of an application.
            var myOrgClient = new OrganizationClient("myOrgClient", OrganizationClientArgs.builder()
                .organizationId(myOrganization.id())
                .clientId(myClient.id())
                .useForMemberAccess(true)
                .build());
    
        }
    }
    
    resources:
      myOrganization:
        type: auth0:Organization
        name: my_organization
        properties:
          name: my-organization
          displayName: My Organization
      myClient:
        type: auth0:Client
        name: my_client
        properties:
          name: My Application
      # Entitle the application to the organization (EA only). This is distinct
      # from `auth0_organization_client_grant`, which associates the organization
      # with a client_grant instead of an application.
      myOrgClient:
        type: auth0:OrganizationClient
        name: my_org_client
        properties:
          organizationId: ${myOrganization.id}
          clientId: ${myClient.id}
          useForMemberAccess: true
    
    pulumi {
      required_providers {
        auth0 = {
          source = "pulumi/auth0"
        }
      }
    }
    
    resource "auth0_organization" "my_organization" {
      name         = "my-organization"
      display_name = "My Organization"
    }
    resource "auth0_client" "my_client" {
      name = "My Application"
    }
    # Entitle the application to the organization (EA only). This is distinct
    # from `auth0_organization_client_grant`, which associates the organization
    # with a client_grant instead of an application.
    resource "auth0_organizationclient" "my_org_client" {
      organization_id       = auth0_organization.my_organization.id
      client_id             = auth0_client.my_client.id
      use_for_member_access = true
    }
    

    Create OrganizationClient Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationClient(name: string, args: OrganizationClientArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationClient(resource_name: str,
                           args: OrganizationClientArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrganizationClient(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           client_id: Optional[str] = None,
                           organization_id: Optional[str] = None,
                           use_for_member_access: Optional[bool] = None)
    func NewOrganizationClient(ctx *Context, name string, args OrganizationClientArgs, opts ...ResourceOption) (*OrganizationClient, error)
    public OrganizationClient(string name, OrganizationClientArgs args, CustomResourceOptions? opts = null)
    public OrganizationClient(String name, OrganizationClientArgs args)
    public OrganizationClient(String name, OrganizationClientArgs args, CustomResourceOptions options)
    
    type: auth0:OrganizationClient
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "auth0_organization_client" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OrganizationClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrganizationClientArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrganizationClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationClientArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationClientResource = new Auth0.OrganizationClient("organizationClientResource", new()
    {
        ClientId = "string",
        OrganizationId = "string",
        UseForMemberAccess = false,
    });
    
    example, err := auth0.NewOrganizationClient(ctx, "organizationClientResource", &auth0.OrganizationClientArgs{
    	ClientId:           pulumi.String("string"),
    	OrganizationId:     pulumi.String("string"),
    	UseForMemberAccess: pulumi.Bool(false),
    })
    
    resource "auth0_organization_client" "organizationClientResource" {
      lifecycle {
        create_before_destroy = true
      }
      client_id             = "string"
      organization_id       = "string"
      use_for_member_access = false
    }
    
    var organizationClientResource = new OrganizationClient("organizationClientResource", OrganizationClientArgs.builder()
        .clientId("string")
        .organizationId("string")
        .useForMemberAccess(false)
        .build());
    
    organization_client_resource = auth0.OrganizationClient("organizationClientResource",
        client_id="string",
        organization_id="string",
        use_for_member_access=False)
    
    const organizationClientResource = new auth0.OrganizationClient("organizationClientResource", {
        clientId: "string",
        organizationId: "string",
        useForMemberAccess: false,
    });
    
    type: auth0:OrganizationClient
    properties:
        clientId: string
        organizationId: string
        useForMemberAccess: false
    

    OrganizationClient Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrganizationClient resource accepts the following input properties:

    ClientId string
    The ID of the client (application) to associate with the organization.
    OrganizationId string
    The ID of the organization to associate the client (application) with.
    UseForMemberAccess bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    ClientId string
    The ID of the client (application) to associate with the organization.
    OrganizationId string
    The ID of the organization to associate the client (application) with.
    UseForMemberAccess bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    client_id string
    The ID of the client (application) to associate with the organization.
    organization_id string
    The ID of the organization to associate the client (application) with.
    use_for_member_access bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    clientId String
    The ID of the client (application) to associate with the organization.
    organizationId String
    The ID of the organization to associate the client (application) with.
    useForMemberAccess Boolean
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    clientId string
    The ID of the client (application) to associate with the organization.
    organizationId string
    The ID of the organization to associate the client (application) with.
    useForMemberAccess boolean
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    client_id str
    The ID of the client (application) to associate with the organization.
    organization_id str
    The ID of the organization to associate the client (application) with.
    use_for_member_access bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    clientId String
    The ID of the client (application) to associate with the organization.
    organizationId String
    The ID of the organization to associate the client (application) with.
    useForMemberAccess Boolean
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationClient resource produces the following output properties:

    AppType string
    The type of the associated client application.
    GrantTypes List<string>
    The grant types enabled for the associated client.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsFirstParty bool
    Whether the associated client is a first-party client (true) or not (false).
    LogoUri string
    The URI of the associated client's logo.
    Name string
    The name of the associated client.
    OrganizationUsage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    AppType string
    The type of the associated client application.
    GrantTypes []string
    The grant types enabled for the associated client.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsFirstParty bool
    Whether the associated client is a first-party client (true) or not (false).
    LogoUri string
    The URI of the associated client's logo.
    Name string
    The name of the associated client.
    OrganizationUsage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    app_type string
    The type of the associated client application.
    grant_types list(string)
    The grant types enabled for the associated client.
    id string
    The provider-assigned unique ID for this managed resource.
    is_first_party bool
    Whether the associated client is a first-party client (true) or not (false).
    logo_uri string
    The URI of the associated client's logo.
    name string
    The name of the associated client.
    organization_usage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    appType String
    The type of the associated client application.
    grantTypes List<String>
    The grant types enabled for the associated client.
    id String
    The provider-assigned unique ID for this managed resource.
    isFirstParty Boolean
    Whether the associated client is a first-party client (true) or not (false).
    logoUri String
    The URI of the associated client's logo.
    name String
    The name of the associated client.
    organizationUsage String
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    appType string
    The type of the associated client application.
    grantTypes string[]
    The grant types enabled for the associated client.
    id string
    The provider-assigned unique ID for this managed resource.
    isFirstParty boolean
    Whether the associated client is a first-party client (true) or not (false).
    logoUri string
    The URI of the associated client's logo.
    name string
    The name of the associated client.
    organizationUsage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    app_type str
    The type of the associated client application.
    grant_types Sequence[str]
    The grant types enabled for the associated client.
    id str
    The provider-assigned unique ID for this managed resource.
    is_first_party bool
    Whether the associated client is a first-party client (true) or not (false).
    logo_uri str
    The URI of the associated client's logo.
    name str
    The name of the associated client.
    organization_usage str
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    appType String
    The type of the associated client application.
    grantTypes List<String>
    The grant types enabled for the associated client.
    id String
    The provider-assigned unique ID for this managed resource.
    isFirstParty Boolean
    Whether the associated client is a first-party client (true) or not (false).
    logoUri String
    The URI of the associated client's logo.
    name String
    The name of the associated client.
    organizationUsage String
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.

    Look up Existing OrganizationClient Resource

    Get an existing OrganizationClient resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrganizationClientState, opts?: CustomResourceOptions): OrganizationClient
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_type: Optional[str] = None,
            client_id: Optional[str] = None,
            grant_types: Optional[Sequence[str]] = None,
            is_first_party: Optional[bool] = None,
            logo_uri: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            organization_usage: Optional[str] = None,
            use_for_member_access: Optional[bool] = None) -> OrganizationClient
    func GetOrganizationClient(ctx *Context, name string, id IDInput, state *OrganizationClientState, opts ...ResourceOption) (*OrganizationClient, error)
    public static OrganizationClient Get(string name, Input<string> id, OrganizationClientState? state, CustomResourceOptions? opts = null)
    public static OrganizationClient get(String name, Output<String> id, OrganizationClientState state, CustomResourceOptions options)
    resources:  _:    type: auth0:OrganizationClient    get:      id: ${id}
    import {
      to = auth0_organization_client.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppType string
    The type of the associated client application.
    ClientId string
    The ID of the client (application) to associate with the organization.
    GrantTypes List<string>
    The grant types enabled for the associated client.
    IsFirstParty bool
    Whether the associated client is a first-party client (true) or not (false).
    LogoUri string
    The URI of the associated client's logo.
    Name string
    The name of the associated client.
    OrganizationId string
    The ID of the organization to associate the client (application) with.
    OrganizationUsage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    UseForMemberAccess bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    AppType string
    The type of the associated client application.
    ClientId string
    The ID of the client (application) to associate with the organization.
    GrantTypes []string
    The grant types enabled for the associated client.
    IsFirstParty bool
    Whether the associated client is a first-party client (true) or not (false).
    LogoUri string
    The URI of the associated client's logo.
    Name string
    The name of the associated client.
    OrganizationId string
    The ID of the organization to associate the client (application) with.
    OrganizationUsage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    UseForMemberAccess bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    app_type string
    The type of the associated client application.
    client_id string
    The ID of the client (application) to associate with the organization.
    grant_types list(string)
    The grant types enabled for the associated client.
    is_first_party bool
    Whether the associated client is a first-party client (true) or not (false).
    logo_uri string
    The URI of the associated client's logo.
    name string
    The name of the associated client.
    organization_id string
    The ID of the organization to associate the client (application) with.
    organization_usage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    use_for_member_access bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    appType String
    The type of the associated client application.
    clientId String
    The ID of the client (application) to associate with the organization.
    grantTypes List<String>
    The grant types enabled for the associated client.
    isFirstParty Boolean
    Whether the associated client is a first-party client (true) or not (false).
    logoUri String
    The URI of the associated client's logo.
    name String
    The name of the associated client.
    organizationId String
    The ID of the organization to associate the client (application) with.
    organizationUsage String
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    useForMemberAccess Boolean
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    appType string
    The type of the associated client application.
    clientId string
    The ID of the client (application) to associate with the organization.
    grantTypes string[]
    The grant types enabled for the associated client.
    isFirstParty boolean
    Whether the associated client is a first-party client (true) or not (false).
    logoUri string
    The URI of the associated client's logo.
    name string
    The name of the associated client.
    organizationId string
    The ID of the organization to associate the client (application) with.
    organizationUsage string
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    useForMemberAccess boolean
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    app_type str
    The type of the associated client application.
    client_id str
    The ID of the client (application) to associate with the organization.
    grant_types Sequence[str]
    The grant types enabled for the associated client.
    is_first_party bool
    Whether the associated client is a first-party client (true) or not (false).
    logo_uri str
    The URI of the associated client's logo.
    name str
    The name of the associated client.
    organization_id str
    The ID of the organization to associate the client (application) with.
    organization_usage str
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    use_for_member_access bool
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.
    appType String
    The type of the associated client application.
    clientId String
    The ID of the client (application) to associate with the organization.
    grantTypes List<String>
    The grant types enabled for the associated client.
    isFirstParty Boolean
    Whether the associated client is a first-party client (true) or not (false).
    logoUri String
    The URI of the associated client's logo.
    name String
    The name of the associated client.
    organizationId String
    The ID of the organization to associate the client (application) with.
    organizationUsage String
    How the associated client handles organizations during authentication. Available values are deny, allow or require. This is a read-only reflection of the client's own organizationUsage setting and is managed on the auth0.Client resource, not here.
    useForMemberAccess Boolean
    Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly.

    Import

    This resource can be imported by specifying the organization ID and client ID separated by “::” (note the double colon) ::

    Example:

    $ pulumi import auth0:index/organizationClient:OrganizationClient my_org_client "org_XXXXX::clientXXXXX"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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