SIsigmacomputing
jwkSets

Activate a JSON Web Key

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.
post/v2/jwkSets/{jwkSetId}/jsonWebKeys/{jsonWebKeyId}:activate

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

jwkSetIdstring required

Unique identifier of the JWK set.

jsonWebKeyIdstring required

Unique identifier of the JSON Web Key.

Request body

object required

Response

The response body.

jsonWebKeyIdstring required

Unique identifier of the JSON Web Key.

jwkSetIdstring required

Unique identifier of the JWK set this key belongs to.

algorithm'RS256' | 'ES256' required

Signing algorithm this key was generated for.

publicKeystring required

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

expiresAtstring date-time required

Expiration timestamp of the underlying certificate.

status'active' | 'inactive' required

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

Changes

No recorded changes to this operation across all 1 revision of this API.