Two Factor Auth

GET

Generates a QR code for enabling two-factor authentication.

get

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/2fa/generate-qr'

200

400

200

{
  "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "link": "otpauth://totp/AppName:[e-mail]?secret=JBSWY3DPEHPK3PXP&issuer=AppName"
}

QR code generated successfully

POST

Enables two-factor authentication for the user.

post

Body

codestringrequired

Two-factor authentication code

Example: 123456

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/2fa/enable-two-factor-auth' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "123456"
  }'

200

400

500

200

{
  "message": "Two-factor authentication enabled successfully",
  "description": "Two-factor authentication has been enabled for your account."
}

Two-factor authentication enabled successfully

Disables two-factor authentication for the user.

post

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/2fa/disable-two-factor-auth'

200

500

200

{
  "message": "Two-factor authentication disabled successfully",
  "description": "Two-factor authentication has been disabled for your account."
}

Two-factor authentication disabled successfully

Authenticates the user using two-factor authentication code.

post

Body

codestringrequired

Two-factor authentication code

Example: 123456

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/2fa/authenticate' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "123456"
  }'

200

400

500

200

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

Authentication successful

Impersonates another user using two-factor authentication code. This endpoint is only available for admins of support team.

post

Body

userIdnumberrequired

Example: 1

teamIdnumberrequired

Example: 1

codestringrequired

Example: 123456

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/2fa/impersonate' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": 1,
    "teamId": 1,
    "code": "123456"
  }'

200

400

403

404

500

200

{
  "accessToken": "access_token",
  "isTwoFactorEnable": false
}

Impersonation successful

Cancels the impersonation and returns the original user's tokens.

post

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/2fa/desimpersonation'

200

403

404

500

200

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token"
}

Impersonation cancelled successfully