Skip to main content
POST/crypto/federation-keys/revoke

Revoke Federation Keys

Revokes every federation signing key of the project: tokens already issued stop verifying once your cloud's cached copy of the key set expires, and the next token is signed with a new key under the same issuer URL.

Requires a project admin's session and a step-up; audited.

Parameters
projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
401K9O_UNAUTHENTICATEDThe caller is not authenticated.
401K9O_STEP_UP_REQUIREDRevoking needs a fresh step-up.
403K9O_EXTENSION_PERMISSION_DENIEDExtensions use k9o.kibo, not the crypto resource.
403K9O_RBAC_DENYOnly a project admin's session can revoke the federation keys.
503K9O_KEY_SERVICE_UNAVAILABLEThe key service could not revoke; nothing changed.
Response body (200)
data *object

The outcome of the revocation.

revokedKids *string[]

The key ids of the project's federation signing keys that were revoked.

A key stops being published in the project's federation key set.

Empty when the project had no federation key.

The next token issued creates a fresh key.

meta *any
cURL
curl -X POST 'https://<org>.api-<region>.k9o.io/@storefront/crypto/federation-keys/revoke' \
  -H 'Authorization: Bearer $K9O_TOKEN'

Showing example in cURL

Response example (200)
{
  "data": {
    "revokedKids": [
      "string"
    ]
  }
}

More in Encryption