Verify an Authentication Factor
Use this API to verify completion of OneLogin Push or OneLogin Voice factors.
Resource URL
https://<subdomain>/api/2/mfa/users/<user_id>/verifications/<verification_id>
Header Parameter
Authorization required string | Set to Set 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 |
Resource Parameters
user_id required integer |
Set to the If you don’t know the user’s |
verification_id required integer |
The |
Pending user action to confirm push notification or OneLogin Voice call
- 200 OK
- 401 Unauthorized
- 404 Not Found
[
{
"id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
"status": "pending",
"device_id": "3919988"
}
]
{
"status": {
"error": true,
"code": 401,
"type": "Unauthorized",
"message": "Authentication Failure"
}
}
{
"statusCode": 404,
"name": "NotFound",
"message": "The resource can't be found or the server has not found anything matching the Request-URI"
}
User has accepted push notification or OneLogin Voice call
- 200 OK
- 401 Unauthorized
- 404 Not Found
[
{
"id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
"status": "accepted",
"device_id": "3919988"
}
]
{
"status": {
"error": true,
"code": 401,
"type": "Unauthorized",
"message": "Authentication Failure"
}
}
{
"statusCode": 404,
"name": "NotFound",
"message": "The resource can't be found or the server has not found anything matching the Request-URI"
}
Response Elements
id |
Registration identifier. |
status |
pending = has not been completed. accepted registration has successfully completed, rejected user has denied the MFA attempt or incorrectly provided the OneLogin Voice OTP code. |
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://<subdomain>/api/2/mfa/users/<user_id>/verifications/<verification_id>' \
-X GET \
-H "Authorization: bearer: <access_token>" \
Have a Question?
Found a problem or a bug? Submit a support ticket.
Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.
Have a product idea or request? Share it with us in our Ideas Portal.