Get 2FA

GET 
/v1/settings/active-2fa

Get 2FA

This endpoint retrieves the active two-factor authentication methods associated with a user. It returns a JSON object containing details about the software-based and hardware-based two-factor authentication methods that are currently enabled for the user. This includes identifiers, names, verification status for software-based methods, and creation timestamps. The endpoint responds with HTTP status codes 200 if any authenticators are found, 204 if none are found, and 500 for internal server errors.

Responses

200

Two factor authenticators found

application/json

Schema

Schema

hardware2fa object[]required
Array [
createdAt date-timerequired
id uuidrequired
name stringnullable
]
software2fa objectnullable
createdAt date-timerequired
id uuidrequired
name stringnullable
verified booleannullable

Example (from schema)

{
  "hardware2fa": [
    {
      "createdAt": "2024-09-25T19:42:12.624Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ],
  "software2fa": {
    "createdAt": "2024-09-25T19:42:12.624Z",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "verified": true
  }
}

204

No two factor authenticators found

application/json

Schema

Schema

hardware2fa object[]required
Array [
createdAt date-timerequired
id uuidrequired
name stringnullable
]
software2fa objectnullable
createdAt date-timerequired
id uuidrequired
name stringnullable
verified booleannullable

Example (from schema)

{
  "hardware2fa": [
    {
      "createdAt": "2024-09-25T19:42:12.624Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ],
  "software2fa": {
    "createdAt": "2024-09-25T19:42:12.624Z",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "verified": true
  }
}

500

Internal server error

text/plain

Schema

Schema

string

Loading...