Activate a key collection version

Deploys the version of a key collection in the staging or production environment. Note that a key collection uses the public keys from its active version to validate JWTs in client requests. See API concepts.

Recipes
Activate a key collection version
Open Recipe
Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
string
required
length ≥ 1

The environment where you want to activate the version of the key collection, either STAGING or PRODUCTION.

integer
required
≥ 1

Identifies the key collection version to activate.

Responses

Response body
object
string
required
length ≥ 1

The username who sent the activation request.

string
required
length ≥ 1

The environment where you're activating the key collection version, either STAGING or PRODUCTION.

STAGING PRODUCTION

integer
required
≥ 1

The identifier of the activation.

integer
required
≥ 1

The identifier of the key collection version that you're activating.

integer
required
≥ 1

The number of the version within the key collection. With each new version of this key collection, this number increments by 1.

integer
required
≥ 0

An epoch timestamp when the activation started.

string
required
length ≥ 1

The status of the activation across the platform. These values are available: PREPARED when the system is ready to propagate the activation, IN_PROGRESS when the system is already propagating the activation, DONE when the system has successfully propagated the activation, NOT_AVAILABLE when the system has been unable to access data for the activation, or ERROR when the system has failed to propagate the activation. To fix the ERROR and NOT_AVAILABLE states, send another activation request. If it fails, contact support.

PREPARED IN_PROGRESS DONE NOT_AVAILABLE ERROR

Accept header.

Language
Authentication
URL