Lockbox API, gRPC: SecretService.List

Written by

Yandex Cloud

Updated at October 28, 2024

gRPC request
ListSecretsRequest
ListSecretsResponse
Secret
Version
PasswordPayloadSpecification

Retrieves the list of secrets in the specified folder.

gRPC request

rpc List (ListSecretsRequest) returns (ListSecretsResponse)

ListSecretsRequest

{
  "folderId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field	Description
folderId	string Required field. ID of the folder to list secrets in.
pageSize	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a [ListSecretsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100.
pageToken	string Page token. To get the next page of results, set `page_token` to the [ListSecretsRequest.next_page_token] returned by a previous list request.

ListSecretsResponse

{
  "secrets": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "string",
      "kmsKeyId": "string",
      "status": "Status",
      "currentVersion": {
        "id": "string",
        "secretId": "string",
        "createdAt": "google.protobuf.Timestamp",
        "destroyAt": "google.protobuf.Timestamp",
        "description": "string",
        "status": "Status",
        "payloadEntryKeys": [
          "string"
        ],
        // Includes only one of the fields `passwordPayloadSpecification`
        "passwordPayloadSpecification": {
          "passwordKey": "string",
          "length": "int64",
          "includeUppercase": "google.protobuf.BoolValue",
          "includeLowercase": "google.protobuf.BoolValue",
          "includeDigits": "google.protobuf.BoolValue",
          "includePunctuation": "google.protobuf.BoolValue",
          "includedPunctuation": "string",
          "excludedPunctuation": "string"
        }
        // end of the list of possible fields
      },
      "deletionProtection": "bool",
      // Includes only one of the fields `passwordPayloadSpecification`
      "passwordPayloadSpecification": {
        "passwordKey": "string",
        "length": "int64",
        "includeUppercase": "google.protobuf.BoolValue",
        "includeLowercase": "google.protobuf.BoolValue",
        "includeDigits": "google.protobuf.BoolValue",
        "includePunctuation": "google.protobuf.BoolValue",
        "includedPunctuation": "string",
        "excludedPunctuation": "string"
      }
      // end of the list of possible fields
    }
  ],
  "nextPageToken": "string"
}

Field

Description

secrets[]

Secret

List of secrets in the specified folder.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number
of results is greater than the specified ListSecretsRequest.pageSize, use
the next_page_token as the value for the ListSecretsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Secret

A secret that may contain several versions of the payload.

Field	Description
id	string ID of the secret.
folderId	string ID of the folder that the secret belongs to.
createdAt	google.protobuf.Timestamp Creation timestamp.
name	string Name of the secret.
description	string Description of the secret.
labels	string Custom labels for the secret as `key:value` pairs. Maximum 64 per key.
kmsKeyId	string Optional ID of the KMS key will be used to encrypt and decrypt the secret.
status	enum Status Status of the secret. `STATUS_UNSPECIFIED` `CREATING`: The secret is being created. `ACTIVE`: The secret is active and the secret payload can be accessed. Can be set to INACTIVE using the SecretService.Deactivate method. `INACTIVE`: The secret is inactive and unusable. Can be set to ACTIVE using the SecretService.Deactivate method.
currentVersion	Version Current (i.e. the `latest`) version of the secret.
deletionProtection	bool Flag that inhibits deletion of the secret.
passwordPayloadSpecification	PasswordPayloadSpecification Includes only one of the fields `passwordPayloadSpecification`.

Version

Field	Description
id	string ID of the version.
secretId	string ID of the secret that the version belongs to.
createdAt	google.protobuf.Timestamp Time when the version was created.
destroyAt	google.protobuf.Timestamp Time when the version is going to be destroyed. Empty unless the status is `SCHEDULED_FOR_DESTRUCTION`.
description	string Description of the version.
status	enum Status Status of the secret. `STATUS_UNSPECIFIED` `ACTIVE`: The version is active and the secret payload can be accessed. `SCHEDULED_FOR_DESTRUCTION`: The version is scheduled for destruction, the time when it will be destroyed is specified in the `Version.destroyAt` field. `DESTROYED`: The version is destroyed and cannot be recovered.
payloadEntryKeys[]	string Keys of the entries contained in the version payload.
passwordPayloadSpecification	PasswordPayloadSpecification Includes only one of the fields `passwordPayloadSpecification`.

PasswordPayloadSpecification

Field	Description
passwordKey	string Required field. key of the entry to store generated password value
length	int64 password length; by default, a reasonable length will be decided
includeUppercase	google.protobuf.BoolValue whether at least one A..Z character is included in the password, true by default
includeLowercase	google.protobuf.BoolValue whether at least one a..z character is included in the password, true by default
includeDigits	google.protobuf.BoolValue whether at least one 0..9 character is included in the password, true by default
includePunctuation	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
includedPunctuation	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)
excludedPunctuation	string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32)

Lockbox API, gRPC: SecretService.List

gRPC requestgRPC request

ListSecretsRequestListSecretsRequest

ListSecretsResponseListSecretsResponse

SecretSecret

VersionVersion

PasswordPayloadSpecificationPasswordPayloadSpecification