Keys
in package
Client operations for Inttegro keys.
Request arrays use the API's documented snake_case field names. Responses
are returned as immutable values from the corresponding singular namespace.
Table of Contents
Methods
- __construct() : mixed
- Creates the keys resource client.
- destroy() : SecretKey
- Destroys the secret key.
- generate() : Generated
- Generates a new secret key.
- lookup() : SecretKey
- Retrieves the requested secret key.
- page() : Page
- Retrieves a paginated collection of keys.
- update() : SecretKey
- Updates the supplied fields on the secret key.
- usage() : Usage
- Retrieves usage records for a secret key.
Methods
__construct()
Creates the keys resource client.
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
-
Shared authenticated HTTP transport used by this resource client.
destroy()
Destroys the secret key.
public
destroy(string|array<string|int, mixed> $key) : SecretKey
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $key : string|array<string|int, mixed>
-
key value.
Return values
SecretKey —The destroyed secret key result.
generate()
Generates a new secret key.
public
generate([array<string, mixed> $payload = [] ]) : Generated
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $payload : array<string, mixed> = []
-
Request fields keyed by the documented
snake_caseAPI names.
Return values
Generated —The resulting generated.
lookup()
Retrieves the requested secret key.
public
lookup(string $secretKeyId) : SecretKey
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $secretKeyId : string
-
Unique identifier of the secret key.
Return values
SecretKey —The requested secret key.
page()
Retrieves a paginated collection of keys.
public
page([array<string, mixed> $payload = [] ]) : Page
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $payload : array<string, mixed> = []
-
Request fields keyed by the documented
snake_caseAPI names.
Return values
Page —A typed page of matching keys.
update()
Updates the supplied fields on the secret key.
public
update(array<string, mixed> $payload) : SecretKey
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $payload : array<string, mixed>
-
Request fields keyed by the documented
snake_caseAPI names.
Return values
SecretKey —The updated secret key.
usage()
Retrieves usage records for a secret key.
public
usage(string|array<string|int, mixed> $key) : Usage
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $key : string|array<string|int, mixed>
-
key value.
Return values
Usage —The resulting usage.