Users

Enable TOTP multi-factor authentication

Changed on

Enable time-based one-time password (TOTP) MFA on the current account. Returns backup codes for account recovery. Requires sudo mode verification.

post/users/@me/mfa/totp/enable

Request

Request body

secretstring required

The TOTP secret key

codestring required

The TOTP verification code

passwordstring
mfa_method'totp' | 'webauthn' | 'email_code'

MFA method to use for verification

mfa_codestring

MFA verification code from an authenticator app

email_code_ticketstring

Ticket from POST /users/@me/sudo/email-code, sent with mfa_method email_code

email_codestring

The 6-digit code from the email, sent with mfa_method email_code

webauthn_challengestring

WebAuthn challenge string

Response

Success

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new email_code enum value to the request property

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    This list may be incomplete.