See api-docs Menu

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.

Early Preview

This API is in early preview and may be subject to change. Please refer to our V1 API for current production use.

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

Resource URL

https://<api-domain>/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 any one of the following scopes: Read Users, Manage users, Read All, or Manage All.

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

[
  {
      "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

Replace sample variables indicated by {{ }} with your actual values.

Download for the MFA API

Sample Code

cURL

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

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

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

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

StackOverflow discussions about "[onelogin] mfa api"

  • 9
    Votes
    2
    Answers

    Q: AWS API credentials with OneLogin SAML and MFA

    Asked Oct 30 2016

    We want to allow our users to retrieve a set of temporary CLI credentials for a given AWS role by signing in to OneLogin with password and MFA. … We have a working solution, but it requires the user to fully re-authenticate to OneLogin (including MFA) every 60 minutes as the AWS temporary credentials expire. …

  • 2
    Votes
    1
    Answers

    Q: Implement custom connector to in-house applications

    Asked Dec 05 2016

    Basically the company I work at wants to implement a "login using OneLogin" to our in-house applications and we have MFA enabled. … I tried the API route but it requires the user to enter the MFA code every time they want to log in, which is great for security but users want simple solution. …

  • 1
    Votes
    1
    Answers

    Q: Getting a SAML assertion after creating a session via API

    Asked Apr 04 2017

    Related to Accessing Third Party Apps After Creating A Session Via API Token and to AWS API credentials with OneLogin SAML and MFA Since AWS assumeRoleWithSAML temporary security credentials are only … It's totally odd to the web base OneLogin usage, where he is logged in once for the whole day or even week (depending on the policy). I know how to get a session via API. …

  • 1
    Votes

    A: Getting a SAML assertion after creating a session via API

    Answered Apr 05 2017

    The "assume user" privilege is locked down pretty tightly in OneLogin, and is not the sort of thing that's given out lightly. … This wouldn't allow for MFA on an app policy, but we are building out the ability to request and verify MFA via API (coming soon) so you could implement MFA in your app (independent of any app policy) …

  • 1
    Votes
    2
    Answers

    Q: Onelogin API - Verify Factor for SAML assertion when using Duo

    Asked Oct 11 2017

    I've been developing an application that hits the api/1/saml_assertion, https://developers.onelogin.com/api-docs/1/saml-assertions/generate-saml-assertion , endpoint of OneLogin with Duo as my MFA. … duo_sig_request looks like this: 'duo_sig_request': 'TX|<base64 encoded elements>|<what looks like a sha1 hash>:APP|<base64 encoded elements>|<what looks like a sha1 hash>' duo_api_hostname is just the API …

Loading...