View Source Auth0.Management.Clients (Auth0Api v2.5.1)

Facade for the Auth0 Management API Clients endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Functions

Create a new client (application or SSO integration).

Create a client credential associated to your application. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the client_authentication_methods property on the client.

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

Delete a client credential you previously created. May be enabled or disabled.

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.

Get the details of a client credential.

Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.

Get enabled connections for a client.

Get the details of a client credential.

Preview and validate Client ID Metadata Document.

Register or update a CIMD client via metadata URI.

Rotate a client secret.

Updates a client's settings

Change a client credential you previously created. May be enabled or disabled.

Types

@type client_id() :: String.t()
@type config() :: Auth0.Config.t()
@type credential_id() :: String.t()
@type error() :: {:error, integer(), term()} | {:error, term()}
@type id() :: String.t()

Functions

@spec create(map(), config()) :: {:ok, map()} | error()

Create a new client (application or SSO integration).

see

https://auth0.com/docs/api/management/v2/clients/post-clients

Link to this function

create_credential(client_id, params, config)

View Source
@spec create_credential(client_id(), map(), config()) :: {:ok, map()} | error()

Create a client credential associated to your application. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the client_authentication_methods property on the client.

see

https://auth0.com/docs/api/management/v2/clients/post-credentials

@spec delete(id(), config()) :: {:ok, String.t()} | error()

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

see

https://auth0.com/docs/api/management/v2/clients/delete-clients-by-id

Link to this function

delete_credential(client_id, credential_id, config)

View Source
@spec delete_credential(client_id(), credential_id(), config()) ::
  {:ok, String.t()} | error()

Delete a client credential you previously created. May be enabled or disabled.

see

https://auth0.com/docs/api/management/v2/clients/delete-credentials-by-credential-id

@spec get(id(), map(), config()) :: {:ok, map()} | error()

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.

see

https://auth0.com/docs/api/management/v2/clients/get-clients-by-id

Link to this function

get_credential(client_id, credential_id, config)

View Source
@spec get_credential(client_id(), credential_id(), config()) :: {:ok, map()} | error()

Get the details of a client credential.

see

https://auth0.com/docs/api/management/v2/clients/get-credentials-by-credential-id

@spec list(map(), config()) :: {:ok, [map()] | map()} | error()

Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.

see

https://auth0.com/docs/api/management/v2/clients/get-clients

Link to this function

list_connections(id, params, config)

View Source
@spec list_connections(String.t(), map(), config()) :: {:ok, map()} | error()

Get enabled connections for a client.

Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.

see

https://auth0.com/docs/api/management/v2/clients/get-client-connections

Link to this function

list_credentials(client_id, config)

View Source
@spec list_credentials(client_id(), config()) :: {:ok, [map()]} | error()

Get the details of a client credential.

see

https://auth0.com/docs/api/management/v2/clients/get-credentials

Link to this function

preview_cimd_metadata(params, config)

View Source
@spec preview_cimd_metadata(map(), config()) :: {:ok, map()} | error()

Preview and validate Client ID Metadata Document.

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.

see

https://auth0.com/docs/api/management/v2/clients/post-clients-cimd-preview

Link to this function

register_cimd_client(params, config)

View Source
@spec register_cimd_client(map(), config()) :: {:ok, map()} | error()

Register or update a CIMD client via metadata URI.

Idempotent registration for Client ID Metadata Document (CIMD) clients. Uses external_client_id as the unique identifier for upsert operations.

see

https://auth0.com/docs/api/management/v2/clients/post-clients-cimd-register

Link to this function

rotate_secret(id, config)

View Source
@spec rotate_secret(id(), config()) :: {:ok, map()} | error()

Rotate a client secret.

see

https://auth0.com/docs/api/management/v2/clients/post-rotate-secret

Link to this function

update(id, params, config)

View Source
@spec update(id(), map(), config()) :: {:ok, map()} | error()

Updates a client's settings

see

https://auth0.com/docs/api/management/v2/clients/patch-clients-by-id

Link to this function

update_credential(client_id, credential_id, params, config)

View Source
@spec update_credential(client_id(), credential_id(), map(), config()) ::
  {:ok, map()} | error()

Change a client credential you previously created. May be enabled or disabled.

see

https://auth0.com/docs/api/management/v2/clients/patch-credentials-by-credential-id