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

Facade for the Auth0 Management API Agents (Early Access).

Summary

Types

config()
error()

Functions

create(params, config)

Create an agent.

delete(id, config)

Delete an agent.

get(id, config)

Get an agent.

list(params, config)

Get agents.

update(id, params, config)

Update an agent.

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

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

Functions

Link to this function

create(params, config)

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

Create an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

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

Link to this function

delete(id, config)

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

Delete an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/agents/delete-agent

Link to this function

get(id, config)

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

Get an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

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

Link to this function

list(params, config)

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

Get agents.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

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

Link to this function

update(id, params, config)

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

Update an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/agents/patch-agent