Remove Users From Organization By Organization Id Using DELETE
Remove 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 | ✔️ | ❌ |
Unique identifier (GUID) of the organization.
Show optional properties
{
"ids": [
{}
]
}
{
"ids": [
"string"
],
"notifyUsers": false
}
Identifiers of the users that will be removed from the organization.
Send e-mail notification to the user(s).
OK
{
"failed": [
"string"
],
"succeeded": [
"string"
]
}
The entities for which the operation failed.
The entities for which the operation is successful.
Cannot remove more than 20 users at the same time | Cannot remove the last org owner
{
"cspErrorCode": "string",
"errorCode": "string",
"message": "string",
"moduleCode": 0,
"requestId": "string",
"statusCode": 0
}
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user is not authorized to use the API
{
"cspErrorCode": "string",
"errorCode": "string",
"message": "string",
"moduleCode": 0,
"requestId": "string",
"statusCode": 0
}
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user is forbidden to use the API
{
"cspErrorCode": "string",
"errorCode": "string",
"message": "string",
"moduleCode": 0,
"requestId": "string",
"statusCode": 0
}
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
Organization with this identifier is not found. | Users [...] not found
{
"cspErrorCode": "string",
"errorCode": "string",
"message": "string",
"moduleCode": 0,
"requestId": "string",
"statusCode": 0
}
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user has sent too many requests
{
"cspErrorCode": "string",
"errorCode": "string",
"message": "string",
"moduleCode": 0,
"requestId": "string",
"statusCode": 0
}
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
An unexpected error has occurred while processing the request
{
"cspErrorCode": "string",
"errorCode": "string",
"message": "string",
"moduleCode": 0,
"requestId": "string",
"statusCode": 0
}
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode