automation-suite
2024.10
false
Automation Suite API guide
- 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
API endpoint for deleting a specific group from an organization in Automation Suite, based on organization and group ID.
Deletes the specified group in an organization, based on the organization and group ID.
API endpoint
DELETE https://{yourDomain}/{organizationName}/identity_/api/Group/{partitionGlobalId}/{groupId}
Scopes
Requires the following scopes:
PM.GroupPM.Group.Write
Request headers
--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 in Authentication methods.
Path parameters
| Parameter | Data type | Description |
|---|---|---|
partitionGlobalId | String | Required. The ID of the organization you want to delete the group from. |
groupId | String | Required. The ID of the group you want to delete. |
Responses
204 Success
The indicated group is deleted from the organization.
Example request
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
{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'