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

Summary

Types

client_id()

config()

credential_id()

error()

id()

Functions

create(params, config)

Create a new client (application or SSO integration).

create_credential(client_id, params, config)

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(id, config)

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

delete_credential(client_id, credential_id, config)

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

get(id, params, config)

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_credential(client_id, credential_id, config)

Get the details of a client credential.

list(params, config)

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

list_credentials(client_id, config)

Get the details of a client credential.

rotate_secret(id, config)

Rotate a client secret.

update(id, params, config)

Updates a client's settings

update_credential(client_id, credential_id, params, config)

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

Types

client_id()

@type client_id() :: String.t()

config()

@type config() :: Auth0.Config.t()

credential_id()

@type credential_id() :: String.t()

error()

@type error() :: {:error, integer(), term()} | {:error, term()}

id()

@type id() :: String.t()

Functions

create(params, config)

@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

create_credential(client_id, params, config)

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

see

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

delete(id, config)

@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

delete_credential(client_id, credential_id, config)

@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

get(id, params, config)

@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

get_credential(client_id, credential_id, config)

@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

list(params, config)

@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

list_credentials(client_id, config)

@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

rotate_secret(id, config)

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

Rotate a client secret.

see

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

update(id, params, config)

@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

update_credential(client_id, credential_id, params, config)

@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