Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Identity and Access Management API, gRPC: KeyService.Update

Written by
Updated at October 17, 2024

Updates the specified key pair.

gRPC request

rpc Update (UpdateKeyRequest) returns (operation.Operation)

UpdateKeyRequest

{
  "keyId": "string",
  "updateMask": "google.protobuf.FieldMask",
  "description": "string"
}

Field

Description

keyId

string

Required field. ID of the Key resource to update.
To get key pair ID, use a KeyService.List request.

updateMask

google.protobuf.FieldMask

Field mask that specifies which fields of the Key resource are going to be updated.

description

string

Description of the key pair.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "keyId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    // Includes only one of the fields `userAccountId`, `serviceAccountId`
    "userAccountId": "string",
    "serviceAccountId": "string",
    // end of the list of possible fields
    "createdAt": "google.protobuf.Timestamp",
    "description": "string",
    "keyAlgorithm": "Algorithm",
    "publicKey": "string",
    "lastUsedAt": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateKeyMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Key

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateKeyMetadata

Field

Description

keyId

string

ID of the Key resource that is being updated.

Key

A Key resource. For more information, see Authorized keys.

Field

Description

id

string

ID of the Key resource.

userAccountId

string

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

Includes only one of the fields userAccountId, serviceAccountId.

serviceAccountId

string

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

Includes only one of the fields userAccountId, serviceAccountId.

createdAt

google.protobuf.Timestamp

Creation timestamp.

description

string

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

keyAlgorithm

enum Algorithm

An algorithm used to generate a key pair of the Key resource.

  • ALGORITHM_UNSPECIFIED
  • 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

google.protobuf.Timestamp

Timestamp for the last use of this key.
Previous
Create
Next
Delete