Contact UsGet started

Identity and Access Management API, REST: Key methods

Written by
Updated at April 4, 2024

A set of methods for managing Key resources.

JSON Representation

{
  "id": "string",
  "createdAt": "string",
  "description": "string",
  "keyAlgorithm": "string",
  "publicKey": "string",
  "lastUsedAt": "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. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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.
lastUsedAt string (date-time)

Timestamp for the last use of this key.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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.
update Updates the specified key pair.
Previous
revoke
Next
create