[{"label":"Latest (v1.0)","version":"latest"}]
csp
Remove Groups From Organization By Organization ID And Groups ID
DescriptionRemove 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
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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.
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.
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
Organization with this identifier is not found. | Groups […] not found
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
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
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,org_admin
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
