Lockbox API, gRPC: SecretService.Update

Written by

Yandex Cloud

Updated at July 1, 2026

View in Markdown

gRPC request
UpdateSecretRequest
PasswordPayloadSpecification
operation.Operation

Updates the specified secret.

gRPC request

rpc Update (UpdateSecretRequest) returns (operation.Operation)

UpdateSecretRequest

{
  // Includes only one of the fields `password_payload_specification`
  "password_payload_specification": {
    "password_key": "string",
    "length": "int64",
    "include_uppercase": "google.protobuf.BoolValue",
    "include_lowercase": "google.protobuf.BoolValue",
    "include_digits": "google.protobuf.BoolValue",
    "include_punctuation": "google.protobuf.BoolValue",
    "included_punctuation": "string",
    "excluded_punctuation": "string"
  },
  // end of the list of possible fields
  "secret_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "deletion_protection": "bool"
}

Field	Description
password_payload_specification	PasswordPayloadSpecification Includes only one of the fields `password_payload_specification`.
secret_id	string Required field. ID of the secret to update. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Required field. Field mask that specifies which attributes of the secret are going to be updated.
name	string New name of the secret. The maximum string length in characters is 100.
description	string New description of the secret. The maximum string length in characters is 1024.
labels	object (map<string, string>) Custom labels for the secret as `key:value` pairs. Maximum 64 per key. The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
deletion_protection	bool Flag that inhibits deletion of the secret.

PasswordPayloadSpecification

Field	Description
password_key	string Required field. key of the entry to store generated password value Value must match the regular expression `[-_./\\@0-9a-zA-Z]+`.
length	int64 password length; by default, a reasonable length will be decided The maximum value is 256.
include_uppercase	google.protobuf.BoolValue whether at least one A..Z character is included in the password, true by default
include_lowercase	google.protobuf.BoolValue whether at least one a..z character is included in the password, true by default
include_digits	google.protobuf.BoolValue whether at least one 0..9 character is included in the password, true by default
include_punctuation	google.protobuf.BoolValue whether at least one punctuation character is included in the password, true by default punctuation characters by default (there are 32): !"#$%&'()*+,-./:;<=>?@[]^_`{\|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below
included_punctuation	string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use (at most, all the 32)
excluded_punctuation	string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32)

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any 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	google.protobuf.Any 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.

Lockbox API, gRPC: SecretService.Update

gRPC requestgRPC request

UpdateSecretRequestUpdateSecretRequest

PasswordPayloadSpecificationPasswordPayloadSpecification

operation.Operationoperation.Operation

Was the article helpful?

gRPC request

UpdateSecretRequest

PasswordPayloadSpecification

operation.Operation