Method list

Retrieves the list of API keys for the specified service account.

HTTP request

GET https://iam.api.cloud.yandex.net/iam/v1/apiKeys

Query parameters

Parameter Description
serviceAccountId ID of the service account to list API keys for. To get the service account ID, use a list request. If not specified, it defaults to the subject that made the request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "apiKeys": [
    {
      "id": "string",
      "serviceAccountId": "string",
      "createdAt": "string",
      "description": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
apiKeys[] object

An ApiKey resource.

apiKeys[].
id
string

ID of the API Key.

apiKeys[].
serviceAccountId
string

ID of the service account that the API key belongs to.

apiKeys[].
createdAt
string (date-time)

Creation timestamp.

String in RFC3339 text format.

apiKeys[].
description
string

Description of the API key. 0-256 characters long.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.