Given an GCP configuration, fetch a list of available GCP key rings which can be used to back a group.

  • Published on Jul 8, 2025
  • 1 minute(s) read
Prev Next
Post
/sys/v1/groups/hmg/gcp_key_rings

Given an GCP configuration, fetch a list of available GCP key rings which can be used to back a group.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Body parameters
object
service_account_email
string Required

Email for the service account to be used.

project_id
string Required

The project ID is a unique identifier for a project

location
string Required

For a given project in GCP KMS, resources can be created in one of many locations. These represent the geographical regions where a resource is stored and can be accessed. A key's location impacts the performance of applications using the key. https://cloud.google.com/kms/docs/locations

key_ring
string | null

A key ring organizes keys in a specific GCP location and allows you to manage access control on groups of keys. https://cloud.google.com/kms/docs/resource-hierarchy#key_rings

private_key
string (byte)

Private component of the service account key pair that can be obtained from the GCP cloud console. It is used to authenticate the requests made by DSM to the GCP cloud.

Responses
2XX

Success result

Array of string
string