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

Search a key

This key management operation allows searching the repository for a key based on the key 'descr' field.

Allowed users

Allowed

Not allowed

Allowed

Required access scope

keymgmt:searchIf the configuration option allow_keysearch is true search is possible without the Authorization header under the condition of having minimum first 6 bytes of descr field.

Search for a key(s)

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

Search the keys stored in the repository by pattern.

Headers

Name
Type
Description

Authorization

String

Bearer JWT_TOKEN

Content-Type*

String

application/json

Request Body

Name
Type
Description

descr*

String

Pattern to search for.

offset

Number

Skip offset entries.

limit

Number

Limit number of return entries, default is 15 if skipped. 

{
  "offset": 0,
  "total": 5,
  "listed": 1,
  "list": [{
  	"kid": "4111bc76291bff8d319a056f15bb46f0",
	"created": 1647802803,
	"type": "ATT,PKEY,ECDH,CURVE448",
	"label": "Chris main Transfer key",
	"descr": "RVRTRlRYNTcyMDc0NzI1MjI1NTE3OWNocmlzQGVuY2Vkby5jb20=",
	"updated": 1647802803
  }]
}

Response data for successful operation

Log entries

Event
Result
Source

LOG_TYPE_FAILED_SCOPE_CHECK

LOG_RESULT_FAILED

403

PreviousList the keysNextCryptography operations

Last updated 2 years ago

This operation returns the same data as "List the keys". Check for details .

here