automation-suite
2022.4
false
UiPath logo, featuring letters U and I in white
Automation Suite API Guide
Last updated Jun 17, 2024

[Preview] Delete Specific Group

Deletes the specified group in an organization, based on the organization and group ID.

API Endpoint

docs image https://{yourDomain}/identity_/api/Group/{partitionGlobalId}/{groupId}

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 delete the group from.

groupId

(required)

String

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 look like below (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'
  • API Endpoint
  • Scopes
  • Request Headers
  • Path Parameters
  • Responses
  • 204 Success
  • Example Request

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.