Contact UsGet started

Identity and Access Management API, gRPC: ApiKeyService.List

Written by
Updated at October 17, 2024

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

gRPC request

rpc List (ListApiKeysRequest) returns (ListApiKeysResponse)

ListApiKeysRequest

{
  "serviceAccountId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

serviceAccountId

string

ID of the service account to list API keys 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.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListApiKeysResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken
to the ListApiKeysResponse.nextPageToken
returned by a previous list request.

ListApiKeysResponse

{
  "apiKeys": [
    {
      "id": "string",
      "serviceAccountId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "description": "string",
      "lastUsedAt": "google.protobuf.Timestamp",
      "scope": "string",
      "expiresAt": "google.protobuf.Timestamp"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

apiKeys[]

ApiKey

List of API keys.

nextPageToken

string

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

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

google.protobuf.Timestamp

Creation timestamp.

description

string

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

lastUsedAt

google.protobuf.Timestamp

Timestamp for the last authentication using this API key.

scope

string

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

expiresAt

google.protobuf.Timestamp

API key expiration timestamp.
Previous
Overview
Next
Get