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

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

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.

Bearer

Responses

200

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

{
    "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

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

Removing users from shared group is not allowed

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. | Group with this identifier is 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