v1

latestOpenAPI 3.0.3MIT2026-07-176638100.8 KB

Unified sign in setup.

An authenticated user can call this endpoint to update or add additional methods for authenticating (e.g. sms, authenticator app). This is controlled by application configuration settings SECURITY_US_ENABLED_METHODS. This endpoint is protected by a 'freshness' check - meaning the caller will be required to have authenticated recently. In addition, to ensure correctness, the newly setup method must be verified by sending and entering a code prior to it being permanently stored. This verification process is also time-limited.

post/us-setup

Request body

chosen_methodstring

which method should be used to send the code, as configured with SECURITY_US_ENABLED_METHODS

delete_methodstring

which previously set up method should be deleted.

phonestring

phone number (this will be normalized). Required if chosen_method == "sms".

Response

Unified sign in setup response.

Example response

{
  "meta": {
    "code": 200
  }
}