List Multi Factors (MFA)
Returns a list of multi factors (MFA) configured on the login settings of the organization. Authentication factors are used as an additional layer of security for your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called multifactor factor or passwordless as it is used as first and second authentication and a password is not necessary. In the UI we generalize it as passwordless or passkey.
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
- result string[]
Possible values: [
MULTI_FACTOR_TYPE_UNSPECIFIED
,MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-10"
},
"result": [
"MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION"
]
}
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
- result string[]
Possible values: [
MULTI_FACTOR_TYPE_UNSPECIFIED
,MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-10"
},
"result": [
"MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION"
]
}
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
- result string[]
Possible values: [
MULTI_FACTOR_TYPE_UNSPECIFIED
,MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-10"
},
"result": [
"MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION"
]
}
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"
}
]
}