ZITADEL Docs
APIsCore ResourcesV2Web Key

ActivateWebKey

Activate Web Key

Switch the active signing web key. The previously active key will be deactivated. Note that the JWKs OIDC endpoint returns a cacheable response. Therefore it is not advised to activate a key that has been created within the cache duration (default is 5min), as the public key may not have been propagated to caches and clients yet.

Required permission:

  • iam.web_key.write
POST
/zitadel.webkey.v2.WebKeyService/ActivateWebKey

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

id*string

The unique identifier of the key to activate.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.webkey.v2.WebKeyService/ActivateWebKey" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
{
  "changeDate": "1s"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?