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

Get Available Authentication Factors

Use this API to return a list of authentication factors that are available for user enrollment via API. This list is dependent upon the given user’s policy configuration.

Once a factor has been enrolled by a user it will no longer be returned in this request.

For a full list of factors that a user has enrolled via UI or API use the Get Enrolled Factors call.

The API supports enrollment of SMS, Voice, Email, Google Authenticator, and OneLogin Protect.

Early Preview

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

Resource URL

https://api.us.onelogin.com/api/2/mfa/users/{user_id}/factors

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

  • 200 OK
  • 401 Unauthorized
[
    {
        "factor_id": 58958,
        "name": "OneLogin Protect",
        "auth_factor_name": "OneLogin"
    },
    {
        "factor_id": 58959,
        "name": "OneLogin SMS",
        "auth_factor_name": "SMS"
    },
    {
        "factor_id": 58960,
        "name": "OneLogin Voice",
        "auth_factor_name": "OneLogin Voice"
    },
    {
        "factor_id": 58961,
        "name": "OneLogin Email",
        "auth_factor_name": "OneLogin Email"
    },
    {
        "factor_id": 58957,
        "name": "Authenticator",
        "auth_factor_name": "Google Authenticator"
    }
]

{
    "statusCode": 401,
    "name": "InvalidCredentials",
    "message": "Please provide valid credentials"
}

Response Elements

name

Authentication factor name, as it appears to administrators in OneLogin.

auth_factor_name

Internal use only
factor_id Identifier for the factor which will be used for user enrollment

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>/factors' \
-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

    fully re-authenticate to OneLogin (including MFA) every 60 minutes as the AWS temporary credentials expire. I think that won't fly - our users are accustomed to permanent API credentials tied to a … 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 …

    apiamazon-web-servicesauthenticationsamlonelogin
  • 2
    Votes
    1
    Answers

    Q: Implement custom connector to in-house applications

    Asked Dec 05 2016

    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. So I was suggested to … I am trying to figure out how custom connectors work or if it's the correct solution. Basically the company I work at wants to implement a "login using OneLogin" to our in-house applications and we …

    onelogin
  • 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 … because of the short validity. 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 …

    samlsaml-2.0onelogin
  • 1
    Votes

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

    Answered Apr 05 2017

    While being able to generate a SAML assertion for any user (without the need for MFA and a user/pass) seems like a good workaround, this is unfortunately fraught with security perils. An API that … hours. 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 …

    samlsaml-2.0onelogin
  • 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 … API url for Duo. The base64 encoded elements are the user's email, what I'm assuming is the user's Duo ID, and a number that I'm unsure about since it changes with every request. I'm assuming this …

    onelogin

Loading...