Identity and Access Management API, REST: ApiKey methods
A set of methods for managing API keys.
JSON Representation
{
"id": "string",
"serviceAccountId": "string",
"createdAt": "string",
"description": "string",
"lastUsedAt": "string",
"scope": "string",
"expiresAt": "string"
}
Field | Description |
---|---|
id | string ID of the API Key. |
serviceAccountId | string ID of the service account that the API key belongs to. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
description | string Description of the API key. 0-256 characters long. |
lastUsedAt | string (date-time) Timestamp for the last authentication using this API key. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
scope | string Scope of the API key. 0-256 characters long. |
expiresAt | string (date-time) API key expiration timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
Methods
Method | Description |
---|---|
create | Creates an API key for the specified service account. |
delete | Deletes the specified API key. |
get | Returns the specified API key. |
list | Retrieves the list of API keys for the specified service account. |
listOperations | Retrieves the list of operations for the specified API key. |
listScopes | Retrieves the list of scopes. |
update | Updates the specified API key. |