See api-docs Menu
  1. Home >
  2. API >
  3. 1 >
  4. Multi-Factor Auth >
  5. Remove a Factor

Remove a Factor

Use this API to remove an enrolled factor from a user.

 

 

 

 

 

Resource URL

Before calling this API, consider using its version /2 equivalent.

https://<subdomain>/api/1/users/<user_id>/otp_devices/<device_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 either of the following scopes: Manage users or Manage All.

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.

device_id

required

integer

Set to the device_id of the MFA device.

The device_id is returned on enrollment of a factor or you can get the device_id using the Get Enrolled Factors API call.

Sample Response

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
{}
{
    "status": {
        "type": "bad request",
        "code": 400,
        "message": "Factor could not be found",
        "error": true
    }
}

{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Insufficient Permission"
    }
}

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Sample Code

cURL

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

curl 'https://<subdomain>/api/1/users/<user_id>/otp_devices/<device_id>' \
-X DELETE \
-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.