Auth0-PHP

ResourceServersInterface
in

Interface ResourceServersInterface.

Table of Contents

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.
update()  : ResponseInterface
Update a Resource Server by ID.

Methods

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

Tags
throws
ArgumentException

when an invalid identifier or body are provided

throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Resource_Servers/post_resource_servers
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.)

Tags
throws
ArgumentException

when an invalid id is provided

throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Resource_Servers/delete_resource_servers_by_id
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.)

Tags
throws
ArgumentException

when an invalid id is provided

throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Resource_Servers/get_resource_servers_by_id
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.)

Tags
throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Resource_Servers/get_resource_servers
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.)

Tags
throws
ArgumentException

when an invalid id or body are provided

throws
NetworkException

when the API request fails due to a network error

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

Search results