PApallets-eco

Request help.

Changed on
post/tf-rescue

Request

  • The document declares no server URL.
  • Auth
    none declared

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
  }
}

Changes

  • b647a0e917e6Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 4b3ea48a957aRevision changes
    • breaking

      the // response's property type changed from object to array for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property // became required for the status