Get Enrolled MFA Factors Using a Filter
get
/mfa/v1/users
Request
Supported Media Types
- application/json
Query Parameters
-
attributes: string
Defines what attributes should be returned in the response. The only value supported is 'factors'.
-
userId: string
The value to uniquely identify a user, which can be either the user name or the user GUID.
-
userIdType(optional): string
The attribute that describes what type of user ID was supplied. This can either be USER_NAME or USER_GUID. USER_NAME is the attribute automatically used if no attribute is supplied.
Header Parameters
-
Authorization: string
Provide a valid OAuth Access Token that has the 'Authenticator Client' or 'MFA Client' scope.
Response
Supported Media Types
- application/json
200 Response
Example Response (application/json)
{
"status":"success",
"userGUID":"cc327268ff4d4e4a9b3e9f676215cfc7",
"factors":[
{
"displayName":"tom's Phone-1",
"factorId":"006f15bf5778544c3ae2236c5fca9d9e8",
"methods":[
"TOTP",
"PUSH"
]
},
{
"displayName":"91******003",
"factorId":"0778f15bf5778544c3ae2236c5fca9d9e8",
"methods":[
"SMS"
]
},
{
"displayName":"91******023",
"factorId":"0778f15bf5778544c3ae2236c5fc32539e8",
"methods":[
"PHONE_CALL"
]
},
{
"displayName":"Tom's IPhone 2",
"factorId":"0878f15bf5778544c3ae2236c5fca9d9e8",
"methods":[
"TOTP"
]
},
{
"factorId":"SecurityQuestions",
"methods":[
"SECURITY_QUESTIONS"
]
},
{
"factorId":"BypassCode",
"methods":[
"BYPASSCODE"
]
}
],
"preferredFactorId":"0778f15bf5778544c3ae2236c5fca9d9e8",
"preferredMethod":"SMS"
}