Lockbox API, gRPC: SecretService.List
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 |
pageToken |
string Page token. To get the next page of results, set |
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[] |
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 |
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 |
Creation timestamp. |
name |
string Name of the secret. |
description |
string Description of the secret. |
labels |
string Custom labels for the secret as |
kmsKeyId |
string Optional ID of the KMS key will be used to encrypt and decrypt the secret. |
status |
enum Status Status of the secret.
|
currentVersion |
Current (i.e. the |
deletionProtection |
bool Flag that inhibits deletion of the secret. |
passwordPayloadSpecification |
Includes only one of the fields |
Version
Field |
Description |
id |
string ID of the version. |
secretId |
string ID of the secret that the version belongs to. |
createdAt |
Time when the version was created. |
destroyAt |
Time when the version is going to be destroyed. Empty unless the status |
description |
string Description of the version. |
status |
enum Status Status of the secret.
|
payloadEntryKeys[] |
string Keys of the entries contained in the version payload. |
passwordPayloadSpecification |
Includes only one of the fields |
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 |
whether at least one A..Z character is included in the password, true by default |
includeLowercase |
whether at least one a..z character is included in the password, true by default |
includeDigits |
whether at least one 0..9 character is included in the password, true by default |
includePunctuation |
whether at least one punctuation character is included in the password, true by default |
includedPunctuation |
string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: |
excludedPunctuation |
string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32) |