Skip to content
Navigation

Promotes the store's next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with `retire_previous` every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With `current`, a rotation since answers `conflict`. A store with no keys gets its first set.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/license_signing_keys/rotate

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON optional

  • current
    optional

    The key that signs now, as you last read it, or null for a store with none; a rotation since answers conflict on revision, so a retry never rotates twice.

    One of the following:

    • object
    • null
  • retire_previous
    optional
    boolean

    Drop every key that no longer signs from the published set at once, as after a leak; sets fetched from then on leave them out. Defaults to false.

Returns

200

Promotes the store's next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with retire_previous every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With current, a rotation since answers conflict. A store with no keys gets its first set.

JSON
  • keys
    array of
    object
    required
    • kid
      string
      required
    • kty
      string
      required
    • crv
      string
      required
    • x
      string
      required

      The raw 32-byte public key, base64url, as a JWK's x.

    • alg
      string
      required
    • use
      string
      required
    • status
      string
      required

      current signs new tokens; next signs once the keys rotate; previous signs nothing more and stays published while a token it signed may live.

    • created_at
      string
      required
    • expires_at
      required

      When it leaves the set, as the longest offline window after it stopped signing; null while it signs or waits to.

      One of the following:

      • string
      • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close