Secret
Набор методов для управления секретами.
JSON-представление
{
"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
}
Поле | Описание |
---|---|
id | string Идентификатор секрета. |
folderId | string Идентификатор каталога, которому принадлежит секрет. |
createdAt | string (date-time) Время создания. Строка в формате RFC3339. |
name | string Имя секрета. |
description | string (опционально) Описание секрета. |
labels | object Пользовательские метки для секрета в виде пар |
kmsKeyId | string (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ. |
status | string Статус секрета.
Можно установить в INACTIVE с помощью метода deactivate.
Можно установить в ACTIVE с помощью метода activate. |
currentVersion | object Текущая версия секрета. |
currentVersion. id |
string Идентификатор версии. |
currentVersion. secretId |
string Идентификатор секрета, которому принадлежит версия. |
currentVersion. createdAt |
string (date-time) Время создания версии ключа. Строка в формате RFC3339. |
currentVersion. destroyAt |
string (date-time) Время, когда версия ключа будет уничтожена. Пустой, если статус Строка в формате RFC3339. |
currentVersion. description |
string (опционально) Описание версии. |
currentVersion. status |
string Статус секрета.
|
currentVersion. payloadEntryKeys[] |
string Ключи содержимого версии. |
deletionProtection | boolean (boolean) Флаг, запрещающий удаление секрета. |
Методы
Метод | Описание |
---|---|
activate | Активирует указанный секрет. |
addVersion | Добавляет новую версию на основе предыдущей. |
cancelVersionDestruction | Отменяет запланированное уничтожение версии, если версия еще не была уничтожена. |
create | Создает секрет в указанном каталоге. |
deactivate | Деактивирует указанный секрет. |
delete | Удаляет указанный секрет. |
get | Возвращает указанный секрет. |
list | Возвращает список секретов в указанном каталоге. |
listAccessBindings | Возвращает список привязок прав доступа для указанного сертификата. |
listOperations | Возвращает список операций для указанного секрета. |
listVersions | Возвращает список версий указанного секрета. |
scheduleVersionDestruction | Планирует уничтожение указанной версии ключа. |
setAccessBindings | Устанавливает привязки прав доступа для секрета. |
update | Обновляет указанный секрет. |
updateAccessBindings | Обновляет привязки прав доступа для секрета. |