Generate a new Private Key on a keystore
Generate a new Private Key on a keystore
Body
required
Private Key generation request
|
name
string
requiredThe Key's name |
|
keystore
string
requiredThe Keystore in which to generate the Key |
|
description
string (Key type)
requiredThe key type
Enum
rsa-1024
rsa-2048
rsa-3072
rsa-4096
rsa-8192
ec-secp256r1
ec-secp384r1
ec-secp521r1
ec-brainpoolp256r1
ec-brainpoolp384r1
ec-brainpoolp512r1
ed-25519
ed-448
mldsa-44
mldsa-65
mldsa-87
mldsa-44sha512
mldsa-65sha512
mldsa-87sha512
slhdsa-sha2-128s
slhdsa-sha2-128f
slhdsa-sha2-192s
slhdsa-sha2-192f
slhdsa-sha2-256s
slhdsa-sha2-256f
slhdsa-sha2-128ssha256
slhdsa-sha2-128fsha256
slhdsa-sha2-192ssha512
slhdsa-sha2-192fsha512
slhdsa-sha2-256ssha512
slhdsa-sha2-256fsha512
|
|
extractable
boolean
If true, this key will be extractable |
|
modifiable
boolean
If true, this key will be modifiable |
|
hardwareProtected
boolean
If true, this key will be hardware protected in AKV and GCP |
Responses
-
201 Private Key successfully generated
namestring requiredThe Private Key's name
keystorestring requiredThe Keystore's name on which this Key is stored
descriptionstring (Key type) requiredThe key type
Enumrsa-1024rsa-2048rsa-3072rsa-4096rsa-8192ec-secp256r1ec-secp384r1ec-secp521r1ec-brainpoolp256r1ec-brainpoolp384r1ec-brainpoolp512r1ed-25519ed-448mldsa-44mldsa-65mldsa-87mldsa-44sha512mldsa-65sha512mldsa-87sha512slhdsa-sha2-128sslhdsa-sha2-128fslhdsa-sha2-192sslhdsa-sha2-192fslhdsa-sha2-256sslhdsa-sha2-256fslhdsa-sha2-128ssha256slhdsa-sha2-128fsha256slhdsa-sha2-192ssha512slhdsa-sha2-192fsha512slhdsa-sha2-256ssha512slhdsa-sha2-256fsha512extractableboolean requiredIf true, this Key can be extracted from the Keystore
aliasstringThe Private Key's alias
modifiablebooleanIf true, this Key can be extracted from the Keystore
hardwareProtectedbooleanIf the key is protected by hardware
enforcedHashAlgorithmstring (Hash Algorithm)This Key's Hash Algorithm
EnumSHA1SHA224SHA256SHA384SHA512SHA3_224SHA3_256SHA3_384SHA3_512 -
204 Private Key generation was successfully requested but the key is not yet retrievable (asynchronous keystore, e.g. GCP KMS)
-
400 Bad Request
-
401 Unauthorized request
-
403 Forbidden action
-
404 Not Found
-
500 Internal Server error