See api-docs Menu

Verify Enrollment of Authentication Factors


Use this API to verify enrollment for OneLogin SMS, OneLogin Email, OneLogin Protect and Authenticator authentication factors.

At this point, the enrollment of the factor should have already been requested, and this API will allow you to verify the OTP code sent to or generated for the user on the provided factor. The status of the registration should be pending. If the initial registration was completed with veriifed = True then this step will not be necessary.

The API supports enrollment of support for SMS, Email, Google Authenticator, and OneLogin Protect. Other factors can be enrolled manually by the user.

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-domain>/api/2/mfa/users/<user_id>/registrations/<registration_id>

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: Manage users 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.

registration_id

required

uuid

Set to the uuid of the registration. This was included in the response as part of the initial request in Enroll Factor.

Request Parameters

otp

required

integer

One-Time-Password (OTP) that was sent to the user based on the chosen factor. OneLogin SMS and OneLogin Email support this OTP code.

Request Body

{
    "otp": "58959"
}

Sample Responses

OneLogin SMS, OneLogin Email, Authenticator

[
  {
      "id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
      "status": "accepted",
      "device_id": "3919988"
  }
]
{
    "statusCode": 401,
    "name": "InvalidCredentials",
    "message": "Please provide valid credentials"
}

Response Elements

id Registration identifier.
status pending registration has not been completed successfully. accepted registration has successfully completed.
device_id Device id to be used with Verify the Factor.

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>/registrations/<registration_id>' \
-X PUT \
-H "Authorization: bearer: <access_token>" \
-d '{
  "otp":"123456"
}'

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 …

  • 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 …

  • 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 …

  • 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 …

  • 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 MFAAPI 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 …

Loading...