Schemas

ID of the data encryption key. (UUID format)

Symmetric encryption algorithm of the data encryption key (AES-256-GCM).

Data encryption key ciphertext. Your data encryption key's ciphertext can be stored safely. It can only be decrypted through the keys you create in Key Manager, using the relevant key ID.

Data encryption key plaintext. (Optional) Your data encryption key's plaintext allows you to use the key immediately upon creation. It must neither be stored or shared.

Data encryption key creation date. (RFC 3339 format)

ID of the key used for decryption. (UUID format)

Key's decrypted data.

(Optional) Data encrypted with the latest key rotation. If the data was already encrypted with the latest key rotation, no output will be returned in the response object.

ID of the key used for encryption. (UUID format)

Key's encrypted data.

ID of the target key. (UUID format)

The public key to wrap the key material.

The token generated to authorize the import operation.

The encrypted key material to import. This material must be encrypted using the public key and the exact wrapping algorithm returned by the GetKeyMaterialImportParameters method.

The secure import token returned by the GetKeyMaterialImportParameters method.

ID of the key. (UUID format)

The SRN of the key.

ID of the Project containing the key. (UUID format)

Name of the key.

Key usage. See the Key.Usage enum for a description of possible values.

Key state. See the Key.State enum for a description of possible values.

Number of key rotations. The rotation count tracks the number of times the key has been rotated.

Key creation date. (RFC 3339 format)

Key last modification date. (RFC 3339 format)

Returns true if key protection is applied to the key.

Returns true if the key is locked.

Description of the key.

List of the key's tags.

Key last rotation date. (RFC 3339 format)

Key rotation policy.

Key origin. Refer to the Key.Origin enum for a description of values.

Returns the time at which deletion was requested. (RFC 3339 format)

Key protection level. Refer to the Key.ProtectionLevel enum for a description of values.

Region where the key is stored.

Rotation period. Time interval between two key rotations. The minimum duration is 24 hours and the maximum duration is 1 year (876000 hours). (in seconds)

Key next rotation date. Timestamp indicating the next scheduled rotation. (RFC 3339 format)

Encrypt and decrypt arbitrary payloads using a symmetric encryption algorithm. See the Key.Algorithm.SymmetricEncryption enum for a description of values.

Encrypt and decrypt arbitrary payloads using an asymmetric encryption algorithm. See the Key.Algorithm.AsymmetricEncryption enum for a description of values.

Sign and verify arbitrary messages using an asymmetric signing algorithm. See the Key.Algorithm.AsymmetricSigning enum for a description of values.

Wrap and unwrap key using a key encapsulation algorithm. See the Key.Algorithm.KeyEncapulation enum for a description of values.

ID of the associated key. (UUID format)

Index of the key rotation. The rotation index tracks the specific version of the key material.

Status of the key rotation. See the KeyRotation.Status enum for a description of possible values.

Returns true if the key was rotated manually, or false if it was rotated automatically by a rotation policy.

Key rotation creation date. (RFC 3339 format)

Key rotation last modification date. (RFC 3339 format)

Key rotation deletion date. (RFC 3339 format)

Returns a list of algorithms matching the requested criteria.

Single page of key rotations matching the requested criteria.

Total count of key rotations matching the requested criteria.

Single page of keys matching the requested criteria.

Total count of keys matching the requested criteria.

ID of the key used to generate the signature. (UUID format)

The message signature.

(UUID format)

ID of the key used for verification. (UUID format)

Defines whether the signature is valid. Returns true if the signature is valid for the digest and key, and false otherwise.

(UUID format)