Key Management Service API, gRPC: AsymmetricSignatureKeyService.List
Returns the list of asymmetric KMS keys in the specified folder.
gRPC request
rpc List (ListAsymmetricSignatureKeysRequest) returns (ListAsymmetricSignatureKeysResponse)
ListAsymmetricSignatureKeysRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string"
}
Field |
Description |
folderId |
string Required field. ID of the folder to list asymmetric KMS keys in. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
ListAsymmetricSignatureKeysResponse
{
"keys": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"status": "Status",
"signatureAlgorithm": "AsymmetricSignatureAlgorithm",
"deletionProtection": "bool"
}
],
"nextPageToken": "string"
}
Field |
Description |
keys[] |
List of asymmetric KMS keys in the specified folder. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number |
AsymmetricSignatureKey
An asymmetric KMS key that may contain several versions of the cryptographic material.
Field |
Description |
id |
string ID of the key. |
folderId |
string ID of the folder that the key belongs to. |
createdAt |
Time when the key was created. |
name |
string Name of the key. |
description |
string Description of the key. |
labels |
string Custom labels for the key as |
status |
enum Status Current status of the key.
|
signatureAlgorithm |
enum AsymmetricSignatureAlgorithm Signature Algorithm ID.
|
deletionProtection |
bool Flag that inhibits deletion of the key |