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

Facade for the Auth0 Management API Resource Servers endpoints.

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

Summary

Functions

Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0.

Delete an existing API by ID.

Retrieve API details with the given ID.

Retrieve details of all APIs associated with your tenant.

Search resource servers.

Change an existing API setting by resource server ID.

Types

@type config() :: Auth0.Config.t()
@type error() :: {:error, integer(), term()} | {:error, term()}
@type id() :: String.t()

Functions

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

Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0.

see

https://auth0.com/docs/api/management/v2/resource-servers/post-resource-servers

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

Delete an existing API by ID.

see

https://auth0.com/docs/api/management/v2/resource-servers/delete-resource-servers-by-id

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

Retrieve API details with the given ID.

see

https://auth0.com/docs/api/management/v2/resource-servers/get-resource-servers-by-id

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

Retrieve details of all APIs associated with your tenant.

see

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

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

Search resource servers.

Search resource servers using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /resource-servers endpoint with better performance for complex queries. Results may not reflect recent updates immediately.

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/resource-servers/get-resource-servers-search

Link to this function

update(id, params, config)

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

Change an existing API setting by resource server ID.

see

https://auth0.com/docs/api/management/v2/resource-servers/patch-resource-servers-by-id