Secret
A set of methods for managing secrets.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"kmsKeyId": "string",
"status": "string",
"currentVersion": {
"id": "string",
"secretId": "string",
"createdAt": "string",
"destroyAt": "string",
"description": "string",
"status": "string",
"payloadEntryKeys": [
"string"
]
},
"deletionProtection": true
}
| Field | Description |
|---|---|
| id | string ID of the secret. |
| folderId | string ID of the folder that the secret belongs to. |
| createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. |
| name | string Name of the secret. |
| description | string Description of the secret. |
| labels | object Custom labels for the secret as |
| kmsKeyId | string Optional ID of the KMS key will be used to encrypt and decrypt the secret. |
| status | string Status of the secret.
Can be set to INACTIVE using the deactivate method.
Can be set to ACTIVE using the deactivate method. |
| currentVersion | object Current (i.e. the |
| currentVersion. id |
string ID of the version. |
| currentVersion. secretId |
string ID of the secret that the version belongs to. |
| currentVersion. createdAt |
string (date-time) Time when the version was created. String in RFC3339 text format. |
| currentVersion. destroyAt |
string (date-time) Time when the version is going to be destroyed. Empty unless the status is String in RFC3339 text format. |
| currentVersion. description |
string Description of the version. |
| currentVersion. status |
string Status of the secret.
|
| currentVersion. payloadEntryKeys[] |
string Keys of the entries contained in the version payload. |
| deletionProtection | boolean (boolean) Flag that inhibits deletion of the secret. |
Methods
| Method | Description |
|---|---|
| activate | Activates the specified secret. |
| addVersion | Adds new version based on a previous one. |
| cancelVersionDestruction | Cancels previously scheduled version destruction, if the version hasn't been destroyed yet. |
| create | Creates a secret in the specified folder. |
| deactivate | Deactivates the specified secret. |
| delete | Deletes the specified secret. |
| get | Returns the specified secret. |
| list | Retrieves the list of secrets in the specified folder. |
| listAccessBindings | Lists existing access bindings for the specified secret. |
| listOperations | Lists operations for the specified secret. |
| listVersions | Retrieves the list of versions of the specified secret. |
| scheduleVersionDestruction | Schedules the specified version for destruction. |
| setAccessBindings | Sets access bindings for the secret. |
| update | Updates the specified secret. |
| updateAccessBindings | Updates access bindings for the secret. |