POST /v1/kms/issuers

Create a new KMS issuer for the authenticated team. An issuer owns the asymmetric signing keys that are used to sign tokens and messages.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
name String Yes

The name of the issuer.

algorithm String No

The signing algorithm to use for the issuer. EdDSA is not accepted for new issuers.

Valid values:

  • "ES512"
  • "PS512"
  • "RS512"
  • "PS256"
  • "ES256"
  • "RS256"
  • "ES384"
  • "PS384"
  • "RS384"

Default value: "RS512"

importKeyId String No

The key id to use as the imported key's JWT/JWKS kid. Only allowed when importKey is provided. Not required to be unique; the addressable key id is the server-minted keyId returned in the response.

policy No
claimsSchema Object No

A JSON Schema used to validate the resolved token claims when signing tokens for this issuer.

importKey String No

The PEM-encoded private key to use for the issuer.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.