Multi-factor status

GET

/api/v1/mfa

curl --request GET \
  --url https://osctrl.net/api/v1/mfa

Returns the second factors enrolled on the calling account.

Responses

200

OK

Media typeapplication/json

object

credentials

Array<object>

object

created_at

string

id

string

last_used_at

string

name

string

recovery_codes_left

integer

required

Required mirrors the deployment-wide switch so the profile page can explain why a factor cannot be removed.

boolean

totp_enabled

boolean

webauthn_available

boolean

Example^generated

{
  "credentials": [
    {
      "created_at": "example",
      "id": "example",
      "last_used_at": "example",
      "name": "example"
    }
  ],
  "recovery_codes_left": 1,
  "required": true,
  "totp_enabled": true,
  "webauthn_available": true
}

401

Unauthorized

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"
}