View Source Auth0.Management.Clients (Auth0Api v2.5.0)
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 id() :: String.t()
Functions
Create a new client (application or SSO integration).
see
https://auth0.com/docs/api/management/v2/clients/post-clients
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
Delete a client and related configuration (rules, connections, etc).
see
https://auth0.com/docs/api/management/v2/clients/delete-clients-by-id
@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
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
@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
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
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
Get the details of a client credential.
see
https://auth0.com/docs/api/management/v2/clients/get-credentials
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
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
Rotate a client secret.
see
https://auth0.com/docs/api/management/v2/clients/post-rotate-secret
Updates a client's settings
see
https://auth0.com/docs/api/management/v2/clients/patch-clients-by-id
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