List Authentication Factors

POST 
/users/me/auth_factors/_search

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

Responses

200

A successful response.

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"
    }
  ]
}

Loading...