Auth0.Management.Clients (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Clients.

endpoint

/api/v2/clients /api/v2/clients/{id} /api/v2/clients/{id}/rotate-secret

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

create(params, config)

Create a client.

delete(id, config)

Delete a client.

get(id, params, config)

Get a client.

list(params, config)

Get clients.

rotate_secret(id, config)

Rotate a client secret.

update(id, params, config)

Update a client.

Link to this section Types

config()

Specs

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

error()

Specs

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

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

create(params, config)

Specs

create(Auth0.Management.Clients.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Client.t(), response_body()} | error()

Create a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/post_clients

delete(id, config)

Specs

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

Delete a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/delete_clients_by_id

get(id, params, config)

Specs

get(id(), Auth0.Management.Clients.Get.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Client.t(), response_body()} | error()

Get a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/get_clients_by_id

list(params, config)

Specs

list(Auth0.Management.Clients.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Clients.t(), response_body()} | error()

Get clients.

see

https://auth0.com/docs/api/management/v2/#!/Clients/get_clients

rotate_secret(id, config)

Specs

rotate_secret(id(), config()) ::
  {:ok, Auth0.Entity.Client.t(), response_body()} | error()

Rotate a client secret.

see

https://auth0.com/docs/api/management/v2/#!/Clients/post_rotate_secret

update(id, params, config)

Specs

update(id(), Auth0.Management.Clients.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Client.t(), response_body()} | error()

Update a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/patch_clients_by_id