Removing a user from an organisation¶
Note
Users cannot remove their own account from an organisation, regardless of their role; such an attempt returns the response 403.
Sends a POST request to the endpoint /organisations/{organisation}/users/remove.
Description¶
The Remove-Organisation-User request removes a user from a specified organisation.
Requirements¶
Values of the request: Organisation ID {organisation}
Objects: none
Request¶
To remove a user from an organisation, add the Organisation ID {organisation} to the path of the request.
For a detailed specification of which information is required to remove a user from the organisation, the following attribute must be defined in the body:
| Attributes | Description | Values |
|---|---|---|
userId |
The ID of the user to be removed. | string |
As a result, the user gets an object with a confirmation message.
The object provides the following information:
| Attributes | Description | Values |
|---|---|---|
message |
The confirmation message returned after the user is removed. | string |
Example¶
Example request body:
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 401 | The request has not succeeded because the user authentication was incorrect. |
| 403 | The request has not succeeded because the user does not have the right permissions. |
| 404 | The request was unsuccessful because the requested resource was not found. |