UserService_ListAuthenticationFactors

POST 
/v2/users/:userId/authentication_factors/_search

UserService_ListAuthenticationFactors

Request

Path Parameters

userId stringrequired

Query Parameters

authFactors string[]

Possible values: [OTP, OTP_SMS, OTP_EMAIL, U2F]

Specify the Auth Factors you are interested in

states string[]

Possible values: [AUTH_FACTOR_STATE_UNSPECIFIED, AUTH_FACTOR_STATE_NOT_READY, AUTH_FACTOR_STATE_READY, AUTH_FACTOR_STATE_REMOVED]

Specify the state of the Auth Factors

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

TOTP second factor

u2f

object

U2F second factor

id string

name string

otpSms object

SMS second factor

otpEmail object

Email second factor

]

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

TOTP second factor

u2f

object

U2F second factor

id string

name string

otpSms object

SMS second factor

otpEmail object

Email second factor

]

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

TOTP second factor

u2f

object

U2F second factor

id string

name string

otpSms object

SMS second factor

otpEmail object

Email second factor

]

Example (from schema)

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

403

Returned when the user does not have permission to access the resource.

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

404

Returned when the resource does not exist.

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

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...