/api/auth/two-factor/enable

POST

/api/auth/two-factor/enable

curl --request POST \
  --url https://example.com/api/auth/two-factor/enable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example", "issuer": "example" }'

Use this endpoint to enable two factor authentication. This will generate a TOTP URI and backup codes. Once the user verifies the TOTP URI, the two factor authentication will be enabled.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

password

required

User password

string

issuer

Custom issuer for the TOTP URI

string

Example^generated

{
  "password": "example",
  "issuer": "example"
}

Responses

200

Successful response

Media typeapplication/json

object

totpURI

TOTP URI

string

backupCodes

Backup codes

Array<string>

Example^generated

{
  "totpURI": "example",
  "backupCodes": [
    "example"
  ]
}

400

Bad Request. Usually due to missing parameters, or invalid parameters.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Forbidden. You do not have permission to access this resource or to perform this action.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

Too Many Requests. You have exceeded the rate limit. Try again later.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

Internal Server Error. This is a problem with the server that you cannot fix.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}