Skip to main content

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.

Responses

OK


Schema
  • result object[]
  • Array [
  • state string

    Possible 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 object

    one type use OTP or U2F

  • u2f object

    one type use OTP or U2F

  • id string
  • name string
  • ]
POST /users/:userId/auth_factors/_search

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
userId — path required
x-zitadel-orgid — header
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/:userId/auth_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'