Skip to content

CreateDFCKey.md

Latest commit

 

History

History
35 lines (31 loc) · 3.4 KB

CreateDFCKey.md

File metadata and controls

35 lines (31 loc) · 3.4 KB

akeyless.CreateDFCKey

Properties

Name Type Description Notes
alg String DFCKey type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024, RSA2048, RSA3072, RSA4096]
autoRotate String Whether to automatically rotate every rotation_interval days, or disable existing automatic rotation [true/false] [optional]
certificateCommonName String Common name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
certificateCountry String Country name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
certificateDigestAlgo String Digest algorithm to be used for the certificate key signing. [optional]
certificateFormat String [optional]
certificateLocality String Locality for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
certificateOrganization String Organization name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
certificateProvince String Province name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
certificateTtl Number TTL in days for the generated certificate. Required only for generate-self-signed-certificate. [optional]
confFileData String The csr config data in base64 encoding [optional]
customerFrgId String The customer fragment ID that will be used to create the DFC key (if empty, the key will be created independently of a customer fragment) [optional]
deleteProtection String Protection from accidental deletion of this object [true/false] [optional]
description String Description of the object [optional]
expirationEventIn [String] How many days before the expiration of the certificate would you like to be notified. [optional]
generateSelfSignedCertificate Boolean Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided. [optional]
hashAlgorithm String Specifies the hash algorithm used for the encryption key's operations, available options: [SHA256, SHA384, SHA512] [optional] [default to 'SHA256']
itemCustomFields {String: String} Additional custom fields to associate with the item [optional]
json Boolean Set output format to JSON [optional] [default to false]
metadata String Deprecated - use description [optional]
name String DFCKey name
rotationEventIn [String] How many days before the rotation of the item would you like to be notified [optional]
rotationInterval String The number of days to wait between every automatic rotation (7-365) [optional]
splitLevel Number The number of fragments that the item will be split into (not includes customer fragment) [optional] [default to 3]
tag [String] List of the tags attached to this DFC key [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
uidToken String The universal identity token, Required only for universal_identity authentication [optional]