Identity and Access Management API, REST: ApiKey.Create
Creates an API key for the specified service account.
HTTP request
POST https://iam.api.cloud.yandex.net/iam/v1/apiKeys
Body parameters
{
"serviceAccountId": "string",
"description": "string",
"scope": "string",
"scopes": [
"string"
],
"expiresAt": "string"
}
|
Field |
Description |
|
serviceAccountId |
string ID of the service account to create an API key for. |
|
description |
string Description of the API key. |
|
scopes[] |
string Scopes of the API key. |
|
expiresAt |
string (date-time) API key expiration timestamp, if not specified, then the API key doesn't expire 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 |
Response
HTTP Code: 200 - OK
{
"apiKey": {
"id": "string",
"serviceAccountId": "string",
"createdAt": "string",
"description": "string",
"lastUsedAt": "string",
"scope": "string",
"scopes": [
"string"
],
"expiresAt": "string"
},
"secret": "string"
}
|
Field |
Description |
|
apiKey |
ApiKey resource. |
|
secret |
string Secret part of the API key. This secret key you may use in the requests for authentication. |
ApiKey
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 |