v1

latestOpenAPI 3.0.3MIT2026-07-176638100.8 KB

Request help.

post/tf-rescue

Request body

help_setup'help' | 'email' | 'recovery_code'

What rescue option is desired.

Example request

{
  "help_setup": "recovery_code"
}

Response

If 'email' was specified and SECURITY_TWO_FACTOR_RESCUE_EMAIL is True, then an authentication code was sent to the email on record for the user. If 'help' then an email was sent to administrator address specified by SECURITY_TWO_FACTOR_RESCUE_MAIL. If 'recovery_code' was specified and SECURITY_MULTI_FACTOR_RECOVERY_CODES is True, and the user had previously setup and downloaded a set of recovery codes the user will be redirected to SECURITY_MULTI_FACTOR_RECOVERY_URL.

Example response

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