Generate a new Private Key on a keystore
Generate a new Private Key on a keystore
Private Key generation request
|
name
string
requiredThe Key's name |
||||||
|
keystore
string
requiredThe Keystore in which to generate the Key |
||||||
|
description
object (Key Description)
required
Cryptographic information about a Private Key |
||||||
|
||||||
|
extractable
boolean | null
If true, this key will be extractable |
||||||
|
modifiable
boolean | null
If true, this key will be modifiable |
||||||
|
hardwareProtected
boolean | null
If true, this key will be hardware protected in AKV and GCP |
||||||
-
201 Private Key successfully generated
application/jsonnamestring requiredThe Private Key's name
keystorestring requiredThe Keystore's name on which this Key is stored
descriptionobject (Key Description) requiredCryptographic information about a Private Key
typestring requiredThe type of cryptographic algorithms allowed on this Key
ValuesuitebkeyTypestring requiredThe algorithm type of the Key
EnumecedrsakeySizeinteger | nullThe Key's size for an RSA Key
keyECParameterstring | nullThe Key's curve for an Elliptic-curve Key
Enumsecp256r1secp384r1secp521r1keyEDParameterstring | nullThe Key's curve for an Edwards-curve Key
EnumED25519ED448extractableboolean requiredIf true, this Key can be extracted from the Keystore
aliasstring | nullThe Private Key's alias
modifiableboolean | nullIf true, this Key can be extracted from the Keystore
enforcedHashAlgorithmobject | nullThis Key's Hash Algorithm
EnumSHA1SHA224SHA256SHA384SHA512SHA3_224SHA3_256SHA3_384SHA3_512 -
400 Bad Request
application/jsonerrorstring requiredThe error code of the problem
ValueKEY-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid key generation requesttitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid key generation requestdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or account does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or account does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValueAuthentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueAuthentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-010messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/jsonerrorstring requiredThe error code of the problem
ValueKEY-004messagestring requiredA short, human-readable summary of the problem type
ValueKey already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueKey already existsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/jsonerrorstring requiredThe error code of the problem
ValueKEYSTORE-003messagestring requiredA short, human-readable summary of the problem type
ValueKeystore not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueKeystore not founddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/jsonerrorstring requiredThe error code of the problem
ValueKEY-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueKEYSTORE-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807