Remove Users From Organization By Organization ID
DescriptionRemove users from organization by user ids.
User ids will be of the format
Pay attention: in case of partial success the caller must read the response to see which users have not been added successfully
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Request Body
{
"ids": [
"string"
]
}
Identifiers of the users that will be removed from the organization.
Send e-mail notification to the user(s).
Authentication
Response
Response BodyResponse Body
200 OK
{
"failed": [
"string"
],
"succeeded": [
"string"
]
}
The entities for which the operation failed.
The entities for which the operation is successful.
Errors
Cannot remove more than 20 users at the same time | Cannot remove the last org owner
The user is not authorized to use the API
The user is forbidden to use the API
Organization with this identifier is not found. | Users […] not found
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_owner,org_admin
x-slo-tier: TIER2
