Skip to main content

Create a key

This key management operation allows the creation of a new key and saving it inside the device's secure repository.

Allowed usersUser✓Master✗ExtAuth✓
Required access scopekeymgmt:gen

Create a new key​

POSThttps://my.ence.do/api/keymgmt/create

Create a new key and save it.

Headers​

NameTypeDescription
Authorization*StringBearer JWT_TOKEN
Content-Type*Stringapplication/json

Request Body​

NameTypeDescription
label*StringLabel of a key
modeStringKey operation mode (for NIST ECC only)
type*StringType of key to create
descrStringBase64 encoded additional description

Response status code​

{
"kid":"09bd0958e1499ecfd51ea62a3f49a84c"
}

Possible type values​

TypeDescription
SECP256R1NIST P-256 ECC key
SECP384R1NIST P-384 ECC key
SECP521R1NIST P-521 ECC key
SECP256K1SEC2-v2 ECC key
CURVE25519CURVE25519 ECC ECDH only key
CURVE448CURVE4ECC ECDH only key
ED25519ED25519 ECC EdDSA only key
ED448ED448 ECC EdDSA only key
SHA2-256SHA2-256 HMAC symmetric key
SHA2-384SHA2-384 HMAC symmetric key
SHA2-512SHA2-512 HMAC symmetric key
SHA3-256SHA3-256 HMAC symmetric key
SHA3-384SHA3-384 HMAC symmetric key
SHA3-512SHA3-512 HMAC symmetric key
AES128AES 128 bits symmetric key
AES192AES 192 bits symmetric key
AES256AES 256 bits symmetric key
MLKEM512ML-KEM-512 key
MLKEM768ML-KEM-768 key
MLKEM1024ML-KEM-1024 key
MLDSA44ML-DSA-44 key
MLDSA65ML-DSA-65 key
MLDSA87ML-DSA-87 key

Possible mode values (NIST ECC keys only)​

ModeDescription
ECDHLimit usage to ECDH only.
ExDSALimit usage to ExDSA only.
ECDH,ExDSAAllow both ECDH and ECDH mode.

Response data for successful operation​

NameTypeDescription
kidStringKey ID, 32 chars hex string

Log entries​

EventResultSource
LOG_TYPE_FAILED_SCOPE_CHECKLOG_RESULT_FAILED403
LOG_TYPE_KEY_GENERATIONLOG_RESULT_ERROR400
LOG_TYPE_KEY_GENERATIONLOG_RESULT_FAILED406
LOG_TYPE_KEY_GENERATIONLOG_RESULT_OK200