[{"label":"Latest (v1.0)","version":"latest"}]
csp

Remove Users From Custom Group In Organization By Organization ID And Group ID And User Ids

Description

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 Owner ✔️ ✔️

Request

Request

URL

URL


delete
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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

Errors

400

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


401

The user is not authorized to use the API


403

Removing users from shared group is not allowed


404

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


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

PowerCLI Client SDK Example

$RemoveUsersFromCustomGroupRequest = Initialize-RemoveUsersFromCustomGroupRequest -NotifyUsers $false -Ids "MyIds"
Invoke-RemoveUsersFromCustomGroupInOrgUsingDELETE -OrgId "MyOrgId" -GroupId "MyGroupId" -RemoveUsersFromCustomGroupRequest $RemoveUsersFromCustomGroupRequest

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?