Auth0-PHP

ResourceServers extends ManagementEndpoint
in package
implements ResourceServersInterface

Class ResourceServers.

Handles requests to the Resource Servers endpoint of the v2 Management API.

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

Interfaces, Classes, Traits and Enums

ResourceServersInterface
Interface ResourceServersInterface.

Table of Contents

$httpClient  : HttpClient
__construct()  : mixed
ManagementEndpoint constructor.
create()  : ResponseInterface
Create a new Resource Server.
delete()  : ResponseInterface
Delete a Resource Server by ID.
get()  : ResponseInterface
Get a single Resource Server by ID or API identifier.
getAll()  : ResponseInterface
Get all Resource Servers, by page if desired.
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
update()  : ResponseInterface
Update a Resource Server by ID.

Properties

Methods

__construct()

ManagementEndpoint constructor.

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

httpClient instance to use

Return values
mixed

create()

Create a new Resource Server.

public create(string $identifier, array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: create:resource_servers.

Parameters
$identifier : string

API identifier to use

$body : array<string|int, mixed>

Additional body content to pass with the API request. See @see for supported options.

$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

delete()

Delete a Resource Server by ID.

public delete(string $id[, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: delete:resource_servers.

Parameters
$id : string

resource Server ID or identifier to delete

$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()

Get a single Resource Server by ID or API identifier.

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

Required scope: read:resource_servers.

Parameters
$id : string

resource Server ID or identifier to get

$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

getAll()

Get all Resource Servers, by page if desired.

public getAll([RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:resource_servers.

Parameters
$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

update()

Update a Resource Server by ID.

public update(string $id, array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: update:resource_servers.

Parameters
$id : string

resource Server ID or identifier to update

$body : array<string|int, mixed>

Additional body content to pass with the API request. See @see for supported options.

$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