import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * 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 * * ```typescript * 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", { * jwtConfiguration: { * lifetimeInSeconds: 300, * alg: "RS256", * }, * refreshToken: { * rotationType: "rotating", * expirationType: "expiring", * tokenLifetime: 2592000, * idleTokenLifetime: 1296000, * infiniteTokenLifetime: false, * infiniteIdleTokenLifetime: false, * leeway: 0, * }, * 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", * ], * organizationUsage: "require", * organizationRequireBehavior: "post_login_prompt", * clientMetadata: { * environment: "production", * }, * }); * ``` * * ## Import * * Import an existing CIMD client by its client ID (usually prefixed with "tpc_"). * For a dynamically registered client, import instead of creating a second * client for the same externalClientId URL. * * ```sh * $ pulumi import auth0:index/clientCimd:ClientCimd my_mcp_agent "tpc_5FPpaVyZGSNRCBzTb2zURZ" * ``` */ export declare class ClientCimd extends pulumi.CustomResource { /** * Get an existing ClientCimd resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ClientCimdState, opts?: pulumi.CustomResourceOptions): ClientCimd; /** * Check whether an existing ClientCimd resource with the given ID exists. * * @param id The _unique_ provider ID of the resource to check. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static exists(id: pulumi.Input, state?: ClientCimdState, opts?: pulumi.CustomResourceOptions): pulumi.Output; /** * Returns true if the given object is an instance of ClientCimd. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ClientCimd; /** * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed. */ readonly allowedOrigins: pulumi.Output; /** * Type of application the client represents. CIMD clients only support `native`, `spa`, and `regularWeb`. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ readonly appType: pulumi.Output; /** * URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document. */ readonly callbacks: pulumi.Output; /** * The ID of the client. */ readonly clientId: pulumi.Output; /** * 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]`. */ readonly clientMetadata: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Configure and associate an organization with the Client */ readonly defaultOrganization: pulumi.Output; /** * Description of the purpose of the client. Once set, removing this argument from configuration does not clear it. For admin-registered clients, set `description = ""` to clear it. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ readonly description: pulumi.Output; /** * 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. */ readonly externalClientId: pulumi.Output; /** * Version number for external*client*id metadata document changes. Update this value to sync the client with the latest values of the json metadata document. Only applies to clients with `externalMetadataCreatedBy` set to `admin`. */ readonly externalClientIdVersion: pulumi.Output; /** * Who created the external metadata client: `admin` (via Management API) or `client` (dynamically self-registered). Read-only; available in Terraform state after import, not in generated configuration. */ readonly externalMetadataCreatedBy: pulumi.Output; /** * Whether Auth0 can resolve the Client ID Metadata Document from its cache or the document URL: `available` or `unavailable` (EA only). */ readonly externalMetadataStatus: pulumi.Output; /** * Type of external metadata. Always `cimd` for CIMD-registered clients. */ readonly externalMetadataType: pulumi.Output; /** * Types of grants that this client is authorized to use. CIMD clients support `authorizationCode` and `refreshToken`. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ readonly grantTypes: pulumi.Output; /** * Whether this is a first-party client. Always `false` for CIMD clients. */ readonly isFirstParty: pulumi.Output; /** * URL for the JSON Web Key Set (JWKS) containing the public keys used for `privateKeyJwt` authentication. */ readonly jwksUri: pulumi.Output; /** * Configuration settings for the JWTs issued for this client. */ readonly jwtConfiguration: pulumi.Output; /** * URL of the logo for this client, derived from the CIMD metadata document. */ readonly logoUri: pulumi.Output; /** * Name of the client, derived from the CIMD metadata document. */ readonly name: pulumi.Output; /** * Whether this client conforms to strict OIDC specifications. Must be `true` for CIMD clients. */ readonly oidcConformant: pulumi.Output; /** * Methods for discovering organizations during the pre*login*prompt. Can include `email` (allows users to find their organization by entering their email address) and/or `organizationName` (requires users to enter the organization name directly). These methods can be combined. Setting this property requires that `organizationRequireBehavior` is set to `preLoginPrompt`. */ readonly organizationDiscoveryMethods: pulumi.Output; /** * Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default), `preLoginPrompt` or `postLoginPrompt`. */ readonly organizationRequireBehavior: pulumi.Output; /** * Defines how to proceed during an authentication transaction with regards to an organization. Can be `deny` (default), `allow` or `require`. */ readonly organizationUsage: pulumi.Output; /** * Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. */ readonly redirectionPolicy: pulumi.Output; /** * Configuration settings for the refresh tokens issued for this client. */ readonly refreshToken: pulumi.Output; /** * Makes the use of Proof-of-Possession mandatory for this client. */ readonly requireProofOfPossession: pulumi.Output; /** * List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7. */ readonly signingKeys: pulumi.Output<{ [key: string]: string; }[]>; /** * Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it. */ readonly skipNonVerifiableCallbackUriConfirmationPrompt: pulumi.Output; /** * Security mode for third-party clients. `strict` enforces enhanced security controls */ readonly thirdPartySecurityMode: pulumi.Output; /** * The token quota configuration. */ readonly tokenQuota: pulumi.Output; /** * Validation result of the CIMD metadata document. */ readonly validations: pulumi.Output; /** * URLs that represent valid web origins for use with web message response mode. */ readonly webOrigins: pulumi.Output; /** * Create a ClientCimd resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ClientCimdArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ClientCimd resources. */ export interface ClientCimdState { /** * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed. */ allowedOrigins?: pulumi.Input[] | undefined>; /** * Type of application the client represents. CIMD clients only support `native`, `spa`, and `regularWeb`. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ appType?: pulumi.Input; /** * URLs that Auth0 may call back after authentication. Derived from the CIMD metadata document. */ callbacks?: pulumi.Input[] | undefined>; /** * The ID of the client. */ clientId?: pulumi.Input; /** * 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]`. */ clientMetadata?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Configure and associate an organization with the Client */ defaultOrganization?: pulumi.Input; /** * Description of the purpose of the client. Once set, removing this argument from configuration does not clear it. For admin-registered clients, set `description = ""` to clear it. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ description?: pulumi.Input; /** * 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. */ externalClientId?: pulumi.Input; /** * Version number for external*client*id metadata document changes. Update this value to sync the client with the latest values of the json metadata document. Only applies to clients with `externalMetadataCreatedBy` set to `admin`. */ externalClientIdVersion?: pulumi.Input; /** * Who created the external metadata client: `admin` (via Management API) or `client` (dynamically self-registered). Read-only; available in Terraform state after import, not in generated configuration. */ externalMetadataCreatedBy?: pulumi.Input; /** * Whether Auth0 can resolve the Client ID Metadata Document from its cache or the document URL: `available` or `unavailable` (EA only). */ externalMetadataStatus?: pulumi.Input; /** * Type of external metadata. Always `cimd` for CIMD-registered clients. */ externalMetadataType?: pulumi.Input; /** * Types of grants that this client is authorized to use. CIMD clients support `authorizationCode` and `refreshToken`. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ grantTypes?: pulumi.Input[] | undefined>; /** * Whether this is a first-party client. Always `false` for CIMD clients. */ isFirstParty?: pulumi.Input; /** * URL for the JSON Web Key Set (JWKS) containing the public keys used for `privateKeyJwt` authentication. */ jwksUri?: pulumi.Input; /** * Configuration settings for the JWTs issued for this client. */ jwtConfiguration?: pulumi.Input; /** * URL of the logo for this client, derived from the CIMD metadata document. */ logoUri?: pulumi.Input; /** * Name of the client, derived from the CIMD metadata document. */ name?: pulumi.Input; /** * Whether this client conforms to strict OIDC specifications. Must be `true` for CIMD clients. */ oidcConformant?: pulumi.Input; /** * Methods for discovering organizations during the pre*login*prompt. Can include `email` (allows users to find their organization by entering their email address) and/or `organizationName` (requires users to enter the organization name directly). These methods can be combined. Setting this property requires that `organizationRequireBehavior` is set to `preLoginPrompt`. */ organizationDiscoveryMethods?: pulumi.Input[] | undefined>; /** * Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default), `preLoginPrompt` or `postLoginPrompt`. */ organizationRequireBehavior?: pulumi.Input; /** * Defines how to proceed during an authentication transaction with regards to an organization. Can be `deny` (default), `allow` or `require`. */ organizationUsage?: pulumi.Input; /** * Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. */ redirectionPolicy?: pulumi.Input; /** * Configuration settings for the refresh tokens issued for this client. */ refreshToken?: pulumi.Input; /** * Makes the use of Proof-of-Possession mandatory for this client. */ requireProofOfPossession?: pulumi.Input; /** * List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7. */ signingKeys?: pulumi.Input; }>[] | undefined>; /** * Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it. */ skipNonVerifiableCallbackUriConfirmationPrompt?: pulumi.Input; /** * Security mode for third-party clients. `strict` enforces enhanced security controls */ thirdPartySecurityMode?: pulumi.Input; /** * The token quota configuration. */ tokenQuota?: pulumi.Input; /** * Validation result of the CIMD metadata document. */ validations?: pulumi.Input[] | undefined>; /** * URLs that represent valid web origins for use with web message response mode. */ webOrigins?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a ClientCimd resource. */ export interface ClientCimdArgs { /** * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed. */ allowedOrigins?: pulumi.Input[] | undefined>; /** * Type of application the client represents. CIMD clients only support `native`, `spa`, and `regularWeb`. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ appType?: pulumi.Input; /** * 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]`. */ clientMetadata?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Configure and associate an organization with the Client */ defaultOrganization?: pulumi.Input; /** * Description of the purpose of the client. Once set, removing this argument from configuration does not clear it. For admin-registered clients, set `description = ""` to clear it. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ description?: pulumi.Input; /** * 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. */ externalClientId: pulumi.Input; /** * Version number for external*client*id metadata document changes. Update this value to sync the client with the latest values of the json metadata document. Only applies to clients with `externalMetadataCreatedBy` set to `admin`. */ externalClientIdVersion?: pulumi.Input; /** * Types of grants that this client is authorized to use. CIMD clients support `authorizationCode` and `refreshToken`. Do not update this field for dynamically registered clients where `externalMetadataCreatedBy` is set to `client`. Auth0 rejects the update. */ grantTypes?: pulumi.Input[] | undefined>; /** * Configuration settings for the JWTs issued for this client. */ jwtConfiguration?: pulumi.Input; /** * Whether this client conforms to strict OIDC specifications. Must be `true` for CIMD clients. */ oidcConformant?: pulumi.Input; /** * Methods for discovering organizations during the pre*login*prompt. Can include `email` (allows users to find their organization by entering their email address) and/or `organizationName` (requires users to enter the organization name directly). These methods can be combined. Setting this property requires that `organizationRequireBehavior` is set to `preLoginPrompt`. */ organizationDiscoveryMethods?: pulumi.Input[] | undefined>; /** * Defines how to proceed during an authentication transaction when `organizationUsage = "require"`. Can be `noPrompt` (default), `preLoginPrompt` or `postLoginPrompt`. */ organizationRequireBehavior?: pulumi.Input; /** * Defines how to proceed during an authentication transaction with regards to an organization. Can be `deny` (default), `allow` or `require`. */ organizationUsage?: pulumi.Input; /** * Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. */ redirectionPolicy?: pulumi.Input; /** * Configuration settings for the refresh tokens issued for this client. */ refreshToken?: pulumi.Input; /** * Makes the use of Proof-of-Possession mandatory for this client. */ requireProofOfPossession?: pulumi.Input; /** * Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it. */ skipNonVerifiableCallbackUriConfirmationPrompt?: pulumi.Input; /** * The token quota configuration. */ tokenQuota?: pulumi.Input; /** * URLs that represent valid web origins for use with web message response mode. */ webOrigins?: pulumi.Input[] | undefined>; } //# sourceMappingURL=clientCimd.d.ts.map