See api-docs Menu

Activate an Authentication Factor


Use this API to trigger an SMS, Voice, Email or Push notification containing a One-Time Password (OTP) that can be used to authenticate a user with the Verify Factor call. For OneLogin Protect or Google Authenticator with OTP, this call needs to be performed to generate a verification_id which can be used to validate the OTP code.









Resource URL

https://<api-domain>/api/2/mfa/users/<user_id>/verifications

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 All scope.

Resource Parameters

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.

Request Parameter

device_id

integer

Required. Specifies the factor to be verified.

expires_in

integer

Optional. Sets the window of time in seconds that the factor must be verified within.

Defaults to 120 seconds (2 minutes). Max 900 seconds (15 minutes).

custom_message

string

Optional. Only applies to SMS factor.

A message template that will be sent via SMS. Max length of the message after template items are inserted is 160 characters including the OTP code.

The following template variables can be included in the message.

  • {{otp_code}} - The security code.
  • {{otp_expiry}} - The number of minutes until the one time code expires.

Request Body

With optional expires_in value for OTP

{
    "device_id": "2825320",
    "expires_in": 240
}

Sample Response

OneLogin SMS

[
  {
    "user_display_name": "OneLogin SMS",
    "id": "afc1a96d-2006-452a-a484-b2d084b00d76",
    "auth_factor_name": "SMS",
    "type_display_name": "OneLogin SMS",
    "user_id": "64515901",
    "device_id": "3920371",
    "expires_at": "2020-07-21T20:26:44Z"
  }
]
{
    "statusCode": 401,
    "name": "InvalidCredentials",
    "message": "Please provide valid credentials"
}

OneLogin Email

{
    "user_display_name": "Email",
    "id": "a274ea6b-8c3f-403b-8388-92028db4763a",
    "auth_factor_name": "OneLogin Email",
    "type_display_name": "Email",
    "user_id": "12345678",
    "device_id": "6123456",
    "expires_at": "2021-01-27T20:32:44Z"
}

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

OneLogin Voice

{
    "user_display_name": "OneLogin Voice",
    "id": "906621ef-0a42-4032-ae34-673d439f8326",
    "auth_factor_name": "OneLogin Voice",
    "type_display_name": "OneLogin Voice",
    "user_id": "87654321",
    "device_id": "1234567",
    "expires_at": "2021-01-27T20:34:05Z",
    "factor_data": {
        "verification_token": "123456"
    }
}
{
    "statusCode": 401,
    "name": "InvalidCredentials",
    "message": "Please provide valid credentials"
}

OneLogin Protect

{
    "user_display_name": "OneLogin Protect",
    "id": "f4c4a72c-c9f4-4b52-90f1-1740bcc6332e",
    "auth_factor_name": "OneLogin",
    "type_display_name": "OneLogin Protect",
    "user_id": "12345678",
    "device_id": "7654321"
}
{
    "statusCode": 401,
    "name": "InvalidCredentials",
    "message": "Please provide valid credentials"
}

Response Elements

expires_at A short lived token that is required to Verify the Factor. This token expires based on the expires_in parameter passed in.
auth_factor_name Authentication factor name, as it appears to administrators in OneLogin.
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 enroll the device.
id Verification identifier used in subsequent verification step.
user_id Identifier for the user.

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>/verifications' \
-X POST \
-H "Authorization: bearer: <access_token>" \
-d '{
    "device_id": "1234567",
    "expires_in": 240
}'

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...