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

Remove groups from organization.
Note:

Removing an organization custom group permanently deletes the group.
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

{
    "ids": [
        "string"
    ],
    "notifyUsersInGroups": false
}

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

This operation uses the following authentication methods.

Bearer

Responses

200

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

array of RemoveGroupsFromOrganizationFailure

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.

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

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

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

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

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message