Skip to main content

Update a key

This key management operation allows updating the key label or description fields.

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

Update a key​

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

Update a key label and descr fields.

Headers​

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

Request Body​

NameTypeDescription
kid*StringKey ID, 32-character hex string
label*StringLabel of a key
descrStringBase64 encoded additional description

Response status code​

No response body.

Log entries​

EventResultSource
LOG_TYPE_FAILED_SCOPE_CHECKLOG_RESULT_FAILED403
LOG_TYPE_KEY_ATTRIBUTES_CHANGEDLOG_RESULT_ERROR400
LOG_TYPE_KEY_ATTRIBUTES_CHANGEDLOG_RESULT_FAILED406
LOG_TYPE_KEY_ATTRIBUTES_CHANGEDLOG_RESULT_OK200