[{"label":"Latest (v1.0)","version":"latest"}]
csp
Remove Users From Custom Group In Organization By Organization ID And Group ID And User Ids
DescriptionRemoves users from custom group within organization.
Note: Only users of custom groups can be removed.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
string
groupId
Required
Unique identifier of the group.
Parameter Serialization Style:
simple Explode:false
Request Body
Request Body
RemoveUsersFromCustomGroupRequest
of mimetype application/json
Required
{
"ids": [
"string"
]
}
array of
string
ids
Required
Identifiers of the users to be notified.
boolean
notifyUsers
Optional
Publish email notification to group members.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PartialSuccessResponseString
of type application/json
{
"failed": [
"string"
],
"succeeded": [
"string"
]
}
array of
string
failed
Optional
The entities for which the operation failed.
array of
string
succeeded
Optional
The entities for which the operation is successful.
Errors
CspErrorResponse
400
Group not part of the organization | Removing users from enterprise groups is not allowed
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
Removing users from shared group is not allowed
CspErrorResponse
404
Organization with this identifier is not found. | Group with this identifier is not found.
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X DELETE -H "Content-Type: application/json" -d '{"ids":["string"],"notifyUsers":false}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,org_admin
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
