See api-docs Menu

Get Available Authentication Factors


Use this API to return a list of authentication factors that are available for user enrollment via API.

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.

Currently the API only supports enrollment of OneLogin SMS and OneLogin Voice factors. Other factors can be enrolled manually by the user.

Resource URL

https://<subdomain>/api/1/users/<user_id>/auth_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

{
    "status": {
        "error": false,
        "code": 200,
        "type": "success",
        "message": "Success"
    },
    "data": {
        "auth_factors": [
            {
                "name": "OneLogin SMS",
                "factor_id": 16282
            }
        ]
    }
}
{
      "status": {
          "error": true,
          "code": 400,
          "type": "bad request",
          "message": "Authorization Information is incorrect"
      }
  }
{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Authentication Failure"
    }
}
{
    "status": {
        "error": true,
        "code": 404,
        "type": "not found",
        "message": "User for id 123456789 was not found"
    }
}

Response Elements

name

"Official" authentication factor name, as it appears to administrators in OneLogin.

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://<subdomain>/api/1/users/<user_id>/auth_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.