Lexicon Garden

social.coves.aggregator.revokeApiKey

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.

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

Procedure

procedure · POST

Input

application/json

Output

application/json

revokedAt

requiredstring · datetime

ISO8601 timestamp when the key was revoked

Errors

AuthenticationRequired

Authentication is required to revoke an API key

AggregatorRequired

Only registered aggregators can revoke API keys

AggregatorNotFound

Aggregator not found

ApiKeyNotFound

No API key exists to revoke

ApiKeyAlreadyRevoked

API key has already been revoked

RevocationFailed

Failed to revoke the API key

Similar lexicons

semantic match

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

  • dev.cocore.account.revokeApiKey

    procedure

    Revoke one of the authenticated account's API keys. The key stops authenticating immediately, but the row is retained with `revokedAt` set so it stays visible in listApiKeys as a revoked key (audit trail). Use deleteApiKey to remove it entirely. Scoped to the caller's DID — you cannot revoke another account's key. Idempotent: revoking an already-revoked or unknown key returns `revoked: false`.

  • dev.cocore.account.deleteApiKey

    procedure

    Hard-delete one of the authenticated account's API keys, removing the row entirely (no audit trail recovery afterwards). For most flows revokeApiKey is preferable; use this to clean up revoked or expired keys you no longer want listed. Scoped to the caller's DID. Idempotent: deleting an unknown key returns `deleted: false`.

  • social.coves.aggregator.getApiKey

    query

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

  • 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.

  • link.latr.developer.revokeKey

    procedure

    L@tr XRPC method link.latr.developer.revokeKey.