Contact UsGet started

Identity and Access Management API, gRPC: ApiKeyService.List

Written by
Updated at December 17, 2024

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

gRPC request

rpc List (ListApiKeysRequest) returns (ListApiKeysResponse)

ListApiKeysRequest

{
  "service_account_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

service_account_id

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.

page_size

int64

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

page_token

string

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

ListApiKeysResponse

{
  "api_keys": [
    {
      "id": "string",
      "service_account_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "description": "string",
      "last_used_at": "google.protobuf.Timestamp",
      "scope": "string",
      "scopes": [
        "string"
      ],
      "expires_at": "google.protobuf.Timestamp"
    }
  ],
  "next_page_token": "string"
}

Field

Description

api_keys[]

ApiKey

List of API keys.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListApiKeysRequest.page_size, use
the next_page_token as the value
for the ListApiKeysRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token 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.

service_account_id

string

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

created_at

google.protobuf.Timestamp

Creation timestamp.

description

string

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

last_used_at

google.protobuf.Timestamp

Timestamp for the last authentication using this API key.

scope

string

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

scopes[]

string

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

expires_at

google.protobuf.Timestamp

API key expiration timestamp.
Previous
Overview
Next
Get