---
title: "POST /api/tfa"
method: POST
path: "/api/tfa"
tags: ["TFA"]
---

# POST /api/tfa

`POST /api/tfa`

## Request body

- TFARequest
  - `userName` string, required
  - `password` string, required
  - `authKey` string, required
  - `tfaCode` string, required
  - `authMode` string, required
  - `clientId` string, required
  - `rememberMe` string, nullable
  - `captchaText` string, nullable
  - `TFAID` string, nullable
  - `redirectUrl` string, nullable
  - `gbSid` string, nullable

## Response `200`

Success

- GetAuthTokenResponse
  - `content` AuthToken
    - `userType` string, nullable
    - `token` string, nullable
    - `refreshToken` string, nullable
    - `userName` string, nullable
    - `givenName` string, nullable
    - `emailAddress` string, nullable
    - `roles` string[], nullable
    - `sId` string, nullable
    - `TFA` string, nullable
    - `deviceCode` string, nullable
    - `defaultApplication` string, nullable
    - `isFreeTrial` boolean
    - `isSubUser` string, nullable
    - `showRegisterPopup` boolean
    - `showRememberMe` boolean
    - `isHighLighter` boolean
    - `isLargeCustomer` string, nullable
    - `forcetosetTFA` string, nullable
    - `declineTFA` string, nullable
    - `isTFACaptchaNeeded` string, nullable
    - `sendTFAsms` string, nullable
    - `TFAID` string, nullable
    - `captchDetail` string, nullable
    - `captchBaseString` string, nullable
    - `accessCode` string, nullable
    - `changePassword` string, nullable
    - `isShowPrefMigration` string, nullable
  - `operationStatus` string, nullable
  - `msgCode` string, nullable
  - `msgId` string, nullable
  - `msgDesc` string, nullable

---

[API](https://skmtc.dev/mysonicwall/apis/restapi-core-v1.md) · [All operations](https://skmtc.dev/mysonicwall/apis/restapi-core-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mysonicwall/restapi-core-v1/revisions/ddffed195eba/schema)