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

Remove Groups From Organization By Organization ID And Groups ID

Description

Remove groups from organization.
Note:

  1. Removing an organization custom group permanently deletes the group.
  2. DEPRECATED: Response field failed will be deprecated. You can use the field failures instead.

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
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

RemoveGroupsFromOrgRequest of mimetype application/json Required
{
	"ids": [
		"string"
	]
}
array of string
ids Required

Identifiers of the members that will be removed from the organization.


boolean
notifyUsersInGroups 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 RemoveGroupsFromOrganizationResponseString of type application/json
{
	"failed": [
		"string"
	],
	"failures": [
		{
			"errorCode": "string",
			"id": "string",
			"message": "string"
		}
	],
	"succeeded": [
		"string"
	]
}
array of string
failed Optional

The entities for which the operation failed.


failures Optional

The entities for which the operation fails with the reason of failure.


array of string
succeeded Optional

The entities for which the operation is successful.

Errors

Errors

401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found. | Groups […] not found


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X DELETE -H "Content-Type: application/json" -d '{"ids":["string"],"notifyUsersInGroups":false}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups
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?