Get User Authentication Factors (2FA/MFA)
Get a list of authentication factors the user has set. Including Second-Factors (2FA) and Multi-Factors (MFA).
Path Parameters
- userId string required
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization.
- 200
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
result object[]
Array [state stringPossible values: [
AUTH_FACTOR_STATE_UNSPECIFIED
,AUTH_FACTOR_STATE_NOT_READY
,AUTH_FACTOR_STATE_READY
,AUTH_FACTOR_STATE_REMOVED
]Default value:
AUTH_FACTOR_STATE_UNSPECIFIED
current state of the auth factor
otp objectone type use OTP, OTPSMS, OTPEmail or U2F
u2f object
one type use OTP, OTPSMS, OTPEmail or U2F
id stringname stringotpSms objectone type use OTP, OTPSMS, OTPEmail or U2F
otpEmail objectone type use OTP, OTPSMS, OTPEmail or U2F
]
{
"result": [
{
"state": "AUTH_FACTOR_STATE_UNSPECIFIED",
"otp": {},
"u2f": {
"id": "69629023906488334",
"name": "fido key"
},
"otpSms": {},
"otpEmail": {}
}
]
}
- Schema
- Example (from schema)
Schema
result object[]
Array [state stringPossible values: [
AUTH_FACTOR_STATE_UNSPECIFIED
,AUTH_FACTOR_STATE_NOT_READY
,AUTH_FACTOR_STATE_READY
,AUTH_FACTOR_STATE_REMOVED
]Default value:
AUTH_FACTOR_STATE_UNSPECIFIED
current state of the auth factor
otp objectone type use OTP, OTPSMS, OTPEmail or U2F
u2f object
one type use OTP, OTPSMS, OTPEmail or U2F
id stringname stringotpSms objectone type use OTP, OTPSMS, OTPEmail or U2F
otpEmail objectone type use OTP, OTPSMS, OTPEmail or U2F
]
{
"result": [
{
"state": "AUTH_FACTOR_STATE_UNSPECIFIED",
"otp": {},
"u2f": {
"id": "69629023906488334",
"name": "fido key"
},
"otpSms": {},
"otpEmail": {}
}
]
}
- Schema
- Example (from schema)
Schema
result object[]
Array [state stringPossible values: [
AUTH_FACTOR_STATE_UNSPECIFIED
,AUTH_FACTOR_STATE_NOT_READY
,AUTH_FACTOR_STATE_READY
,AUTH_FACTOR_STATE_REMOVED
]Default value:
AUTH_FACTOR_STATE_UNSPECIFIED
current state of the auth factor
otp objectone type use OTP, OTPSMS, OTPEmail or U2F
u2f object
one type use OTP, OTPSMS, OTPEmail or U2F
id stringname stringotpSms objectone type use OTP, OTPSMS, OTPEmail or U2F
otpEmail objectone type use OTP, OTPSMS, OTPEmail or U2F
]
{
"result": [
{
"state": "AUTH_FACTOR_STATE_UNSPECIFIED",
"otp": {},
"u2f": {
"id": "69629023906488334",
"name": "fido key"
},
"otpSms": {},
"otpEmail": {}
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}