Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Identity and Access Management API, REST: ApiKey.Create

Written by
Updated at December 17, 2024

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.
To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
If not specified, it defaults to the subject that made the request.

description

string

Description of the API key.

scope

string

Scope 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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

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

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).
Previous
Get
Next
Update