Auth0-PHP

BlacklistsInterface
in

Interface BlacklistsInterface.

Table of Contents

create()  : ResponseInterface
Blacklist a token.
get()  : ResponseInterface
Retrieve the `jti` and `aud` of all tokens that are blacklisted.

Methods

create()

Blacklist a token.

public create(string $jti[, string|null $aud = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: blacklist:tokens.

Parameters
$jti : string

jti (unique ID within aud) of the blacklisted JWT

$aud : string|null = null

Optional. JWT's aud claim (the client_id to which the JWT was issued).

$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Tags
throws
ArgumentException

when an invalid jti or aud are provided

throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Blacklists/post_tokens
Return values
ResponseInterface

get()

Retrieve the `jti` and `aud` of all tokens that are blacklisted.

public get([string|null $aud = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: blacklist:tokens.

Parameters
$aud : string|null = null

Optional. Filter on the JWT's aud claim (the client_id to which the JWT was issued).

$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Tags
throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Blacklists/get_tokens
Return values
ResponseInterface

Search results