Create a key collection version

post

https://{hostname}/jwt-api/v1/key-collections/{collectionId}/versions

Creates a version of the key collection. Use it to provide primary and secondary public keys to verify JWTs passed in client requests. If you don't already have the collectionId, run the List key collections operation and use the appropriate id value from the returned array. Also, to start using the public keys on staging or production, run the Activate this key collection version operation.

Path Params

collectionId

integer

required

The identifier of the key collection.

Query Params

accountSwitchKey

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

Contains information that you need to provide when creating a key collection version.

description

string

length ≥ 1

A descriptive label for the key collection version.

primaryKey

string

required

length ≥ 1

The primary public key that you want to use to validate JWT signatures. You can use an RSA key that's between 1024 and 4096 bits long, an ECDSA key that uses the P-256 (secp256k1) curve. Use a key in PEM format, which presents base64-encoded data between the begin header and the end footer. Make sure to use the same encryption algorithm for the public keys in the primaryKey and secondaryKey members, either RSA or ECDSA_P_256. See Keys and JWT signing algorithms.

secondaryKey

string

length ≥ 1

The secondary public key that you want to use to validate JWT signatures in case primaryKey fails. You can use an RSA key that's between 1024 and 4096 bits long, an ECDSA key that uses the P-256 (secp256k1) curve. Use a key in PEM format, which presents base64-encoded data between the begin header and the end footer. Make sure to use the same encryption algorithm for the public keys in the primaryKey and secondaryKey members, either RSA or ECDSA_P_256. See Key rotation and Keys and JWT signing algorithms.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response.

400Bad request. Request is badly formed or has constraint violations.

401Unauthorized.

403Forbidden. Not authorized to access the data that the request was made against.

404Not found. Requested resource not found.

405Method Not Allowed. Invalid method used to access resource.

406Not Acceptable. Wrong Accept header.

415Unsupported Media Type. Use the valid content type request body.