latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

two-factor-auth-config-controller

Submit 2FA account config (submitTwoFaAccountConfig)

Submit 2FA account config to prepare for a future verification. Basically, this method will send a verification code for a given account config, if this has sense for a chosen 2FA provider. This code is needed to then verify and save the account config.

Example of EMAIL 2FA account config:

{
  "providerType": "EMAIL",
  "useByDefault": true,
  "email": "separate-email-for-2fa@thingsboard.org"
}

Example of SMS 2FA account config:

{
  "providerType": "SMS",
  "useByDefault": false,
  "phoneNumber": "+38012312321"
}

For TOTP this method does nothing.

Will throw an error (Bad Request) if submitted account config is not valid, or if the provider is not configured for usage.

Available for any authorized user.

post/api/2fa/account/config/submit

Request body

OR
OR
OR

Response

OK