List Multi Factors (MFA)​
Returns a list of multi factors (MFA) configured on the login settings of the instance. It affects all organizations, without custom login settings. 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.
- 200
- 403
- 404
- default
multi factors of default login policy
Schema
details object
Possible values: [MULTI_FACTOR_TYPE_UNSPECIFIED
, MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-05-24T19:39:30.874Z"
},
"result": [
"MULTI_FACTOR_TYPE_UNSPECIFIED"
]
}
Schema
details object
Possible values: [MULTI_FACTOR_TYPE_UNSPECIFIED
, MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-05-24T19:39:30.875Z"
},
"result": [
"MULTI_FACTOR_TYPE_UNSPECIFIED"
]
}
Schema
details object
Possible values: [MULTI_FACTOR_TYPE_UNSPECIFIED
, MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-05-24T19:39:30.875Z"
},
"result": [
"MULTI_FACTOR_TYPE_UNSPECIFIED"
]
}
Returned when the user does not have permission to access the resource.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /policies/login/multi_factors/_search
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
Request
Request
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/multi_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'