Identity and Access Management API, REST: ApiKey.Get
Returns the specified API key.
To get the list of available API keys, make a List request.
HTTP request
GET https://iam.api.cloud.yandex.net/iam/v1/apiKeys/{apiKeyId}
Path parameters
|
Field |
Description |
|
apiKeyId |
string Required field. ID of the API key to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"serviceAccountId": "string",
"createdAt": "string",
"description": "string",
"lastUsedAt": "string",
"scope": "string",
"scopes": [
"string"
],
"expiresAt": "string"
}
An ApiKey resource. For more information, see Api-Key.
|
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 |
|
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 |
|
scopes[] |
string Scopes 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 |