automation-suite
2021.10
false
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
[Preview] Delete Groups
OUT OF SUPPORT
Automation Suite API Guide
Last updated Nov 11, 2024
[Preview] Delete Groups
Deletes multiple groups from an organization, based on the organization ID.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Note: To obtain the
{access_token}
, make sure to authenticate through one of the methods described here.
Path param |
Data type |
Description |
---|---|---|
(required) |
String |
The ID of the organization you want to retrieve the groups for. |
The request body contains the list of custom groups IDs you want to bulk delete from the organization.
{
"groupIDs": [
"string",
"string"
]
}
{
"groupIDs": [
"string",
"string"
]
}
Let's say you gathered all the information needed to build the API call.
- Your
{baseURL}
is:https://{yourDomain}/{organizationName}/{tenantName}/
-
Your
{access_token}
is:1234
(for length considerations). - The
{partitionGlobalId}
is:magic-7
-
The custom groups you want to delete have the following IDs:
- Group 1:
group1
- Group 2:
group2
- Group 1:
The call should look like below (cURL):
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"groupIDs": [
"group1",
"group2"
]
}'
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"groupIDs": [
"group1",
"group2"
]
}'