Lexicon Garden

social.coves.aggregator.getApiKey

Get information about the authenticated aggregator's API key. Note: The actual key value is NEVER returned - only metadata about the key.

Repository @coves.social did:web:coves.social namespace authority
Details · query
Kindquery
Authorityaggregator.coves.social
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

Output

application/json

hasKey

requiredboolean

Whether the aggregator has an API key (active or revoked)

keyInfo

ref

API key metadata. Only present if hasKey is true.

Reference

Errors

AuthenticationRequired

Authentication is required to get API key info

AggregatorRequired

Only registered aggregators can get API key info

AggregatorNotFound

Aggregator not found

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • social.coves.aggregator.createApiKey

    procedure

    Create an API key for the authenticated aggregator. Requires OAuth authentication. The API key is returned ONCE and cannot be retrieved again. Store it securely.

  • social.coves.aggregator.revokeApiKey

    procedure

    Revoke the authenticated aggregator's API key. After revocation, the aggregator must complete OAuth flow again to create a new API key. This action cannot be undone.

  • dev.cocore.account.listApiKeys

    query

    List every API key belonging to the authenticated account, most-recently-created first. The owning DID is derived from the credential presented (session cookie or `Authorization: Bearer cocore-...`); there is no way to list another account's keys. Secrets are never returned — see `apiKeyView`.