• management
• SDK
• ClientsClient

Class ClientsClient

Index

Accessors

credentialsconnections

Constructors

constructor

Methods

listcreatepreviewCimdMetadataregisterCimdClientgetdeleteupdaterotateSecret

Properties

_options_credentials_connections

Accessors

credentials

get credentials(): CredentialsClient

Returns CredentialsClient

connections

get connections(): ConnectionsClient

Returns ConnectionsClient

Constructors

constructor

new ClientsClient(options: BaseClientOptions): ClientsClient

Parameters

• options: BaseClientOptions

Returns ClientsClient

Methods

list

list(
request?: ListClientsRequestParameters,
requestOptions?: ClientsClient.RequestOptions,
): Promise<Page<Client, ListClientsOffsetPaginatedResponseContent>>

Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified. For more information, read Applications in Auth0 and Single Sign-On.

• The following can be retrieved with any scope: client_id, app_type, name, and description.
• The following properties can only be retrieved with the read:clients or read:client_keys scope: callbacks, oidc_logout, allowed_origins, web_origins, tenant, global, config_route, callback_url_template, jwt_configuration, jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded, jwt_configuration.scopes, jwt_configuration.alg, api_type, logo_uri, allowed_clients, owners, custom_login_page, custom_login_page_off, sso, addons, form_template, custom_login_page_codeview, resource_servers, client_metadata, mobile, mobile.android, mobile.ios, allowed_logout_urls, token_endpoint_auth_method, is_first_party, oidc_conformant, is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types, refresh_token, refresh_token.rotation_type, refresh_token.expiration_type, refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage, organization_require_behavior.
• The following properties can only be retrieved with the read:client_keys or read:client_credentials scope: encryption_key, encryption_key.pub, encryption_key.cert, client_secret, client_authentication_methods and signing_key.

Parameters

• request: ListClientsRequestParameters = {}
• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<Client, ListClientsOffsetPaginatedResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.clients.list({ fields: "fields", include_fields: true, page: 1, per_page: 1, include_totals: true, is_global: true, is_first_party: true, app_type: "app_type", external_client_id: "external_client_id", q: "q" })Copy

create

create(
request: CreateClientRequestContent,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<CreateClientResponseContent>

Create a new client (application or SSO integration). For more information, read Create ApplicationsAPI Endpoints for Single Sign-On.

Notes:

• We recommend leaving the client_secret parameter unspecified to allow the generation of a safe secret.
• The client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).
• When using client_authentication_methods to configure the client with Private Key JWT authentication method, specify fully defined credentials. These credentials will be automatically enabled for Private Key JWT authentication on the client.
• To configure client_authentication_methods, the create:client_credentials scope is required.
• To configure client_authentication_methods, the property jwt_configuration.alg must be set to RS256.

SSO Integrations created via this endpoint will accept login requests and share user profile information.

Parameters

• request: CreateClientRequestContent
• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateClientResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.clients.create({ name: "name" })Copy

previewCimdMetadata

previewCimdMetadata(
request: PreviewCimdMetadataRequestContent,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<PreviewCimdMetadataResponseContent>

Fetches and validates a Client ID Metadata Document without creating a client. Returns the raw metadata and how it would be mapped to Auth0 client fields. This endpoint is useful for testing metadata URIs before creating CIMD clients.

Parameters

• request: PreviewCimdMetadataRequestContent
• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<PreviewCimdMetadataResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Throws

Management.InternalServerError

Example

await client.clients.previewCimdMetadata({ external_client_id: "external_client_id" })Copy

registerCimdClient

registerCimdClient(
request: RegisterCimdClientRequestContent,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<RegisterCimdClientResponseContent>

Idempotent registration for Client ID Metadata Document (CIMD) clients. Uses external_client_id as the unique identifier for upsert operations. Create: Returns 201 when a new client is created (requires \

Parameters

• request: RegisterCimdClientRequestContent
• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<RegisterCimdClientResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Throws

Management.InternalServerError

Example

await client.clients.registerCimdClient({ external_client_id: "external_client_id" })Copy

get

get(
id: string,
request?: GetClientRequestParameters,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<GetClientResponseContent>

Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. For more information, read Applications in Auth0 and Single Sign-On.

• The following properties can be retrieved with any of the scopes: client_id, app_type, name, and description.
• The following properties can only be retrieved with the read:clients or read:client_keys scopes: callbacks, oidc_logout, allowed_origins, web_origins, tenant, global, config_route, callback_url_template, jwt_configuration, jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded, jwt_configuration.scopes, jwt_configuration.alg, api_type, logo_uri, allowed_clients, owners, custom_login_page, custom_login_page_off, sso, addons, form_template, custom_login_page_codeview, resource_servers, client_metadata, mobile, mobile.android, mobile.ios, allowed_logout_urls, token_endpoint_auth_method, is_first_party, oidc_conformant, is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types, refresh_token, refresh_token.rotation_type, refresh_token.expiration_type, refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage, organization_require_behavior.
• The following properties can only be retrieved with the read:client_keys or read:client_credentials scopes: encryption_key, encryption_key.pub, encryption_key.cert, client_secret, client_authentication_methods and signing_key.

Parameters

• id: string

ID of the client to retrieve.

• request: GetClientRequestParameters = {}
• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetClientResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.clients.get("id", { fields: "fields", include_fields: true })Copy

delete

delete(
id: string,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<void>

Delete a client and related configuration (rules, connections, etc).

Parameters

• id: string

ID of the client to delete.

• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.clients.delete("id")Copy

update

update(
id: string,
request?: UpdateClientRequestContent,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<UpdateClientResponseContent>

Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On.

Notes:

• The client_secret and signing_key attributes can only be updated with the update:client_keys scope.
• The client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).
• When using client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
• To configure client_authentication_methods, the update:client_credentials scope is required.
• To configure client_authentication_methods, the property jwt_configuration.alg must be set to RS256.
• To change a client's is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.

Parameters

• id: string

ID of the client to update.

• request: UpdateClientRequestContent = {}
• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateClientResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.clients.update("id")Copy

rotateSecret

rotateSecret(
id: string,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<RotateClientSecretResponseContent>

Rotate a client secret.

This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.

For more information, read Rotate Client Secrets.

Parameters

• id: string

ID of the client that will rotate secrets.

• OptionalrequestOptions: ClientsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<RotateClientSecretResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.clients.rotateSecret("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_credentials

_credentials: CredentialsClient | undefined

Protected_connections

_connections: ConnectionsClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors credentialsconnections Constructors constructor Methods listcreatepreviewCimdMetadataregisterCimdClientgetdeleteupdaterotateSecret Properties _options_credentials_connections