Register software 2FA

POST 
/v1/settings/sw-2fa-registration

Register software 2FA

This endpoint initiates the registration process for software-based two-factor authentication (2FA) for a user. It generates a unique secret key and returns a URL for setting up the 2FA application along with the secret key. This endpoint ensures that a user does not have an existing software 2FA setup before proceeding.

Responses

200

Start SW 2FA registry process

application/json

Schema

Schema

auth_url stringrequired
secret stringrequired
twofa_id uuidrequired

Example (from schema)

{
  "auth_url": "string",
  "secret": "string",
  "twofa_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

409

Already has software 2FA, only one permitted

text/plain

Schema

Schema

string

500

Internal server error

text/plain

Schema

Schema

string

Loading...