Identity and Access Management API, gRPC: ApiKeyService.Create
Creates an API key for the specified service account.
gRPC request
rpc Create (CreateApiKeyRequest) returns (CreateApiKeyResponse)
CreateApiKeyRequest
{
"service_account_id": "string",
"description": "string",
"scope": "string",
"scopes": [
"string"
],
"expires_at": "google.protobuf.Timestamp"
}
|
Field |
Description |
|
service_account_id |
string ID of the service account to create an API key for. The maximum string length in characters is 50. |
|
description |
string Description of the API key. The maximum string length in characters is 256. |
|
scopes[] |
string Scopes of the API key. The maximum string length in characters for each value is 256. The maximum number of elements is 100. |
|
expires_at |
API key expiration timestamp, if not specified, then the API key doesn't expire |
CreateApiKeyResponse
{
"api_key": {
"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",
"masked_secret": "string"
},
"secret": "string"
}
|
Field |
Description |
|
api_key |
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. |
|
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. |
|
masked_secret |
string Masked value of the API key's secret part: |