View Source Auth0.Management.RefreshTokens (Auth0Api v2.5.1)

Facade for the Auth0 Management API Refresh Tokens endpoints.

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

Summary

Functions

Delete a refresh token by its ID.

Retrieve refresh token information.

Get refresh tokens.

Revoke refresh tokens.

Update a refresh token.

Types

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

Functions

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

Delete a refresh token by its ID.

see

https://auth0.com/docs/api/management/v2/refresh-tokens/delete-refresh-token

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

Retrieve refresh token information.

see

https://auth0.com/docs/api/management/v2/refresh-tokens/get-refresh-token

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

Get refresh tokens.

Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.

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/refresh-tokens/get-refresh-tokens

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

Revoke refresh tokens.

Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience.

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/refresh-tokens/revoke-refresh-tokens

Link to this function

update(id, params, config)

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

Update a refresh token.

Update a refresh token by its ID.

see

https://auth0.com/docs/api/management/v2/refresh-tokens/patch-refresh-tokens-by-id