View Source Auth0.Management.ClientGrants (Auth0Api v2.5.0)

Facade for the Auth0 Management API Client Grants endpoints.

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

Summary

Types

config()

error()

id()

Functions

create(params, config)

Create a client grant for a machine-to-machine login flow.

delete(id, config)

Delete the Client Credential Flow from your machine-to-machine application.

get(id, config)

Get client grant.

list(params, config)

Retrieve a list of client grants, including the scopes associated with the application/API pair.

list_organizations(id, params, config)

Get the organizations associated to a client grant.

update(id, params, config)

Update a client grant.

Types

config()

@type config() :: Auth0.Config.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 client grant for a machine-to-machine login flow.

see

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

delete(id, config)

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

Delete the Client Credential Flow from your machine-to-machine application.

see

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

get(id, config)

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

Get client grant.

Retrieve a single client grant, including the scopes associated with the application/API pair.

see

https://auth0.com/docs/api/management/v2/client-grants/get-client-grant

list(params, config)

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

Retrieve a list of client grants, including the scopes associated with the application/API pair.

see

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

list_organizations(id, params, config)

@spec list_organizations(String.t(), map(), config()) ::
  {:ok, map() | [map()]} | error()

Get the organizations associated to a client grant.

see

https://auth0.com/docs/api/management/v2/client-grants/get-client-grant-organizations

update(id, params, config)

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

Update a client grant.

see

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