Skip to navigation
Sigma REST APIJWK sets{jwkSetId}{jsonWebKeyId}

Activate a JSON Web Key

View as Markdown

Make the given JSON Web Key the active key for its set, deactivating whichever key previously held that role. Does not delete the previously active key. Remove it separately once its rotation overlap window has passed. Returns the now-active key.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • jsonWebKeyId must belong to the jwkSetId in the path.

Usage scenarios

  • Key rotation: Switch signing over to a newly created key once it has propagated.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

jwkSetIdstringRequired
Unique identifier of the JWK set.
jsonWebKeyIdstringRequired
Unique identifier of the JSON Web Key.

Request

The request body.

Response

The response body.
jsonWebKeyIdstring
Unique identifier of the JSON Web Key.
jwkSetIdstring
Unique identifier of the JWK set this key belongs to.
algorithmenum
Signing algorithm this key was generated for.
Allowed values:
publicKeystring

PEM-encoded X.509 certificate wrapping the public key. Never includes private key material.

expiresAtdatetime
Expiration timestamp of the underlying certificate.
statusenum

active if this is the key currently used to sign JWT bearer tokens for the set, otherwise inactive.

Allowed values: