automation-suite
2022.4
false
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
- Get All Groups
- Get Specific Group
- Delete Specific Group
- Create a New Local Group
- Update Group

Automation Suite API guide
Last updated Feb 24, 2025
Delete Specific Group
linkDeletes the specified group in an organization, based on the organization and group ID.
API Endpoint
linkDELETE
https://{yourDomain}/{organizationName}/identity_/api/Group/{partitionGlobalId}/{groupId}
Scopes
linkRequires the following scopes:
- PM.Group
- PM.Group.Write
Request Headers
link--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 Parameters
link
Path param |
Data type |
Description |
---|---|---|
(required) |
String |
The ID of the organization you want to delete the group from. |
(required) |
String |
The ID of the group you want to delete. |
Example Request
linkLet'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
{groupId}
is:2512
The call should resemble the following example (cURL):
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'