Skip to main content

Import a key

This key management operation allows importing of a public key to the keys repository and treats it as a trusted key afterwards.

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

Import a public key​

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

Import a public key and save it in the repository of keys.

Headers​

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

Request Body​

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

Response status code​

{
"kid":"d51ea62a3f49a84cadbd0958e1499ecf"
}

Possible pubkey 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
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)​

Check the list here.

Possible type values​

ValueDescription
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
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)​

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

Response data for successful operation​

NameTypeDescription
kidStringKey ID, 32-character hex string

Log entries​

EventResultSource
LOG_TYPE_FAILED_SCOPE_CHECKLOG_RESULT_FAILED403
LOG_TYPE_KEY_IMPORTLOG_RESULT_ERROR400
LOG_TYPE_KEY_IMPORTLOG_RESULT_FAILED406
LOG_TYPE_KEY_IMPORTLOG_RESULT_OK200