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

Documentation for Auth0 Management API of ResourceServers.

endpoint

/api/v2/resource-servers
/api/v2/resource-servers/{id}

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

create(params, config)

Create a resource server.

delete(id, config)

Delete a resource server.

get(id, params, config)

Get a resource server.

list(params, config)

Get resource servers.

update(id, params, config)

Update a resource server.

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.ResourceServers.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.ResourceServer.t(), response_body()} | error()

Create a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/post_resource_servers

delete(id, config)

Specs

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

Delete a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/delete_resource_servers_by_id

get(id, params, config)

Specs

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

Get a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers_by_id

list(params, config)

Specs

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

Get resource servers.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers

update(id, params, config)

Specs

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

Update a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers_by_id