Get Enrolled MFA Factors Using the User GUID

get

/mfa/v1/users/{userGUID}/factors

Request

Supported Media Types
Path Parameters
Header Parameters
  • Provide a valid OAuth Access Token that has the 'Authenticator Client' or 'MFA Client' scope.
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "status":"success",
    "userGUID":"cc327268ff4d4e4a9b3e9f676215cfc7",
    "factors":[
        {
            "displayName":"tom's Phone-1",
            "factorId":"06f15bf5778544c3ae2236c5fca9d9e8",
            "methods":[
                "TOTP",
                "PUSH"
            ]
        },
        {
            "displayName":"91******003",
            "factorId":"0778f15bf5778544c3ae2236c5fca9d9e8",
            "methods":[
                "SMS"
            ]
        },
        {
            "displayName":"91******0123",
            "factorId":"0778f15bf5778544c3af21336c5fca9d9e8",
            "methods":[
                "PHONE_CALL"
            ]
        },
        {
            "displayName":"91******0143",
            "factorId":"0778f15bf5778544c3af21336c523459d9e8",
            "methods":[
                "SMS",
                "PHONE_CALL"
            ]
        },
        {
            "displayName":"Tom's IPhone 2",
            "factorId":"0878f15bf5778544c3ae2236c5fca9d9e8",
            "methods":[
                "TOTP"
            ]
        },
        {
            "factorId":"SecurityQuestions",
            "methods":[
                "SECURITY_QUESTIONS"
            ]
        },
        {
            "factorId":"BypassCode",
            "methods":[
                "BYPASSCODE"
            ]
        }
    ],
    "preferredFactorId":"0778f15bf5778544c3ae2236c5fca9d9e8",
    "preferredMethod":"SMS"
}
Back to Top