GET

Verify Enrollment Voice & Protect

Use this API to verify enrollment for OneLogin Voice. At this point, the enrollment of the factor should have already been requested, and this API will allow you to verify the user has completed the verification on the required factor. The status of the registration should be pending. If the initial registration was completed with verifed = True then this step will not be necessary.

Using this method allows for your service to query the status of the pending registration to determine if the user has verified the factor using the required device. This is required to verify OneLogin Voice where the end-user is required to type the OTP code into the phone. For OneLogin Protect, you can verify if user has enrolled protect by using the verification_token value to manually register protect within the app.

Resource URL

https://<subdomain>.onelogin.com/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 the Manage All scope.

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.

Sample Responses

Pending user action to confirm enrollment

200 OK
401 Unauthorized

[
  {
      "id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
      "status": "pending",
      "device_id": "3919988"
  }
]

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

User has confirmed enrollment

200 OK
401 Unauthorized

[
  {
      "id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
      "status": "accepted",
      "device_id": "3919988"
  }
]

{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Authentication Failure"
    }
}

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 . No device id will be returned if the factor is not in the `accepted` state.

Postman Collection

Sample Code

cURL

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

curl 'https://<subdomain>.onelogin.com/api/2/mfa/users/<user_id>/registrations/<registration_id>' \
-X GET \
-H "Authorization: bearer <access_token>"