SelfMFA

verifyTwoFactor

POST
/api/v1/self/two_factor/verify

Verify Two-factor (OTP)

To verify two-factor authentication by using a code generated by app (e.g. Google Authenticator, Authy). Upon successful verification, the two_factor_passed will be set to true if it hasn’t already been.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Request Body

application/json

Request Body

Request body for verifying a 2FA one-time password

two_factor*string

One-time password generated by the user's authenticator app

Response Body

curl -X POST "https://example.com/api/v1/self/two_factor/verify" \  -H "Content-Type: application/json" \  -d '{    "two_factor": "123456"  }'
Empty