Key

A set of methods for managing Key resources.

JSON Representation

{
  "id": "string",
  "createdAt": "string",
  "description": "string",
  "keyAlgorithm": "string",
  "publicKey": "string",

  //  includes only one of the fields `userAccountId`, `serviceAccountId`
  "userAccountId": "string",
  "serviceAccountId": "string",
  // end of the list of possible fields

}
Field Description
id string

ID of the Key resource.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.

description string

Description of the Key resource. 0-256 characters long.

keyAlgorithm string
An algorithm used to generate a key pair of the Key resource.
  • RSA_2048: RSA with a 2048-bit key size. Default value.
  • RSA_4096: RSA with a 4096-bit key size.
publicKey string

A public key of the Key resource.

userAccountId string
includes only one of the fields userAccountId, serviceAccountId

ID of the user account that the Key resource belongs to.

serviceAccountId string
includes only one of the fields userAccountId, serviceAccountId

ID of the service account that the Key resource belongs to.

Methods

Method Description
create Creates a key pair for the specified service account.
delete Deletes the specified key pair.
get Returns the specified Key resource.
list Retrieves the list of Key resources for the specified service account.
listOperations Lists operations for the specified key.