Contact UsGet started

Key Management Service API, gRPC: SymmetricKeyService.List

Written by
Updated at December 17, 2024

Returns the list of symmetric KMS keys in the specified folder.

gRPC request

rpc List (ListSymmetricKeysRequest) returns (ListSymmetricKeysResponse)

ListSymmetricKeysRequest

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

Field

Description

folder_id

string

Required field. ID of the folder to list symmetric KMS keys in.

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 ListSymmetricKeysResponse.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
ListSymmetricKeysResponse.next_page_token returned by a previous list request.

ListSymmetricKeysResponse

{
  "keys": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "status": "Status",
      "primary_version": {
        "id": "string",
        "key_id": "string",
        "status": "Status",
        "algorithm": "SymmetricAlgorithm",
        "created_at": "google.protobuf.Timestamp",
        "primary": "bool",
        "destroy_at": "google.protobuf.Timestamp",
        "hosted_by_hsm": "bool"
      },
      "default_algorithm": "SymmetricAlgorithm",
      "rotated_at": "google.protobuf.Timestamp",
      "rotation_period": "google.protobuf.Duration",
      "deletion_protection": "bool"
    }
  ],
  "next_page_token": "string"
}

Field

Description

keys[]

SymmetricKey

List of symmetric KMS keys in the specified folder.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number
of results is greater than the specified ListSymmetricKeysRequest.page_size, use
the next_page_token as the value for the ListSymmetricKeysRequest.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.

SymmetricKey

A symmetric KMS key that may contain several versions of the cryptographic material.

Field

Description

id

string

ID of the key.

folder_id

string

ID of the folder that the key belongs to.

created_at

google.protobuf.Timestamp

Time when the key was created.

name

string

Name of the key.

description

string

Description of the key.

labels

object (map<string, string>)

Custom labels for the key as key:value pairs. Maximum 64 per key.

status

enum Status

Current status of the key.

  • STATUS_UNSPECIFIED
  • CREATING: The key is being created.
  • ACTIVE: The key is active and can be used for encryption and decryption.
    Can be set to INACTIVE using the SymmetricKeyService.Update method.
  • INACTIVE: The key is inactive and unusable.
    Can be set to ACTIVE using the SymmetricKeyService.Update method.

primary_version

SymmetricKeyVersion

Primary version of the key, used as the default for all encrypt/decrypt operations,
when no version ID is specified.

default_algorithm

enum SymmetricAlgorithm

Default encryption algorithm to be used with new versions of the key.

  • SYMMETRIC_ALGORITHM_UNSPECIFIED
  • AES_128: AES algorithm with 128-bit keys.
  • AES_192: AES algorithm with 192-bit keys.
  • AES_256: AES algorithm with 256-bit keys.
  • AES_256_HSM: AES algorithm with 256-bit keys hosted by HSM

rotated_at

google.protobuf.Timestamp

Time of the last key rotation (time when the last version was created).
Empty if the key does not have versions yet.

rotation_period

google.protobuf.Duration

Time period between automatic key rotations.

deletion_protection

bool

Flag that inhibits deletion of the key

SymmetricKeyVersion

Symmetric KMS key version: metadata about actual cryptographic data.

Field

Description

id

string

ID of the key version.

key_id

string

ID of the symmetric KMS key that the version belongs to.

status

enum Status

Status of the key version.

  • STATUS_UNSPECIFIED
  • ACTIVE: The version is active and can be used for encryption and decryption.
  • SCHEDULED_FOR_DESTRUCTION: The version is scheduled for destruction, the time when it will be destroyed
    is specified in the SymmetricKeyVersion.destroy_at field.
  • DESTROYED: The version is destroyed and cannot be recovered.

algorithm

enum SymmetricAlgorithm

Encryption algorithm that should be used when using the key version to encrypt plaintext.

  • SYMMETRIC_ALGORITHM_UNSPECIFIED
  • AES_128: AES algorithm with 128-bit keys.
  • AES_192: AES algorithm with 192-bit keys.
  • AES_256: AES algorithm with 256-bit keys.
  • AES_256_HSM: AES algorithm with 256-bit keys hosted by HSM

created_at

google.protobuf.Timestamp

Time when the key version was created.

primary

bool

Indication of a primary version, that is to be used by default for all cryptographic
operations that don't have a key version explicitly specified.

destroy_at

google.protobuf.Timestamp

Time when the key version is going to be destroyed. Empty unless the status
is SCHEDULED_FOR_DESTRUCTION.

hosted_by_hsm

bool

Indication of the version that is hosted by HSM.
Previous
Get
Next
ListVersions