DELETE

Remove User

Use this API to remove a single user from a privilege.

Required Feature

A OneLogin subscription that includes Delegated Administration is required to use the privileges API.

Resource URL

DELETE https://<subdomain>.onelogin.com/api/1/privileges/:id/users/:user_id

Header Parameters

Authorization

required

string

Set to Bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

Generate the access token with the API credential pair created using the scope required to call this API. Call this API using the Manage All scope.

Resource Parameter

id

required

string

Set to the id of the privilege.

user_id

required

string

Set to the id of the user you want to remove.

Sample Response

  • 204 No Content
  • 401 Unauthorized
  • 404 Not Found

The user was removed from the privilege.

Typically, this error indicates an invalid access token.

{
    "statusCode": 401,
    "name": "UnauthorizedError",
    "message": "The request requires user authentication."
}

The privilege or user ID does not exist or has been removed.

{
    "statusCode": 404,
    "name": "NotFoundError",
    "message": "The resource can't be found or the server has not found anything matching the Request-URI"
}

Sample Code

cURL

curl 'https://<subdomain>.onelogin.com/api/1/privileges/<privilege_id>/users/<user_id>' \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Postman Collection

Run In Postman