Enabling Key for Rotation Job
Use the /v1/cckm/azure/keys/{id}/enable-rotation-job
enable an Azure key for scheduled rotation job. To use this API, first create a new rotation job configuration, the job_config_id
is required to call this API. Refer to Scheduling Key Rotation for details.
Syntax
Here, {id}
represents the key ID.
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
auto_rotate_key_source | string | Source of the key material. Possible options are: • native • hsm-luna (FM-enabled Luna HSM is not supported as a key source) • dsm • external-cm • ciphertrust |
auto_rotate_partition_id | string | ID of the partition in which the Luna HSM key will be created. |
auto_rotate_domain_id | string | ID of the DSM domain in which the key will be created. |
auto_rotate_external_cm_domain_id | string | ID of the external CipherTrust Manager domain in which the external CipherTrust Manager key will be created. |
auto_rotate_key_type | string | Algorithm for the key. Possible options are: • EC - "Soft" Elliptic Curve key. • EC-HSM - "Hard" Elliptic Curve key (only for premium key vaults). • RSA : "Soft" RSA key. • RSA-HSM : "Hard" RSA key (only for premium key vaults). |
job_config_id | string | Id of the scheduler job that will perform key rotation. |
auto_rotate_ec_name | string | Name of the Elliptical curve key. Required only when key_type=EC. Possible options are: • P-256 • P-384 • P-521 • SECP256K1 |
auto_rotate_enable_key | boolean | Flag to enable the newly rotated key. |
auto_rotate_key_size | integer | Size of the new rotated key. Required only when key_type=RSA. Possible options are: •2048 • 3072 • 4096 |
auto_rotate_release_policy | JSON | New key release policy for the exportable keys. |
Example Request
Example Response
The sample output shows that the key (with ID 45b35f7b-b7b7-416c-a29c-4568d354fd2c
) is enabled for the scheduled key rotation.
To know more about response parameters, refer to Response Parameters of Key Life Cycle Management APIs.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.