Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE

Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE

Removes 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
URI
DELETE
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

string
groupId
Required

Unique identifier of the group.

Request Body
RemoveUsersFromCustomGroupRequest of type(s) application/json
Required 
"RemoveUsersFromCustomGroupRequest Object"
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.
Responses
200

OK

Returns PartialSuccessResponseString of type(s) 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.


400

Group not part of the organization | Removing users from enterprise groups is not allowed

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

Removing users from shared group is not allowed

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found. | Group with this identifier is not found.

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
On This Page
Organization Groups Operations
POST
Add Users To Custom Group In Organization By Organization Id And Group Id Using POST
DELETE
Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE
GET
Get Users In Group Within Organization By Organization Id And Group Id Using GET
PATCH
Update Group Details In Organization By Organization Id And Group Id Using PATCH
GET
Get Group In Organization By Organization Id And Group Id Using GET
PATCH
Update Group Roles On Organization By Organization Id And Group Id Using PATCH
GET
Get Group Roles On Organization By Organization Id And Group Id Using GET
GET
Get Nested Enterprise Groups From Custom Group By Organization Id And Group Id Using GET
POST
Create Custom Group In Organization By Organization Id Using POST
DELETE
Remove Groups From Organization By Organization Id And Groups Id Using DELETE
GET
Get Organization Groups By Organization Id Using GET
POST
Search Groups Within Organization By Organization Id And Group Roles Using POST