ClientGrantsInterface
in
Interface ClientGrantsInterface.
Table of Contents
- create() : ResponseInterface
- Create a new Client Grant.
- delete() : ResponseInterface
- Delete a Client Grant by ID.
- getAll() : ResponseInterface
- Retrieve client grants, by page if desired.
- getAllByAudience() : ResponseInterface
- Get Client Grants by audience.
- getAllByClientId() : ResponseInterface
- Get Client Grants by Client ID.
- update() : ResponseInterface
- Update an existing Client Grant.
Methods
create()
Create a new Client Grant.
public
create(string $clientId, string $audience[, array<string|int, string>|null $scope = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: create:client_grants.
Parameters
- $clientId : string
-
client ID to receive the grant
- $audience : string
-
audience identifier for the API being granted
- $scope : array<string|int, string>|null = null
-
Optional. Scopes allowed for this client grant.
- $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
Return values
ResponseInterface —delete()
Delete a Client Grant by ID.
public
delete(string $grantId[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: delete:client_grants.
Parameters
- $grantId : string
-
grant (by it's ID) 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
Return values
ResponseInterface —getAll()
Retrieve client grants, by page if desired.
public
getAll([array<string|int, int|string|null> $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:client_grants.
Parameters
- $parameters : array<string|int, int|string|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
Return values
ResponseInterface —getAllByAudience()
Get Client Grants by audience.
public
getAllByAudience(string $audience[, array<string|int, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:client_grants.
Parameters
- $audience : string
-
API Audience to filter by
- $parameters : array<string|int, 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
Return values
ResponseInterface —getAllByClientId()
Get Client Grants by Client ID.
public
getAllByClientId(string $clientId[, array<string|int, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:client_grants.
Parameters
- $clientId : string
-
client ID to filter by
- $parameters : array<string|int, 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
Return values
ResponseInterface —update()
Update an existing Client Grant.
public
update(string $grantId[, array<string|int, string>|null $scope = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:client_grants.
Parameters
- $grantId : string
-
grant (by it's ID) to update
- $scope : array<string|int, string>|null = null
-
Optional. Array of scopes to update; will replace existing scopes, not merge.
- $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.)