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.
Import a public key
POST
https://my.ence.do/api/keymgmt/importImport a public key and save it in the repository of keys.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization* | String | Bearer JWT_TOKEN |
| Content-Type* | String | application/json |
Request Body
| Name | Type | Description |
|---|---|---|
descr | String | Base64 encoded additional description |
label* | String | Label of a key |
mode | String | Key operation mode (for NIST ECC only) |
pubkey* | String | Base64 encoded external public key |
type* | String | Type of key to create |
Response status code
- 200: Operation successful
- 401: Missing or invalid JWT_TOKEN
- 403: Incorrect access scope
- 406: Operation failed
- 409: Incorrect internal state
- 400: Incorrect argument(s)
- 411: Protocol error - Content-Length required
- 412: Protocol error - CORS validation failed
- 413: Protocol error - request body too big
- 418: TLS connection required
- 500: Internal server error
{
"kid":"d51ea62a3f49a84cadbd0958e1499ecf"
}
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
Possible pubkey values
| Type | Description |
|---|---|
| SECP256R1 | NIST P-256 ECC key |
| SECP384R1 | NIST P-384 ECC key |
| SECP521R1 | NIST P-521 ECC key |
| SECP256K1 | SEC2-v2 ECC key |
| CURVE25519 | CURVE25519 ECC ECDH only key |
| CURVE448 | CURVE4ECC ECDH only key |
| ED25519 | ED25519 ECC EdDSA only key |
| ED448 | ED448 ECC EdDSA only key |
| MLKEM512 | ML-KEM-512 key |
| MLKEM768 | ML-KEM-768 key |
| MLKEM1024 | ML-KEM-1024 key |
| MLDSA44 | ML-DSA-44 key |
| MLDSA65 | ML-DSA-65 key |
| MLDSA87 | ML-DSA-87 key |
Possible mode values (NIST ECC keys only)
Check the list here.
Possible type values
| Value | Description |
|---|---|
| SECP256R1 | NIST P-256 ECC key |
| SECP384R1 | NIST P-384 ECC key |
| SECP521R1 | NIST P-521 ECC key |
| SECP256K1 | SEC2-v2 ECC key |
| CURVE25519 | CURVE25519 ECC ECDH only key |
| CURVE448 | CURVE4ECC ECDH only key |
| ED25519 | ED25519 ECC EdDSA only key |
| ED448 | ED448 ECC EdDSA only key |
| MLKEM512 | ML-KEM-512 key |
| MLKEM768 | ML-KEM-768 key |
| MLKEM1024 | ML-KEM-1024 key |
| MLDSA44 | ML-DSA-44 key |
| MLDSA65 | ML-DSA-65 key |
| MLDSA87 | ML-DSA-87 key |
Possible mode values (NIST ECC keys only)
| Value | Description |
|---|---|
| ECDH | Limit usage to ECDH only. |
| ECDH,ExDSA | Allow both ECDH and ECDH mode. |
| ExDSA | Limit usage to ExDSA only. |
Response data for successful operation
| Name | Type | Description |
|---|---|---|
kid | String | Key ID, 32-character hex string |
Log entries
| Event | Result | Source |
|---|---|---|
| LOG_TYPE_FAILED_SCOPE_CHECK | LOG_RESULT_FAILED | 403 |
| LOG_TYPE_KEY_IMPORT | LOG_RESULT_ERROR | 400 |
| LOG_TYPE_KEY_IMPORT | LOG_RESULT_FAILED | 406 |
| LOG_TYPE_KEY_IMPORT | LOG_RESULT_OK | 200 |