Get MFA factors information

Returns information about the auth factors of the current user and refreshes the related session claim

PUT/{apiBasePath}/mfa/info

Authorization

AuthorizationBearer token · headerrequired

Returned as the "st-access-token" header from sign-in and refresh endpoints and present on requests that update the access token payload

sAccessTokenAPI key · cookierequired

This is an HTTPOnly cookie, set by sign-in and refresh endpoints and present on requests that update the access token

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Header parameters

ridstring

The multi factor auth recipe ID

anti-csrftoken

This will only be here if enabled by the user.

Responses

200Information about the auth factors of the current user and optionally the session with a refreshed MFA claim

One of:

object

statusstatusOK

Success status indicator

Allowed:OK

factorsobject

Show properties

alreadySetupstring[]

allowedToSetupstring[]

nextstring[]

emailsobject

Show properties

emailpasswordstring[]

otp-emailstring[]

link-emailstring[]

phoneNumbersobject

Show properties

otp-phonestring[]

link-phonestring[]

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the userridheaderThe multi factor auth recipe IDanti-csrfheaderThis will only be here if enabled by the user.

Request

curl -X PUT "/auth/mfa/info" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/auth/mfa/info", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.put(
    "/auth/mfa/info",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "status": "OK",
  "factors": {
    "alreadySetup": [
      "string"
    ],
    "allowedToSetup": [
      "string"
    ],
    "next": [
      "string"
    ]
  },
  "emails": {
    "emailpassword": [
      "string"
    ],
    "otp-email": [
      "string"
    ],
    "link-email": [
      "string"
    ]
  },
  "phoneNumbers": {
    "otp-phone": [
      "string"
    ],
    "link-phone": [
      "string"
    ]
  }
}

"Not Found"

"Internal Error"