Skip to main content

Get User Authentication Factors (2FA/MFA)

POST 

/users/:userId/auth_factors/_search

Get a list of authentication factors the user has set. Including Second-Factors (2FA) and Multi-Factors (MFA).

Request

Path Parameters

    userId stringrequired

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, OTPSMS, OTPEmail or U2F

    u2f

    object

    one type use OTP, OTPSMS, OTPEmail or U2F

    id string
    name string
    otpSms object

    one type use OTP, OTPSMS, OTPEmail or U2F

    otpEmail object

    one type use OTP, OTPSMS, OTPEmail or U2F

  • ]

Loading...