Auth0-PHP

Blacklists extends ManagementEndpoint
in package
implements BlacklistsInterface

Class Blacklists.

Handles requests to the Blacklists endpoint of the v2 Management API.

Tags
see
https://auth0.com/docs/api/management/v2#!/Blacklists

Interfaces, Classes, Traits and Enums

BlacklistsInterface
Interface BlacklistsInterface.

Table of Contents

$httpClient  : HttpClient
__construct()  : mixed
ManagementEndpoint constructor.
create()  : ResponseInterface
Blacklist a token.
get()  : ResponseInterface
Retrieve the `jti` and `aud` of all tokens that are blacklisted.
getHttpClient()  : HttpClient
Get the injected HttpClient instance.
getLastRequest()  : HttpRequest|null
Return an instance of HttpRequest representing the last issued request.
getResponsePaginator()  : HttpResponsePaginator
Return a ResponsePaginator instance configured for the last HttpRequest.
instance()  : static

Properties

Methods

__construct()

ManagementEndpoint constructor.

public final __construct(HttpClient $httpClient) : mixed
Parameters
$httpClient : HttpClient

httpClient instance to use

Return values
mixed

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.)

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.)

Return values
ResponseInterface

Search results