Auth

Issue a short-lived elevated-permission token after password re-entry

Send the returned token as X-Step-Up-Token on the one request it is for: it is honoured once, expires after 5 minutes, and only works with the API key that requested it. compliance:d allows a right-to-erasure call. api_keys:elevate allows creating or rotating a key with permissions beyond the calling key's.

post/v1/auth/step-up

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/auth/step-up
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

passwordstring required
scope'compliance:d' | 'api_keys:elevate' required

Response

A single-use token for the X-Step-Up-Token header, valid for 5 minutes with the key that requested it.

tokenstring required
scope'compliance:d' | 'api_keys:elevate' required
expires_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.