See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Multi-Factor Auth >
  5. Get Enrolled Authentication Factors

Get Enrolled Authentication Factors

Use this API to return a list of authentication factors registered to a particular user for multifactor authentication (MFA).

This API is typically used in a login workflow in which MFA is required, providing the user a selection of their registered MFA devices to choose from. The returned list represents the authentication factors that have been registered by the user on their Profile page or on the OneLogin login page or custom login page.

This API only returns factors that are enrolled and can be verified via API.

Resource URL

https://<subdomain>/api/2/mfa/users/<user_id>/devices

Header Parameter

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using the Manage users scope.

Resource Parameter

user_id

required

integer

Set to the id of the user.

If you don’t know the user’s id, use the Get Users API call to return all users and their id values.

Sample Response

  • 200 OK
  • 401 Unauthorized
[
  {
      "device_id": "3920360",
      "user_display_name": "OneLogin Protect",
      "type_display_name": "OneLogin Protect",
      "auth_factor_name": "OneLogin",
      "default": true
  },
  {
      "device_id": "3920371",
      "user_display_name": "OneLogin SMS",
      "type_display_name": "OneLogin SMS",
      "auth_factor_name": "SMS",
      "default": false
  },
  {
      "device_id": "3920373",
      "user_display_name": "OneLogin Voice",
      "type_display_name": "OneLogin Voice",
      "auth_factor_name": "OneLogin Voice",
      "default": false
  },
  {
      "device_id": "3920377",
      "user_display_name": "OneLogin Email",
      "type_display_name": "OneLogin Email",
      "auth_factor_name": "OneLogin Email",
      "default": false
  },
  {
      "device_id": "3920481",
      "user_display_name": "Authenticator",
      "type_display_name": "Authenticator",
      "auth_factor_name": "Google Authenticator",
      "default": false
  }
]
{
    "statusCode": 401,
    "name": "InvalidCredentials",
    "message": "Please provide valid credentials"
}

Response Elements

auth_factor_name Authentication factor name, as it appears to administrators in OneLogin.
default true = is user’s default MFA device for OneLogin.
display_name Authentication factor display name as it appears to users, as defined in the admininstrative interface at Settings > Authentication Factors.
id MFA device identifier.
type_display_name Authentication factor display name as it appears to users upon initial registration, as defined by admins at Settings > Authentication Factors.
user_display_name Authentication factor display name assigned by users when they register the device.

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

curl 'https://<subdomain>/api/2/mfa/users/<user_id>/devices' \
-X GET \
-H "Authorization: bearer: <access_token>" \

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.