jwkSets

Create a JWK set with an active key

Create a JWK set and generate its first JSON Web Key as the active signing key. Returns the created key, including the new jwkSetId.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • The response never includes private key material.

Usage scenarios

  • New JWT bearer connection: Create a signing key set for a connection that uses JWT bearer authentication.
post/v2/jwkSets

Request

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

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.