Identity and Access Management API, gRPC: ApiKeyService.Get
Written by
Updated at March 26, 2025
Returns the specified API key.
To get the list of available API keys, make a List request.
gRPC request
rpc Get (GetApiKeyRequest) returns (ApiKey)
GetApiKeyRequest
{
"api_key_id": "string"
}
|
Field |
Description |
|
api_key_id |
string Required field. ID of the API key to return. |
ApiKey
{
"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"
}
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 |
Creation timestamp. |
|
description |
string Description of the API key. 0-256 characters long. |
|
last_used_at |
Timestamp for the last authentication using this API key. |
|
scopes[] |
string Scopes of the API key. 0-256 characters long. |
|
expires_at |
API key expiration timestamp. |