Retrieve detailed key information for dashboard interfaces and administrative purposes.
Use this to build key management dashboards showing users their key details, status, permissions, and usage data. You can identify keys by keyId or the actual key string.
Important: Set decrypt: true only in secure contexts to retrieve plaintext key values from recoverable keys.
Required Permissions
Your root key must have one of the following permissions for basic key information:
api.*.read_key (to read keys from any API)api.<api_id>.read_key (to read keys from a specific API)Additional permission required for decrypt functionality:
api.*.decrypt_key or api.<api_id>.decrypt_key