Get User Authentication Factors (2FA/MFA)

POST 
https://$CUSTOM-DOMAIN/management/v1/users/:userId/auth_factors/_search

deprecated

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

Deprecated: please use user service v2 ListAuthenticationMethodTypes

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

200

OK

application/json

Schema

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

]

Example (from schema)

{
  "result": [
    {
      "state": "AUTH_FACTOR_STATE_UNSPECIFIED",
      "otp": {},
      "u2f": {
        "id": "69629023906488334",
        "name": "fido key"
      },
      "otpSms": {},
      "otpEmail": {}
    }
  ]
}

application/grpc

Schema

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

]

Example (from schema)

{
  "result": [
    {
      "state": "AUTH_FACTOR_STATE_UNSPECIFIED",
      "otp": {},
      "u2f": {
        "id": "69629023906488334",
        "name": "fido key"
      },
      "otpSms": {},
      "otpEmail": {}
    }
  ]
}

application/grpc-web+proto

Schema

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

]

Example (from schema)

{
  "result": [
    {
      "state": "AUTH_FACTOR_STATE_UNSPECIFIED",
      "otp": {},
      "u2f": {
        "id": "69629023906488334",
        "name": "fido key"
      },
      "otpSms": {},
      "otpEmail": {}
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/auth_factors/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/management/v1

Auth

Bearer Token

Parameters

userId — pathrequired

x-zitadel-orgid — header

ResponseClear

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