See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Roles >
  5. Remove Role Users

Remove Role Users

Use this API to remove users from a role.

Be careful, this operation is final and can not be undone.





Resource URL

https://<subdomain>/api/2/roles/:id/users

Header Parameters

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

Request Parameter

user_id

required

array

Set user_id values in array, for example: [123, 456, 678]

Sample Responses

  • 204 No Content
  • 401 Unauthorized
  • 404 Not Found

Success. The user has been deleted. No users are returned.

Typically, this error means that your Authorization header value is missing or incorrectly formatted. The Authorization header value should use this format: bearer:<access_token>.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

You attempted to delete a user that does not exist.

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

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.

Delete User Parameter

curl 'https://<subdomain>/api/2/roles/:id/users' \
-X DELETE \
-H "Authorization: bearer <access_token>"
-d '[123, 456, 789]'

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.