automation-suite
2.2510
true
Automation Suite API guide
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
Delete a specific robot account from an Automation Suite organization using the Identity API, including required scope and response codes.
Deletes the specified robot account in an organization, based on the organization and robot account ID.
API endpoint
DELETE https://{yourDomain}/{organizationName}/identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}
Scopes
Requires the following scopes:
PM.RobotAccountPM.RobotAccount.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 robot accounts from. |
robotAccountId | String | Required. The ID of the robot account you want to delete. |
Responses
204 Success
The indicated robot account 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}/identity_ - Your
{access_token}is:1234(for length considerations). - The
{partitionGlobalId}is:3fa85f64-5717-4562-b3fc-2c963f66afa6 - The
{robotAccountId}is:33-ab
The call should resemble the following example (cURL):
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/identity_/api/RobotAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/33-ab' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/identity_/api/RobotAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/33-ab' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'