Ключи
Набор методов для управления ключами шифрования:
Метод API |
HTTP-метод |
Описание |
|---|---|---|
Get keys |
GET |
Возвращает список всех существующих ключей |
Get keys/{keyId} |
GET |
Возвращает информацию об определенном ключе |
Create |
POST |
Создает ключ |
Update |
PATCH |
Обновляет параметры ключа |
Delete |
DELETE |
Удаляет ключ |
defaultAlgorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
description (string) – описание криптографического ключа.
labels (array) – ярлык криптографического ключа.
labels[] (string) – ярлык криптографического ключа.
name (string) – имя криптографического ключа.
parentId (string) – обязательное поле. Указывается идентификатор пространства имен.
rotationPeriod (string) – период ротации.
200 OK – A successful response.
createdAt (string) – дата создания ключа.
defaultAlgorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
description (string) – описание криптографического ключа.
id (string) – идентификатор криптографического ключа.
labels (array) – ярлык криптографического ключа.
labels[] (string) – ярлык криптографического ключа.
name (string) – наименование криптографического ключа.
nextRotationTime (string) – следующая дата ротации ключа.
owner (string) – идентификатор владельца ключа.
primary (object) – версии криптографического ключа.
primary.algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
primary.createdAt (string) – дата создания версии криптографического ключа.
primary.destroyAt (string) – дата удаления версии криптографического ключа.
primary.id (integer) – идентификатор версии криптографического ключа.
primary.keyId (string) – идентификатор криптографического ключа.
primary.state (string) – состояние версии криптографического ключа.
rotationPeriod (string) – период ротации ключа.
- PATCH /v1/keys/{key.id}
- Parameters
key.id (string) – идентификатор криптографического ключа.
- Request JSON Object
key (object) – обязательное поле. Обновленный криптографический ключ.
key.createdAt (string) – дата создания ключа.
key.defaultAlgorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
key.description (string) – описание криптографического ключа.
key.id (string) – идентификатор криптографического ключа.
key.labels (array) – ярлык криптографического ключа.
key.labels[] (string) – ярлык криптографического ключа.
key.name (string) – наименование криптографического ключа.
key.nextRotationTime (string) – следующая дата ротации ключа.
key.owner (string) – идентификатор владельца ключа.
key.primary (object) – версии криптографического ключа.
key.primary.algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
key.primary.createdAt (string) – дата создания версии криптографического ключа.
key.primary.destroyAt (string) – дата удаления версии криптографического ключа.
key.primary.id (integer) – идентификатор версии криптографического ключа.
key.primary.keyId (string) – идентификатор криптографического ключа.
key.primary.state (string) – состояние версии криптографического ключа.
key.rotationPeriod (string) – период ротации ключа.
updateMask (string) – обязательное поле. Маска обновления ключа.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – дата создания ключа.
defaultAlgorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
description (string) – описание криптографического ключа.
id (string) – идентификатор криптографического ключа.
labels (array) – ярлык криптографического ключа.
labels[] (string) – ярлык криптографического ключа.
name (string) – наименование криптографического ключа.
nextRotationTime (string) – следующая дата ротации ключа.
owner (string) – идентификатор владельца ключа.
primary (object) – версии криптографического ключа.
primary.algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
primary.createdAt (string) – дата создания версии криптографического ключа.
primary.destroyAt (string) – дата удаления версии криптографического ключа.
primary.id (integer) – идентификатор версии криптографического ключа.
primary.keyId (string) – идентификатор криптографического ключа.
primary.state (string) – состояние версии криптографического ключа.
rotationPeriod (string) – период ротации ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
200 OK – A successful response.
createdAt (string) – дата создания ключа.
defaultAlgorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
description (string) – описание криптографического ключа.
id (string) – идентификатор криптографического ключа.
labels (array) – ярлык криптографического ключа.
labels[] (string) – ярлык криптографического ключа.
name (string) – наименование криптографического ключа.
nextRotationTime (string) – следующая дата ротации ключа.
owner (string) – идентификатор владельца ключа.
primary (object) – версии криптографического ключа.
primary.algorithm (string) – алгоритм шифрования. Если параметр не указан, то будет использован алгоритм по умолчанию, заданный в криптографическом ключе.
primary.createdAt (string) – дата создания версии криптографического ключа.
primary.destroyAt (string) – дата удаления версии криптографического ключа.
primary.id (integer) – идентификатор версии криптографического ключа.
primary.keyId (string) – идентификатор криптографического ключа.
primary.state (string) – состояние версии криптографического ключа.
rotationPeriod (string) – период ротации ключа.
keyId (string) – обязательное поле. Идентификатор криптографического ключа.
200 OK – A successful response.