orchestrator
2021.10
false
Orchestrator API Guide
- Getting Started
- Authentication
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Processes Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
Deletes multiple groups from an organization, based on the organization ID.
API Endpoint
DELETE https://{yourDomain}/identity/api/Group/{partitionGlobalId}
Scopes
Requires the following scopes:
- PM.Group
- PM.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 here.
Path Parameters
| Path param | Data type | Description |
|---|---|---|
partitionGlobalId(required) | String | The ID of the organization you want to retrieve the groups for. |
Request Body
The request body contains the list of custom groups IDs you want to bulk delete from the organization.
{
"groupIDs": [
"string",
"string"
]
}
{
"groupIDs": [
"string",
"string"
]
}
Responses
200 OK
The indicated custom groups are 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 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"
]
}'