Remove Groups From Organization By Organization Id And Groups Id Using DELETE

Remove Groups From Organization By Organization Id And Groups Id Using DELETE

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 Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
DELETE
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Request Body
RemoveGroupsFromOrgRequest of type(s) application/json
Required 
"RemoveGroupsFromOrgRequest Object"
array of string
ids
Required
Constraints: minItems: 0 maxItems: 20

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

boolean
notifyUsersInGroups
Optional

Publish email notification to group members.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RemoveGroupsFromOrganizationResponseString of type(s) application/json 
{
    "failed": [
        "string"
    ],
    "succeeded": [
        "string"
    ],
    "failures": [
        {
            "message": "string",
            "id": "string",
            "errorCode": "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.

array of object
failures
Optional

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


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

The user is forbidden 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


404

Organization with this identifier is not found. | Groups [...] 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
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