published on Tuesday, Apr 28, 2026 by Pulumi
published on Tuesday, Apr 28, 2026 by Pulumi
With this resource, you can register an Auth0 client from a Client ID Metadata Document (CIMD) URL. CIMD enables tenant admins to onboard MCP agent clients by providing a URL to an externally-hosted metadata document instead of using Dynamic Client Registration.
Requires the clientIdMetadataDocumentSupported tenant setting to be enabled.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";
const minimalClient = new auth0.ClientCimd("minimal_client", {externalClientId: "https://mcp-agent1.example.com/oauth/metadata.json"});
const myMcpAgent = new auth0.ClientCimd("my_mcp_agent", {
externalClientId: "https://mcp-agent2.example.com/.well-known/client.json",
externalClientIdVersion: 1,
description: "MCP Agent - Production",
appType: "spa",
oidcConformant: true,
allowedOrigins: ["https://mcp-agent2.example.com"],
webOrigins: ["https://mcp-agent2.example.com"],
grantTypes: [
"authorization_code",
"refresh_token",
],
clientMetadata: {
environment: "production",
},
jwtConfiguration: {
lifetimeInSeconds: 300,
alg: "RS256",
},
refreshToken: {
rotationType: "rotating",
expirationType: "expiring",
tokenLifetime: 2592000,
idleTokenLifetime: 1296000,
infiniteTokenLifetime: false,
infiniteIdleTokenLifetime: false,
leeway: 0,
},
});
import pulumi
import pulumi_auth0 as auth0
minimal_client = auth0.ClientCimd("minimal_client", external_client_id="https://mcp-agent1.example.com/oauth/metadata.json")
my_mcp_agent = auth0.ClientCimd("my_mcp_agent",
external_client_id="https://mcp-agent2.example.com/.well-known/client.json",
external_client_id_version=1,
description="MCP Agent - Production",
app_type="spa",
oidc_conformant=True,
allowed_origins=["https://mcp-agent2.example.com"],
web_origins=["https://mcp-agent2.example.com"],
grant_types=[
"authorization_code",
"refresh_token",
],
client_metadata={
"environment": "production",
},
jwt_configuration={
"lifetime_in_seconds": 300,
"alg": "RS256",
},
refresh_token={
"rotation_type": "rotating",
"expiration_type": "expiring",
"token_lifetime": 2592000,
"idle_token_lifetime": 1296000,
"infinite_token_lifetime": False,
"infinite_idle_token_lifetime": False,
"leeway": 0,
})
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.NewClientCimd(ctx, "minimal_client", &auth0.ClientCimdArgs{
ExternalClientId: pulumi.String("https://mcp-agent1.example.com/oauth/metadata.json"),
})
if err != nil {
return err
}
_, err = auth0.NewClientCimd(ctx, "my_mcp_agent", &auth0.ClientCimdArgs{
ExternalClientId: pulumi.String("https://mcp-agent2.example.com/.well-known/client.json"),
ExternalClientIdVersion: pulumi.Int(1),
Description: pulumi.String("MCP Agent - Production"),
AppType: pulumi.String("spa"),
OidcConformant: pulumi.Bool(true),
AllowedOrigins: pulumi.StringArray{
pulumi.String("https://mcp-agent2.example.com"),
},
WebOrigins: pulumi.StringArray{
pulumi.String("https://mcp-agent2.example.com"),
},
GrantTypes: pulumi.StringArray{
pulumi.String("authorization_code"),
pulumi.String("refresh_token"),
},
ClientMetadata: pulumi.StringMap{
"environment": pulumi.String("production"),
},
JwtConfiguration: &auth0.ClientCimdJwtConfigurationArgs{
LifetimeInSeconds: pulumi.Int(300),
Alg: pulumi.String("RS256"),
},
RefreshToken: &auth0.ClientCimdRefreshTokenArgs{
RotationType: pulumi.String("rotating"),
ExpirationType: pulumi.String("expiring"),
TokenLifetime: pulumi.Int(2592000),
IdleTokenLifetime: pulumi.Int(1296000),
InfiniteTokenLifetime: pulumi.Bool(false),
InfiniteIdleTokenLifetime: pulumi.Bool(false),
Leeway: pulumi.Int(0),
},
})
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 minimalClient = new Auth0.Index.ClientCimd("minimal_client", new()
{
ExternalClientId = "https://mcp-agent1.example.com/oauth/metadata.json",
});
var myMcpAgent = new Auth0.Index.ClientCimd("my_mcp_agent", new()
{
ExternalClientId = "https://mcp-agent2.example.com/.well-known/client.json",
ExternalClientIdVersion = 1,
Description = "MCP Agent - Production",
AppType = "spa",
OidcConformant = true,
AllowedOrigins = new[]
{
"https://mcp-agent2.example.com",
},
WebOrigins = new[]
{
"https://mcp-agent2.example.com",
},
GrantTypes = new[]
{
"authorization_code",
"refresh_token",
},
ClientMetadata =
{
{ "environment", "production" },
},
JwtConfiguration = new Auth0.Inputs.ClientCimdJwtConfigurationArgs
{
LifetimeInSeconds = 300,
Alg = "RS256",
},
RefreshToken = new Auth0.Inputs.ClientCimdRefreshTokenArgs
{
RotationType = "rotating",
ExpirationType = "expiring",
TokenLifetime = 2592000,
IdleTokenLifetime = 1296000,
InfiniteTokenLifetime = false,
InfiniteIdleTokenLifetime = false,
Leeway = 0,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.ClientCimd;
import com.pulumi.auth0.ClientCimdArgs;
import com.pulumi.auth0.inputs.ClientCimdJwtConfigurationArgs;
import com.pulumi.auth0.inputs.ClientCimdRefreshTokenArgs;
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) {
var minimalClient = new ClientCimd("minimalClient", ClientCimdArgs.builder()
.externalClientId("https://mcp-agent1.example.com/oauth/metadata.json")
.build());
var myMcpAgent = new ClientCimd("myMcpAgent", ClientCimdArgs.builder()
.externalClientId("https://mcp-agent2.example.com/.well-known/client.json")
.externalClientIdVersion(1)
.description("MCP Agent - Production")
.appType("spa")
.oidcConformant(true)
.allowedOrigins("https://mcp-agent2.example.com")
.webOrigins("https://mcp-agent2.example.com")
.grantTypes(
"authorization_code",
"refresh_token")
.clientMetadata(Map.of("environment", "production"))
.jwtConfiguration(ClientCimdJwtConfigurationArgs.builder()
.lifetimeInSeconds(300)
.alg("RS256")
.build())
.refreshToken(ClientCimdRefreshTokenArgs.builder()
.rotationType("rotating")
.expirationType("expiring")
.tokenLifetime(2592000)
.idleTokenLifetime(1296000)
.infiniteTokenLifetime(false)
.infiniteIdleTokenLifetime(false)
.leeway(0)
.build())
.build());
}
}
resources:
minimalClient:
type: auth0:ClientCimd
name: minimal_client
properties:
externalClientId: https://mcp-agent1.example.com/oauth/metadata.json
myMcpAgent:
type: auth0:ClientCimd
name: my_mcp_agent
properties:
externalClientId: https://mcp-agent2.example.com/.well-known/client.json
externalClientIdVersion: 1
description: MCP Agent - Production
appType: spa
oidcConformant: true
allowedOrigins:
- https://mcp-agent2.example.com
webOrigins:
- https://mcp-agent2.example.com
grantTypes:
- authorization_code
- refresh_token
clientMetadata:
environment: production
jwtConfiguration:
lifetimeInSeconds: 300
alg: RS256
refreshToken:
rotationType: rotating
expirationType: expiring
tokenLifetime: 2.592e+06
idleTokenLifetime: 1.296e+06
infiniteTokenLifetime: false
infiniteIdleTokenLifetime: false
leeway: 0
Create ClientCimd Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientCimd(name: string, args: ClientCimdArgs, opts?: CustomResourceOptions);@overload
def ClientCimd(resource_name: str,
args: ClientCimdArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientCimd(resource_name: str,
opts: Optional[ResourceOptions] = None,
external_client_id: Optional[str] = None,
jwt_configuration: Optional[ClientCimdJwtConfigurationArgs] = None,
organization_discovery_methods: Optional[Sequence[str]] = None,
default_organization: Optional[ClientCimdDefaultOrganizationArgs] = None,
description: Optional[str] = None,
app_type: Optional[str] = None,
external_client_id_version: Optional[int] = None,
client_metadata: Optional[Mapping[str, str]] = None,
grant_types: Optional[Sequence[str]] = None,
oidc_conformant: Optional[bool] = None,
allowed_origins: Optional[Sequence[str]] = None,
redirection_policy: Optional[str] = None,
refresh_token: Optional[ClientCimdRefreshTokenArgs] = None,
require_proof_of_possession: Optional[bool] = None,
skip_non_verifiable_callback_uri_confirmation_prompt: Optional[bool] = None,
token_quota: Optional[ClientCimdTokenQuotaArgs] = None,
web_origins: Optional[Sequence[str]] = None)func NewClientCimd(ctx *Context, name string, args ClientCimdArgs, opts ...ResourceOption) (*ClientCimd, error)public ClientCimd(string name, ClientCimdArgs args, CustomResourceOptions? opts = null)
public ClientCimd(String name, ClientCimdArgs args)
public ClientCimd(String name, ClientCimdArgs args, CustomResourceOptions options)
type: auth0:ClientCimd
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClientCimdArgs
- 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 ClientCimdArgs
- 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 ClientCimdArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientCimdArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientCimdArgs
- 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 clientCimdResource = new Auth0.ClientCimd("clientCimdResource", new()
{
ExternalClientId = "string",
JwtConfiguration = new Auth0.Inputs.ClientCimdJwtConfigurationArgs
{
Alg = "string",
LifetimeInSeconds = 0,
SecretEncoded = false,
},
OrganizationDiscoveryMethods = new[]
{
"string",
},
DefaultOrganization = new Auth0.Inputs.ClientCimdDefaultOrganizationArgs
{
Flows = new[]
{
"string",
},
OrganizationId = "string",
},
Description = "string",
AppType = "string",
ExternalClientIdVersion = 0,
ClientMetadata =
{
{ "string", "string" },
},
GrantTypes = new[]
{
"string",
},
OidcConformant = false,
AllowedOrigins = new[]
{
"string",
},
RedirectionPolicy = "string",
RefreshToken = new Auth0.Inputs.ClientCimdRefreshTokenArgs
{
ExpirationType = "string",
IdleTokenLifetime = 0,
InfiniteIdleTokenLifetime = false,
InfiniteTokenLifetime = false,
Leeway = 0,
RotationType = "string",
TokenLifetime = 0,
},
RequireProofOfPossession = false,
SkipNonVerifiableCallbackUriConfirmationPrompt = false,
TokenQuota = new Auth0.Inputs.ClientCimdTokenQuotaArgs
{
ClientCredentials = new Auth0.Inputs.ClientCimdTokenQuotaClientCredentialsArgs
{
Enforce = false,
PerDay = 0,
PerHour = 0,
},
},
WebOrigins = new[]
{
"string",
},
});
example, err := auth0.NewClientCimd(ctx, "clientCimdResource", &auth0.ClientCimdArgs{
ExternalClientId: pulumi.String("string"),
JwtConfiguration: &auth0.ClientCimdJwtConfigurationArgs{
Alg: pulumi.String("string"),
LifetimeInSeconds: pulumi.Int(0),
SecretEncoded: pulumi.Bool(false),
},
OrganizationDiscoveryMethods: pulumi.StringArray{
pulumi.String("string"),
},
DefaultOrganization: &auth0.ClientCimdDefaultOrganizationArgs{
Flows: pulumi.StringArray{
pulumi.String("string"),
},
OrganizationId: pulumi.String("string"),
},
Description: pulumi.String("string"),
AppType: pulumi.String("string"),
ExternalClientIdVersion: pulumi.Int(0),
ClientMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
GrantTypes: pulumi.StringArray{
pulumi.String("string"),
},
OidcConformant: pulumi.Bool(false),
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
RedirectionPolicy: pulumi.String("string"),
RefreshToken: &auth0.ClientCimdRefreshTokenArgs{
ExpirationType: pulumi.String("string"),
IdleTokenLifetime: pulumi.Int(0),
InfiniteIdleTokenLifetime: pulumi.Bool(false),
InfiniteTokenLifetime: pulumi.Bool(false),
Leeway: pulumi.Int(0),
RotationType: pulumi.String("string"),
TokenLifetime: pulumi.Int(0),
},
RequireProofOfPossession: pulumi.Bool(false),
SkipNonVerifiableCallbackUriConfirmationPrompt: pulumi.Bool(false),
TokenQuota: &auth0.ClientCimdTokenQuotaArgs{
ClientCredentials: &auth0.ClientCimdTokenQuotaClientCredentialsArgs{
Enforce: pulumi.Bool(false),
PerDay: pulumi.Int(0),
PerHour: pulumi.Int(0),
},
},
WebOrigins: pulumi.StringArray{
pulumi.String("string"),
},
})
var clientCimdResource = new ClientCimd("clientCimdResource", ClientCimdArgs.builder()
.externalClientId("string")
.jwtConfiguration(ClientCimdJwtConfigurationArgs.builder()
.alg("string")
.lifetimeInSeconds(0)
.secretEncoded(false)
.build())
.organizationDiscoveryMethods("string")
.defaultOrganization(ClientCimdDefaultOrganizationArgs.builder()
.flows("string")
.organizationId("string")
.build())
.description("string")
.appType("string")
.externalClientIdVersion(0)
.clientMetadata(Map.of("string", "string"))
.grantTypes("string")
.oidcConformant(false)
.allowedOrigins("string")
.redirectionPolicy("string")
.refreshToken(ClientCimdRefreshTokenArgs.builder()
.expirationType("string")
.idleTokenLifetime(0)
.infiniteIdleTokenLifetime(false)
.infiniteTokenLifetime(false)
.leeway(0)
.rotationType("string")
.tokenLifetime(0)
.build())
.requireProofOfPossession(false)
.skipNonVerifiableCallbackUriConfirmationPrompt(false)
.tokenQuota(ClientCimdTokenQuotaArgs.builder()
.clientCredentials(ClientCimdTokenQuotaClientCredentialsArgs.builder()
.enforce(false)
.perDay(0)
.perHour(0)
.build())
.build())
.webOrigins("string")
.build());
client_cimd_resource = auth0.ClientCimd("clientCimdResource",
external_client_id="string",
jwt_configuration={
"alg": "string",
"lifetime_in_seconds": 0,
"secret_encoded": False,
},
organization_discovery_methods=["string"],
default_organization={
"flows": ["string"],
"organization_id": "string",
},
description="string",
app_type="string",
external_client_id_version=0,
client_metadata={
"string": "string",
},
grant_types=["string"],
oidc_conformant=False,
allowed_origins=["string"],
redirection_policy="string",
refresh_token={
"expiration_type": "string",
"idle_token_lifetime": 0,
"infinite_idle_token_lifetime": False,
"infinite_token_lifetime": False,
"leeway": 0,
"rotation_type": "string",
"token_lifetime": 0,
},
require_proof_of_possession=False,
skip_non_verifiable_callback_uri_confirmation_prompt=False,
token_quota={
"client_credentials": {
"enforce": False,
"per_day": 0,
"per_hour": 0,
},
},
web_origins=["string"])
const clientCimdResource = new auth0.ClientCimd("clientCimdResource", {
externalClientId: "string",
jwtConfiguration: {
alg: "string",
lifetimeInSeconds: 0,
secretEncoded: false,
},
organizationDiscoveryMethods: ["string"],
defaultOrganization: {
flows: ["string"],
organizationId: "string",
},
description: "string",
appType: "string",
externalClientIdVersion: 0,
clientMetadata: {
string: "string",
},
grantTypes: ["string"],
oidcConformant: false,
allowedOrigins: ["string"],
redirectionPolicy: "string",
refreshToken: {
expirationType: "string",
idleTokenLifetime: 0,
infiniteIdleTokenLifetime: false,
infiniteTokenLifetime: false,
leeway: 0,
rotationType: "string",
tokenLifetime: 0,
},
requireProofOfPossession: false,
skipNonVerifiableCallbackUriConfirmationPrompt: false,
tokenQuota: {
clientCredentials: {
enforce: false,
perDay: 0,
perHour: 0,
},
},
webOrigins: ["string"],
});
type: auth0:ClientCimd
properties:
allowedOrigins:
- string
appType: string
clientMetadata:
string: string
defaultOrganization:
flows:
- string
organizationId: string
description: string
externalClientId: string
externalClientIdVersion: 0
grantTypes:
- string
jwtConfiguration:
alg: string
lifetimeInSeconds: 0
secretEncoded: false
oidcConformant: false
organizationDiscoveryMethods:
- string
redirectionPolicy: string
refreshToken:
expirationType: string
idleTokenLifetime: 0
infiniteIdleTokenLifetime: false
infiniteTokenLifetime: false
leeway: 0
rotationType: string
tokenLifetime: 0
requireProofOfPossession: false
skipNonVerifiableCallbackUriConfirmationPrompt: false
tokenQuota:
clientCredentials:
enforce: false
perDay: 0
perHour: 0
webOrigins:
- string
ClientCimd 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 ClientCimd resource accepts the following input properties:
- External
Client stringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - Allowed
Origins List<string> - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- App
Type string - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - Client
Metadata Dictionary<string, string> - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - Default
Organization ClientCimd Default Organization - Configure and associate an organization with the Client
- Description string
- Description of the purpose of the client.
- External
Client intId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- Grant
Types List<string> - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - Jwt
Configuration ClientCimd Jwt Configuration - Configuration settings for the JWTs issued for this client.
- Oidc
Conformant bool - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - Organization
Discovery List<string>Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - Redirection
Policy string - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- Refresh
Token ClientCimd Refresh Token - Configuration settings for the refresh tokens issued for this client.
- Require
Proof boolOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- Skip
Non boolVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- Token
Quota ClientCimd Token Quota - The token quota configuration.
- Web
Origins List<string> - URLs that represent valid web origins for use with web message response mode.
- External
Client stringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - Allowed
Origins []string - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- App
Type string - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - Client
Metadata map[string]string - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - Default
Organization ClientCimd Default Organization Args - Configure and associate an organization with the Client
- Description string
- Description of the purpose of the client.
- External
Client intId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- Grant
Types []string - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - Jwt
Configuration ClientCimd Jwt Configuration Args - Configuration settings for the JWTs issued for this client.
- Oidc
Conformant bool - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - Organization
Discovery []stringMethods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - Redirection
Policy string - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- Refresh
Token ClientCimd Refresh Token Args - Configuration settings for the refresh tokens issued for this client.
- Require
Proof boolOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- Skip
Non boolVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- Token
Quota ClientCimd Token Quota Args - The token quota configuration.
- Web
Origins []string - URLs that represent valid web origins for use with web message response mode.
- external
Client StringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - allowed
Origins List<String> - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app
Type String - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - client
Metadata Map<String,String> - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default
Organization ClientCimd Default Organization - Configure and associate an organization with the Client
- description String
- Description of the purpose of the client.
- external
Client IntegerId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- grant
Types List<String> - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - jwt
Configuration ClientCimd Jwt Configuration - Configuration settings for the JWTs issued for this client.
- oidc
Conformant Boolean - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization
Discovery List<String>Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection
Policy String - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh
Token ClientCimd Refresh Token - Configuration settings for the refresh tokens issued for this client.
- require
Proof BooleanOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- skip
Non BooleanVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- token
Quota ClientCimd Token Quota - The token quota configuration.
- web
Origins List<String> - URLs that represent valid web origins for use with web message response mode.
- external
Client stringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - allowed
Origins string[] - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app
Type string - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - client
Metadata {[key: string]: string} - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default
Organization ClientCimd Default Organization - Configure and associate an organization with the Client
- description string
- Description of the purpose of the client.
- external
Client numberId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- grant
Types string[] - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - jwt
Configuration ClientCimd Jwt Configuration - Configuration settings for the JWTs issued for this client.
- oidc
Conformant boolean - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization
Discovery string[]Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection
Policy string - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh
Token ClientCimd Refresh Token - Configuration settings for the refresh tokens issued for this client.
- require
Proof booleanOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- skip
Non booleanVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- token
Quota ClientCimd Token Quota - The token quota configuration.
- web
Origins string[] - URLs that represent valid web origins for use with web message response mode.
- external_
client_ strid - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - allowed_
origins Sequence[str] - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app_
type str - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - client_
metadata Mapping[str, str] - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default_
organization ClientCimd Default Organization Args - Configure and associate an organization with the Client
- description str
- Description of the purpose of the client.
- external_
client_ intid_ version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- grant_
types Sequence[str] - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - jwt_
configuration ClientCimd Jwt Configuration Args - Configuration settings for the JWTs issued for this client.
- oidc_
conformant bool - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization_
discovery_ Sequence[str]methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection_
policy str - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh_
token ClientCimd Refresh Token Args - Configuration settings for the refresh tokens issued for this client.
- require_
proof_ boolof_ possession - Makes the use of Proof-of-Possession mandatory for this client.
- skip_
non_ boolverifiable_ callback_ uri_ confirmation_ prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- token_
quota ClientCimd Token Quota Args - The token quota configuration.
- web_
origins Sequence[str] - URLs that represent valid web origins for use with web message response mode.
- external
Client StringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - allowed
Origins List<String> - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app
Type String - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - client
Metadata Map<String> - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default
Organization Property Map - Configure and associate an organization with the Client
- description String
- Description of the purpose of the client.
- external
Client NumberId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- grant
Types List<String> - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - jwt
Configuration Property Map - Configuration settings for the JWTs issued for this client.
- oidc
Conformant Boolean - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization
Discovery List<String>Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection
Policy String - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh
Token Property Map - Configuration settings for the refresh tokens issued for this client.
- require
Proof BooleanOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- skip
Non BooleanVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- token
Quota Property Map - The token quota configuration.
- web
Origins List<String> - URLs that represent valid web origins for use with web message response mode.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientCimd resource produces the following output properties:
- Callbacks List<string>
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- Client
Id string - The ID of the client.
- External
Metadata stringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - External
Metadata stringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - Id string
- The provider-assigned unique ID for this managed resource.
- Is
First boolParty - Whether this is a first-party client. Always
falsefor CIMD clients. - Jwks
Uri string - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - Logo
Uri string - URL of the logo for this client, derived from the CIMD metadata document.
- Name string
- Name of the client, derived from the CIMD metadata document.
- Signing
Keys List<ImmutableDictionary<string, string>> - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- Third
Party stringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - Validations
List<Client
Cimd Validation> - Validation result of the CIMD metadata document.
- Callbacks []string
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- Client
Id string - The ID of the client.
- External
Metadata stringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - External
Metadata stringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - Id string
- The provider-assigned unique ID for this managed resource.
- Is
First boolParty - Whether this is a first-party client. Always
falsefor CIMD clients. - Jwks
Uri string - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - Logo
Uri string - URL of the logo for this client, derived from the CIMD metadata document.
- Name string
- Name of the client, derived from the CIMD metadata document.
- Signing
Keys []map[string]string - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- Third
Party stringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - Validations
[]Client
Cimd Validation - Validation result of the CIMD metadata document.
- callbacks List<String>
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client
Id String - The ID of the client.
- external
Metadata StringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external
Metadata StringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - id String
- The provider-assigned unique ID for this managed resource.
- is
First BooleanParty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks
Uri String - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - logo
Uri String - URL of the logo for this client, derived from the CIMD metadata document.
- name String
- Name of the client, derived from the CIMD metadata document.
- signing
Keys List<Map<String,String>> - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- third
Party StringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - validations
List<Client
Cimd Validation> - Validation result of the CIMD metadata document.
- callbacks string[]
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client
Id string - The ID of the client.
- external
Metadata stringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external
Metadata stringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - id string
- The provider-assigned unique ID for this managed resource.
- is
First booleanParty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks
Uri string - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - logo
Uri string - URL of the logo for this client, derived from the CIMD metadata document.
- name string
- Name of the client, derived from the CIMD metadata document.
- signing
Keys {[key: string]: string}[] - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- third
Party stringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - validations
Client
Cimd Validation[] - Validation result of the CIMD metadata document.
- callbacks Sequence[str]
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client_
id str - The ID of the client.
- external_
metadata_ strcreated_ by - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external_
metadata_ strtype - Type of external metadata. Always
cimdfor CIMD-registered clients. - id str
- The provider-assigned unique ID for this managed resource.
- is_
first_ boolparty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks_
uri str - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - logo_
uri str - URL of the logo for this client, derived from the CIMD metadata document.
- name str
- Name of the client, derived from the CIMD metadata document.
- signing_
keys Sequence[Mapping[str, str]] - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- third_
party_ strsecurity_ mode - Security mode for third-party clients.
strictenforces enhanced security controls - validations
Sequence[Client
Cimd Validation] - Validation result of the CIMD metadata document.
- callbacks List<String>
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client
Id String - The ID of the client.
- external
Metadata StringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external
Metadata StringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - id String
- The provider-assigned unique ID for this managed resource.
- is
First BooleanParty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks
Uri String - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - logo
Uri String - URL of the logo for this client, derived from the CIMD metadata document.
- name String
- Name of the client, derived from the CIMD metadata document.
- signing
Keys List<Map<String>> - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- third
Party StringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - validations List<Property Map>
- Validation result of the CIMD metadata document.
Look up Existing ClientCimd Resource
Get an existing ClientCimd 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?: ClientCimdState, opts?: CustomResourceOptions): ClientCimd@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allowed_origins: Optional[Sequence[str]] = None,
app_type: Optional[str] = None,
callbacks: Optional[Sequence[str]] = None,
client_id: Optional[str] = None,
client_metadata: Optional[Mapping[str, str]] = None,
default_organization: Optional[ClientCimdDefaultOrganizationArgs] = None,
description: Optional[str] = None,
external_client_id: Optional[str] = None,
external_client_id_version: Optional[int] = None,
external_metadata_created_by: Optional[str] = None,
external_metadata_type: Optional[str] = None,
grant_types: Optional[Sequence[str]] = None,
is_first_party: Optional[bool] = None,
jwks_uri: Optional[str] = None,
jwt_configuration: Optional[ClientCimdJwtConfigurationArgs] = None,
logo_uri: Optional[str] = None,
name: Optional[str] = None,
oidc_conformant: Optional[bool] = None,
organization_discovery_methods: Optional[Sequence[str]] = None,
redirection_policy: Optional[str] = None,
refresh_token: Optional[ClientCimdRefreshTokenArgs] = None,
require_proof_of_possession: Optional[bool] = None,
signing_keys: Optional[Sequence[Mapping[str, str]]] = None,
skip_non_verifiable_callback_uri_confirmation_prompt: Optional[bool] = None,
third_party_security_mode: Optional[str] = None,
token_quota: Optional[ClientCimdTokenQuotaArgs] = None,
validations: Optional[Sequence[ClientCimdValidationArgs]] = None,
web_origins: Optional[Sequence[str]] = None) -> ClientCimdfunc GetClientCimd(ctx *Context, name string, id IDInput, state *ClientCimdState, opts ...ResourceOption) (*ClientCimd, error)public static ClientCimd Get(string name, Input<string> id, ClientCimdState? state, CustomResourceOptions? opts = null)public static ClientCimd get(String name, Output<String> id, ClientCimdState state, CustomResourceOptions options)resources: _: type: auth0:ClientCimd get: 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.
- Allowed
Origins List<string> - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- App
Type string - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - Callbacks List<string>
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- Client
Id string - The ID of the client.
- Client
Metadata Dictionary<string, string> - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - Default
Organization ClientCimd Default Organization - Configure and associate an organization with the Client
- Description string
- Description of the purpose of the client.
- External
Client stringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - External
Client intId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- External
Metadata stringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - External
Metadata stringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - Grant
Types List<string> - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - Is
First boolParty - Whether this is a first-party client. Always
falsefor CIMD clients. - Jwks
Uri string - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - Jwt
Configuration ClientCimd Jwt Configuration - Configuration settings for the JWTs issued for this client.
- Logo
Uri string - URL of the logo for this client, derived from the CIMD metadata document.
- Name string
- Name of the client, derived from the CIMD metadata document.
- Oidc
Conformant bool - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - Organization
Discovery List<string>Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - Redirection
Policy string - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- Refresh
Token ClientCimd Refresh Token - Configuration settings for the refresh tokens issued for this client.
- Require
Proof boolOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- Signing
Keys List<ImmutableDictionary<string, string>> - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- Skip
Non boolVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- Third
Party stringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - Token
Quota ClientCimd Token Quota - The token quota configuration.
- Validations
List<Client
Cimd Validation> - Validation result of the CIMD metadata document.
- Web
Origins List<string> - URLs that represent valid web origins for use with web message response mode.
- Allowed
Origins []string - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- App
Type string - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - Callbacks []string
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- Client
Id string - The ID of the client.
- Client
Metadata map[string]string - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - Default
Organization ClientCimd Default Organization Args - Configure and associate an organization with the Client
- Description string
- Description of the purpose of the client.
- External
Client stringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - External
Client intId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- External
Metadata stringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - External
Metadata stringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - Grant
Types []string - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - Is
First boolParty - Whether this is a first-party client. Always
falsefor CIMD clients. - Jwks
Uri string - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - Jwt
Configuration ClientCimd Jwt Configuration Args - Configuration settings for the JWTs issued for this client.
- Logo
Uri string - URL of the logo for this client, derived from the CIMD metadata document.
- Name string
- Name of the client, derived from the CIMD metadata document.
- Oidc
Conformant bool - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - Organization
Discovery []stringMethods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - Redirection
Policy string - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- Refresh
Token ClientCimd Refresh Token Args - Configuration settings for the refresh tokens issued for this client.
- Require
Proof boolOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- Signing
Keys []map[string]string - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- Skip
Non boolVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- Third
Party stringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - Token
Quota ClientCimd Token Quota Args - The token quota configuration.
- Validations
[]Client
Cimd Validation Args - Validation result of the CIMD metadata document.
- Web
Origins []string - URLs that represent valid web origins for use with web message response mode.
- allowed
Origins List<String> - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app
Type String - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - callbacks List<String>
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client
Id String - The ID of the client.
- client
Metadata Map<String,String> - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default
Organization ClientCimd Default Organization - Configure and associate an organization with the Client
- description String
- Description of the purpose of the client.
- external
Client StringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - external
Client IntegerId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- external
Metadata StringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external
Metadata StringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - grant
Types List<String> - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - is
First BooleanParty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks
Uri String - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - jwt
Configuration ClientCimd Jwt Configuration - Configuration settings for the JWTs issued for this client.
- logo
Uri String - URL of the logo for this client, derived from the CIMD metadata document.
- name String
- Name of the client, derived from the CIMD metadata document.
- oidc
Conformant Boolean - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization
Discovery List<String>Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection
Policy String - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh
Token ClientCimd Refresh Token - Configuration settings for the refresh tokens issued for this client.
- require
Proof BooleanOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- signing
Keys List<Map<String,String>> - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- skip
Non BooleanVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- third
Party StringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - token
Quota ClientCimd Token Quota - The token quota configuration.
- validations
List<Client
Cimd Validation> - Validation result of the CIMD metadata document.
- web
Origins List<String> - URLs that represent valid web origins for use with web message response mode.
- allowed
Origins string[] - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app
Type string - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - callbacks string[]
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client
Id string - The ID of the client.
- client
Metadata {[key: string]: string} - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default
Organization ClientCimd Default Organization - Configure and associate an organization with the Client
- description string
- Description of the purpose of the client.
- external
Client stringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - external
Client numberId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- external
Metadata stringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external
Metadata stringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - grant
Types string[] - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - is
First booleanParty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks
Uri string - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - jwt
Configuration ClientCimd Jwt Configuration - Configuration settings for the JWTs issued for this client.
- logo
Uri string - URL of the logo for this client, derived from the CIMD metadata document.
- name string
- Name of the client, derived from the CIMD metadata document.
- oidc
Conformant boolean - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization
Discovery string[]Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection
Policy string - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh
Token ClientCimd Refresh Token - Configuration settings for the refresh tokens issued for this client.
- require
Proof booleanOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- signing
Keys {[key: string]: string}[] - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- skip
Non booleanVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- third
Party stringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - token
Quota ClientCimd Token Quota - The token quota configuration.
- validations
Client
Cimd Validation[] - Validation result of the CIMD metadata document.
- web
Origins string[] - URLs that represent valid web origins for use with web message response mode.
- allowed_
origins Sequence[str] - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app_
type str - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - callbacks Sequence[str]
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client_
id str - The ID of the client.
- client_
metadata Mapping[str, str] - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default_
organization ClientCimd Default Organization Args - Configure and associate an organization with the Client
- description str
- Description of the purpose of the client.
- external_
client_ strid - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - external_
client_ intid_ version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- external_
metadata_ strcreated_ by - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external_
metadata_ strtype - Type of external metadata. Always
cimdfor CIMD-registered clients. - grant_
types Sequence[str] - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - is_
first_ boolparty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks_
uri str - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - jwt_
configuration ClientCimd Jwt Configuration Args - Configuration settings for the JWTs issued for this client.
- logo_
uri str - URL of the logo for this client, derived from the CIMD metadata document.
- name str
- Name of the client, derived from the CIMD metadata document.
- oidc_
conformant bool - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization_
discovery_ Sequence[str]methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection_
policy str - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh_
token ClientCimd Refresh Token Args - Configuration settings for the refresh tokens issued for this client.
- require_
proof_ boolof_ possession - Makes the use of Proof-of-Possession mandatory for this client.
- signing_
keys Sequence[Mapping[str, str]] - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- skip_
non_ boolverifiable_ callback_ uri_ confirmation_ prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- third_
party_ strsecurity_ mode - Security mode for third-party clients.
strictenforces enhanced security controls - token_
quota ClientCimd Token Quota Args - The token quota configuration.
- validations
Sequence[Client
Cimd Validation Args] - Validation result of the CIMD metadata document.
- web_
origins Sequence[str] - URLs that represent valid web origins for use with web message response mode.
- allowed
Origins List<String> - URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.
- app
Type String - Type of application the client represents. CIMD clients only support
native,spa, andregularWeb. - callbacks List<String>
- URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document.
- client
Id String - The ID of the client.
- client
Metadata Map<String> - Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters:
:,-+=_*?"/\()<>@ [Tab] [Space]. - default
Organization Property Map - Configure and associate an organization with the Client
- description String
- Description of the purpose of the client.
- external
Client StringId - The HTTPS URL of the Client ID Metadata Document. Must include a path component (e.g.
https://app.example.com/client.json). This value is immutable after creation. - external
Client NumberId Version - Version number for externalclientid metadata document changes. Update this value to sync the client with the latest values of the json metadata document.
- external
Metadata StringCreated By - Who created the external metadata client:
admin(via Management API) orclient(self-registered). - external
Metadata StringType - Type of external metadata. Always
cimdfor CIMD-registered clients. - grant
Types List<String> - Types of grants that this client is authorized to use. CIMD clients support
authorizationCodeandrefreshToken. - is
First BooleanParty - Whether this is a first-party client. Always
falsefor CIMD clients. - jwks
Uri String - URL for the JSON Web Key Set (JWKS) containing the public keys used for
privateKeyJwtauthentication. - jwt
Configuration Property Map - Configuration settings for the JWTs issued for this client.
- logo
Uri String - URL of the logo for this client, derived from the CIMD metadata document.
- name String
- Name of the client, derived from the CIMD metadata document.
- oidc
Conformant Boolean - Whether this client conforms to strict OIDC specifications. Must be
truefor CIMD clients. - organization
Discovery List<String>Methods - Methods for discovering organizations during the preloginprompt. Can include
email(allows users to find their organization by entering their email address) and/ororganizationName(requires users to enter the organization name directly). These methods can be combined. Setting this property requires thatorganizationRequireBehavioris set topreLoginPrompt. - redirection
Policy String - Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.
- refresh
Token Property Map - Configuration settings for the refresh tokens issued for this client.
- require
Proof BooleanOf Possession - Makes the use of Proof-of-Possession mandatory for this client.
- signing
Keys List<Map<String>> - List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.
- skip
Non BooleanVerifiable Callback Uri Confirmation Prompt - Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it.
- third
Party StringSecurity Mode - Security mode for third-party clients.
strictenforces enhanced security controls - token
Quota Property Map - The token quota configuration.
- validations List<Property Map>
- Validation result of the CIMD metadata document.
- web
Origins List<String> - URLs that represent valid web origins for use with web message response mode.
Supporting Types
ClientCimdDefaultOrganization, ClientCimdDefaultOrganizationArgs
- Flows List<string>
- Definition of the flow that needs to be configured. Eg. client_credentials
- Organization
Id string - The unique identifier of the organization
- Flows []string
- Definition of the flow that needs to be configured. Eg. client_credentials
- Organization
Id string - The unique identifier of the organization
- flows List<String>
- Definition of the flow that needs to be configured. Eg. client_credentials
- organization
Id String - The unique identifier of the organization
- flows string[]
- Definition of the flow that needs to be configured. Eg. client_credentials
- organization
Id string - The unique identifier of the organization
- flows Sequence[str]
- Definition of the flow that needs to be configured. Eg. client_credentials
- organization_
id str - The unique identifier of the organization
- flows List<String>
- Definition of the flow that needs to be configured. Eg. client_credentials
- organization
Id String - The unique identifier of the organization
ClientCimdJwtConfiguration, ClientCimdJwtConfigurationArgs
- Alg string
- Algorithm used to sign JWTs. CIMD clients support
RS256,RS512, andPS256(asymmetric only). - Lifetime
In intSeconds - Number of seconds during which the JWT will be valid.
- Secret
Encoded bool - Indicates whether the client secret is Base64-encoded.
- Alg string
- Algorithm used to sign JWTs. CIMD clients support
RS256,RS512, andPS256(asymmetric only). - Lifetime
In intSeconds - Number of seconds during which the JWT will be valid.
- Secret
Encoded bool - Indicates whether the client secret is Base64-encoded.
- alg String
- Algorithm used to sign JWTs. CIMD clients support
RS256,RS512, andPS256(asymmetric only). - lifetime
In IntegerSeconds - Number of seconds during which the JWT will be valid.
- secret
Encoded Boolean - Indicates whether the client secret is Base64-encoded.
- alg string
- Algorithm used to sign JWTs. CIMD clients support
RS256,RS512, andPS256(asymmetric only). - lifetime
In numberSeconds - Number of seconds during which the JWT will be valid.
- secret
Encoded boolean - Indicates whether the client secret is Base64-encoded.
- alg str
- Algorithm used to sign JWTs. CIMD clients support
RS256,RS512, andPS256(asymmetric only). - lifetime_
in_ intseconds - Number of seconds during which the JWT will be valid.
- secret_
encoded bool - Indicates whether the client secret is Base64-encoded.
- alg String
- Algorithm used to sign JWTs. CIMD clients support
RS256,RS512, andPS256(asymmetric only). - lifetime
In NumberSeconds - Number of seconds during which the JWT will be valid.
- secret
Encoded Boolean - Indicates whether the client secret is Base64-encoded.
ClientCimdRefreshToken, ClientCimdRefreshTokenArgs
- Expiration
Type string - Refresh token expiration type. Must be
expiringfor CIMD clients. - Idle
Token intLifetime - The time in seconds after which inactive refresh tokens will expire.
- Infinite
Idle boolToken Lifetime - Whether inactive refresh tokens should remain valid indefinitely. Must be
falsefor CIMD clients. - Infinite
Token boolLifetime - Whether refresh tokens should remain valid indefinitely. If false,
tokenLifetimeshould also be set. - Leeway int
- The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
- Rotation
Type string - Refresh token rotation type.Valid values are
rotatingandnon-rotating - Token
Lifetime int - The absolute lifetime of a refresh token in seconds.
- Expiration
Type string - Refresh token expiration type. Must be
expiringfor CIMD clients. - Idle
Token intLifetime - The time in seconds after which inactive refresh tokens will expire.
- Infinite
Idle boolToken Lifetime - Whether inactive refresh tokens should remain valid indefinitely. Must be
falsefor CIMD clients. - Infinite
Token boolLifetime - Whether refresh tokens should remain valid indefinitely. If false,
tokenLifetimeshould also be set. - Leeway int
- The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
- Rotation
Type string - Refresh token rotation type.Valid values are
rotatingandnon-rotating - Token
Lifetime int - The absolute lifetime of a refresh token in seconds.
- expiration
Type String - Refresh token expiration type. Must be
expiringfor CIMD clients. - idle
Token IntegerLifetime - The time in seconds after which inactive refresh tokens will expire.
- infinite
Idle BooleanToken Lifetime - Whether inactive refresh tokens should remain valid indefinitely. Must be
falsefor CIMD clients. - infinite
Token BooleanLifetime - Whether refresh tokens should remain valid indefinitely. If false,
tokenLifetimeshould also be set. - leeway Integer
- The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
- rotation
Type String - Refresh token rotation type.Valid values are
rotatingandnon-rotating - token
Lifetime Integer - The absolute lifetime of a refresh token in seconds.
- expiration
Type string - Refresh token expiration type. Must be
expiringfor CIMD clients. - idle
Token numberLifetime - The time in seconds after which inactive refresh tokens will expire.
- infinite
Idle booleanToken Lifetime - Whether inactive refresh tokens should remain valid indefinitely. Must be
falsefor CIMD clients. - infinite
Token booleanLifetime - Whether refresh tokens should remain valid indefinitely. If false,
tokenLifetimeshould also be set. - leeway number
- The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
- rotation
Type string - Refresh token rotation type.Valid values are
rotatingandnon-rotating - token
Lifetime number - The absolute lifetime of a refresh token in seconds.
- expiration_
type str - Refresh token expiration type. Must be
expiringfor CIMD clients. - idle_
token_ intlifetime - The time in seconds after which inactive refresh tokens will expire.
- infinite_
idle_ booltoken_ lifetime - Whether inactive refresh tokens should remain valid indefinitely. Must be
falsefor CIMD clients. - infinite_
token_ boollifetime - Whether refresh tokens should remain valid indefinitely. If false,
tokenLifetimeshould also be set. - leeway int
- The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
- rotation_
type str - Refresh token rotation type.Valid values are
rotatingandnon-rotating - token_
lifetime int - The absolute lifetime of a refresh token in seconds.
- expiration
Type String - Refresh token expiration type. Must be
expiringfor CIMD clients. - idle
Token NumberLifetime - The time in seconds after which inactive refresh tokens will expire.
- infinite
Idle BooleanToken Lifetime - Whether inactive refresh tokens should remain valid indefinitely. Must be
falsefor CIMD clients. - infinite
Token BooleanLifetime - Whether refresh tokens should remain valid indefinitely. If false,
tokenLifetimeshould also be set. - leeway Number
- The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
- rotation
Type String - Refresh token rotation type.Valid values are
rotatingandnon-rotating - token
Lifetime Number - The absolute lifetime of a refresh token in seconds.
ClientCimdTokenQuota, ClientCimdTokenQuotaArgs
- Client
Credentials ClientCimd Token Quota Client Credentials - The token quota configuration for client credentials.
- Client
Credentials ClientCimd Token Quota Client Credentials - The token quota configuration for client credentials.
- client
Credentials ClientCimd Token Quota Client Credentials - The token quota configuration for client credentials.
- client
Credentials ClientCimd Token Quota Client Credentials - The token quota configuration for client credentials.
- client_
credentials ClientCimd Token Quota Client Credentials - The token quota configuration for client credentials.
- client
Credentials Property Map - The token quota configuration for client credentials.
ClientCimdTokenQuotaClientCredentials, ClientCimdTokenQuotaClientCredentialsArgs
- Enforce bool
- If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
- Per
Day int - Maximum number of issued tokens per day
- Per
Hour int - Maximum number of issued tokens per hour
- Enforce bool
- If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
- Per
Day int - Maximum number of issued tokens per day
- Per
Hour int - Maximum number of issued tokens per hour
- enforce Boolean
- If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
- per
Day Integer - Maximum number of issued tokens per day
- per
Hour Integer - Maximum number of issued tokens per hour
- enforce boolean
- If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
- per
Day number - Maximum number of issued tokens per day
- per
Hour number - Maximum number of issued tokens per hour
- enforce bool
- If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
- per_
day int - Maximum number of issued tokens per day
- per_
hour int - Maximum number of issued tokens per hour
- enforce Boolean
- If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
- per
Day Number - Maximum number of issued tokens per day
- per
Hour Number - Maximum number of issued tokens per hour
ClientCimdValidation, ClientCimdValidationArgs
- Valid bool
- Whether the metadata document passed validation.
- Violations List<string>
- Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed.
- Warnings List<string>
- Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored.
- Valid bool
- Whether the metadata document passed validation.
- Violations []string
- Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed.
- Warnings []string
- Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored.
- valid Boolean
- Whether the metadata document passed validation.
- violations List<String>
- Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed.
- warnings List<String>
- Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored.
- valid boolean
- Whether the metadata document passed validation.
- violations string[]
- Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed.
- warnings string[]
- Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored.
- valid bool
- Whether the metadata document passed validation.
- violations Sequence[str]
- Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed.
- warnings Sequence[str]
- Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored.
- valid Boolean
- Whether the metadata document passed validation.
- violations List<String>
- Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed.
- warnings List<String>
- Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored.
Import
This resource can be imported by specifying the client ID. Generally CIMD clients have a “tpc_” prefix in their client ID.
Example:
$ pulumi import auth0:index/clientCimd:ClientCimd my_mcp_agent "tpc_5FPpaVyZGSNRCBzTb2zURZ"
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
auth0Terraform Provider.
published on Tuesday, Apr 28, 2026 by Pulumi
