Auth0-PHP

GrantsInterface
in

Interface GrantsInterface.

Table of Contents

delete()  : ResponseInterface
Delete a grant by Grant ID or User ID.
getAll()  : ResponseInterface
Retrieve the grants associated with your account.
getAllByAudience()  : ResponseInterface
Get Grants by Audience with pagination.
getAllByClientId()  : ResponseInterface
Get Grants by Client ID with pagination.
getAllByUserId()  : ResponseInterface
Get Grants by User ID with pagination.

Methods

delete()

Delete a grant by Grant ID or User ID.

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

Required scope: delete:grants.

Parameters
$id : string

grant ID to delete a single Grant or User ID to delete all Grants for a User

$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#!/Grants/delete_grants_by_id
Return values
ResponseInterface

getAll()

Retrieve the grants associated with your account.

public getAll([array<string, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:grants.

Parameters
$parameters : array<string, int|string|null>|null = null

Optional. Query parameters 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
NetworkException

when the API request fails due to a network error

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

getAllByAudience()

Get Grants by Audience with pagination.

public getAllByAudience(string $audience[, array<string, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:grants.

Parameters
$audience : string

audience to filter Grants

$parameters : array<string, int|string|null>|null = null

Optional. Additional query parameters 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 audience is provided

throws
NetworkException

when the API request fails due to a network error

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

getAllByClientId()

Get Grants by Client ID with pagination.

public getAllByClientId(string $clientId[, array<string, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:grants.

Parameters
$clientId : string

client ID to filter Grants

$parameters : array<string, int|string|null>|null = null

Optional. Additional query parameters 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 clientId is provided

throws
NetworkException

when the API request fails due to a network error

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

getAllByUserId()

Get Grants by User ID with pagination.

public getAllByUserId(string $userId[, array<string, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:grants.

Parameters
$userId : string

user ID to filter Grants

$parameters : array<string, int|string|null>|null = null

Optional. Additional query parameters 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 userId is provided

throws
NetworkException

when the API request fails due to a network error

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

Search results