Skip to main content

List Authentication Factors

POST 
https://$CUSTOM-DOMAIN/auth/v1/users/me/auth_factors/_search

Returns a list of possible authentication factors, multi-factor (MFA), second factor (2FA)

Responses​

A successful response.

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

  • ]

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/auth_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/auth/v1
Auth
ResponseClear

Click the Send API Request button above and see the response here!