Begin enrollment during login

POST

/api/v1/login/mfa/enroll/begin

curl --request POST \
  --url https://osctrl.net/api/v1/login/mfa/enroll/begin \
  --header 'Content-Type: application/json' \
  --data '{ "challenge": "example", "code": "example" }'

Returns a TOTP secret for a user who must enroll before logging in.

Request Body^required

Request body

Media typeapplication/json

object

challenge

string

code

string

Example^generated

{
  "challenge": "example",
  "code": "example"
}

Responses

200

OK

Media typeapplication/json

object

qr

QR is the provisioning URI as a PNG data URI, ready for an .

string

secret

string

uri

string

Example^generated

{
  "qr": "example",
  "secret": "example",
  "uri": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}