SIsigmacomputing
jwkSets

Create a JSON Web Key

Generate a new RS256 key pair for a JWK set and inserts it as an inactive key.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • A set may hold at most two keys at a time. Delete an existing key before creating a new one.
  • The response never includes private key material.

Usage scenarios

  • Key rotation: Stage a new key ahead of an upcoming rotation window.
post/v2/jwkSets/{jwkSetId}/jsonWebKeys

Request

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

Path parameters

jwkSetIdstring required

Unique identifier of the JWK set.

Request body

validForDaysnumber double

Number of days the generated certificate is valid for. Must be a positive integer. Defaults to 365.

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.