Encedo HEM API Developer Manual
  • Welcome!
  • Preliminary
    • Quick Start
    • General information
  • Security
    • Report an issue
    • Advisory
      • Hall of fame
  • Reference
    • API Reference
      • System
        • Version & Status
        • Checkin
        • Configuration
        • Upgrade
          • Firmware
            • Low level USB mode
          • Management app
        • Self-test
        • Reboot
        • Shutdown
      • Authorization
        • Initialization
        • User authentication
        • External authenticator
          • Registration
          • Authentication
      • Key Management
        • Create a key
        • Derive a key
        • Import a key
        • Update a key
        • Delete a key
        • Get a public key
        • List the keys
        • Search a key
      • Cryptography operations
        • HMAC
        • ExDSA
        • ECDH
        • Encryption
          • Encryption/Decryption
          • Wrap/Unwrap
      • Audit log
      • Storage
Powered by GitBook
On this page
  1. Reference
  2. API Reference
  3. Key Management

Update a key

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

Allowed users

Allowed

Not allowed

Allowed

Required access scope

keymgmt:upd

Update a key

POST https://my.ence.do/api/keymgmt/update

Update a key label and descr field.

Headers

Name
Type
Description

Authorization*

String

Bearer JWT_TOKEN

Content-Type*

String

application/json

Request Body

Name
Type
Description

kid*

String

Key ID, 32 chars hex string

label

String

Label of a key

descr

String

Base64 encoded additional description

Log entries

Event
Result
Source

LOG_TYPE_FAILED_SCOPE_CHECK

LOG_RESULT_FAILED

403

LOG_TYPE_KEY_ATTRIBUTES_CHANGED

LOG_RESULT_ERROR

400

LOG_TYPE_KEY_ATTRIBUTES_CHANGED

LOG_RESULT_FAILED

406

LOG_TYPE_KEY_ATTRIBUTES_CHANGED

LOG_RESULT_OK

200

PreviousImport a keyNextDelete a key

Last updated 3 years ago