Skip to navigation
Sigma REST APIJWK sets

Create a JWK set with an active key

View as Markdown

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

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

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: