Response Parameters of Key Life Cycle Management APIs
This section lists the Key Life Cycle Management APIs response parameters with their description.
This list is by no means exhaustive.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Id of the resource. |
| createdAt | array of strings | Time and date when the vault was created. |
| updatedAt | array of strings | Time and date when the vault was updated. |
| key_vault | string | Key vault identifier. |
| key_vault_id | string | ID of the key vault. |
| region | string | Region name. |
| deleted | boolean | Specifies whether the key is deleted. |
| backup_at | string | Time and date when the keys in the vault were backed up. |
| soft_delete_enabled | boolean | Specifies whether the soft delete is enabled for the key . |
| key_soft_deleted_in_azure | boolean | Specifies whether the key is soft-deleted in the vault. |
| status | status of the key. | |
| syncedAt | Time and date when the vault was synchronized. | |
| created_by | string | ID of the user who created the key. |
| modified_by | string | ID of the user who modified the key. |
| version | string | Version of the key. |
| key_size | string | Size of the key. |
| key_name | strings | Name of the key. |
| cloud_name | string | Name of the cloud. |
| azure_param | JSON | Azure key parameters. Refer to Azure Parameters for details. |
Azure Parameters
| Parameter | Type | Description |
|---|---|---|
| kid | string | Azure key ID. |
| kty | string | Type of the key. |
| key_ops | array of strings | Cryptographic operations performed by the key. |
| attributes | JSON | Attributes for the key such as exp, enabled, and nbf. |
| recoveryLevel | string | Recovery level set for the key. |
| enabled | boolean | Specify whether the key is enabled or disabled |
| nbf | string | Activation date for the key in Unix Epoch time format. |
| exp | string | Expiration date for the key in Unix Epoch time format. |
| created | string | Time and date when the key was created. |
| updated | string | Time and date when the key was modified. |
| azure_created_at | string | Time and date when the vault was created. |
| azure_updated_at | string | Time and date when the vault was updated. |
| tenant | string | The Azure Active Directory tenant ID that is used for authenticating requests to the key vault. |
| azure_expire_at | string | Time and date when the vault will expire. |
| key_material_origin | string | Origin of the key material. |
| gone | boolean | Specifies whether the key exists in the cloud. |