---
title: "Get platform 2FA settings (getPlatformTwoFaSettings)"
method: GET
path: "/api/2fa/settings"
tags: ["two-factor-auth-config-controller"]
---

# Get platform 2FA settings (getPlatformTwoFaSettings)

`GET /api/2fa/settings`

Get platform settings for 2FA. The settings are described for savePlatformTwoFaSettings API method. If 2FA is not configured, then an empty response will be returned.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

## Response `200`

OK

- PlatformTwoFaSettings — Settings value
  - `providers` union[], required
    - union
      - BackupCodeTwoFaProviderConfig
        - `providerType` string, required
        - `codesQuantity` integer
      - EmailTwoFaProviderConfig
        - `providerType` string, required
        - `verificationCodeLifetime` integer
      - SmsTwoFaProviderConfig
        - `providerType` string, required
        - `verificationCodeLifetime` integer
        - `smsVerificationMessageTemplate` string, required
      - TotpTwoFaProviderConfig
        - `providerType` string, required
        - `issuerName` string, required
  - `minVerificationCodeSendPeriod` integer, required
  - `verificationCodeCheckRateLimit` string
  - `maxVerificationFailuresBeforeUserLockout` integer
  - `totalAllowedTimeForVerification` integer, required
  - `enforceTwoFa` boolean
  - `enforcedUsersFilter` unknown

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)