ClientsInterface
in
Interface ClientsInterface.
Table of Contents
- create() : ResponseInterface
- Create a new Client.
- delete() : ResponseInterface
- Delete a Client.
- get() : ResponseInterface
- Get a Client.
- getAll() : ResponseInterface
- Get all Clients.
- update() : ResponseInterface
- Update a Client.
Methods
create()
Create a new Client.
public
create(string $name[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: create:clients.
Parameters
- $name : string
-
name of the new client
- $body : array<string|int, mixed>|null = null
-
Optional. 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
Return values
ResponseInterface —delete()
Delete a Client.
public
delete(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: `delete:clients".
Parameters
- $id : string
-
client (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 —get()
Get a Client.
public
get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scopes:
-
read:clientsfor any call to this endpoint. -
read:client_keysto retrieve "client_secret" and "encryption_key" attributes.
Parameters
- $id : string
-
client (by it's ID) to query
- $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()
Get all Clients.
public
getAll([array<string|int, int|string|null>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scopes:
-
read:clientsfor any call to this endpoint. -
read:client_keysto retrieve "client_secret" and "encryption_key" attributes.
Parameters
- $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 a Client.
public
update(string $id[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scopes:
-
update:clientsfor any call to this endpoint. -
update:client_keysto update "client_secret" and "encryption_key" attributes.
Parameters
- $id : string
-
client (by it's ID) to update
- $body : array<string|int, mixed>|null = null
-
Optional. 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.)