THthingsboard
two-factor-auth-controller

Check 2FA verification code (checkTwoFaVerificationCode)

Checks 2FA verification code, and if it is correct the method returns a regular access and refresh token pair.

The API method is rate limited (using rate limit config from TwoFactorAuthSettings), and also will block a user after X unsuccessful verification attempts if such behavior is configured (in TwoFactorAuthSettings).

Will return a Bad Request error if provider is not configured for usage, and Too Many Requests error if rate limits are exceeded.

post/api/auth/2fa/verification/check

Request

Query parameters

providerType'TOTP' | 'SMS' | 'EMAIL' | 'BACKUP_CODE' required
verificationCodestring required

Response

OK

tokenstring

The JWT Access Token. Used to perform API calls.

refreshTokenstring

The JWT Refresh Token. Used to get new JWT Access Token if old one has expired.

scope'SYS_ADMIN' | 'TENANT_ADMIN' | 'CUSTOMER_USER' | 'REFRESH_TOKEN' | 'PRE_VERIFICATION_TOKEN' | 'MFA_CONFIGURATION_TOKEN'

Example response

{
  "token": "AAB254FF67D..",
  "refreshToken": "AAB254FF67D.."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.