orchestrator
2023.4
false
- Getting started
- About OData and references
- Enumerated types
- Authenticating
- Permissions per endpoint
- Building API Requests
- Response codes
- Health check endpoints
- Authentication
- Authentication methods
- External Applications (OAuth)
- ROPC (not recommended)
- Swagger definition
- Read me
- Authorizing API calls in Swagger
- Managing logical resources
- 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
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- Getting started
- About this guide
- Available resources
- API endpoint URL structure
- Enumeration List
- Scopes and permissions
- About scopes and permissions
- Platform Management scopes and permissions
- Platform Management APIs
- Audit Logs
- Get Audit Logs
- Download Audit Logs
- Groups
- Get All Groups
- Get Specific Group
- Delete Specific Group
- Create a New Local Group
- Update Group
- Robot Account
- Get All Robot Accounts
- Delete Robot Accounts
- Get Specific Robot Account
- Delete Specific Robot Account
- Create a New Robot Account
- Update Robot Account
- User
- Update User
- Delete Specific User
- Delete Users
- Settings
- Get Settings
- Update Settings
- Message Template
- Get Message Template
- Update a Message Template
- Get Message Template by Name
Orchestrator API guide
Last updated Feb 13, 2025
Creates a new robot account in the specified organization ID, and assigns it to the indicated groups.
--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.
The request body contains the organization ID to which to want to add the group to, and, optionally, the users you want to add as members in the new group.
{
"partitionGlobalId": "string",
"id": "string",
"name": "string",
"groupIDsToAdd": [
"string", "string"
]
}{
"partitionGlobalId": "string",
"id": "string",
"name": "string",
"groupIDsToAdd": [
"string", "string"
]
}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 - You want to name the group:
"Gryffindors" -
You want to add users Ron, Harry, and Hermione to the group. These users have the following user IDs:
- Ron user identifier:
ron-0103 - Harry user identifier:
har-3107 - Hermione user identifier:
her-1909
- Ron user identifier:
The call should look like below (cURL):
curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Roby",
"displayName": "Roby",
"partitionGlobalId": "magic-7",
"groupIDsToAdd": [
"gryff-01"
],
"groupIDsToRemove": []
}'curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Roby",
"displayName": "Roby",
"partitionGlobalId": "magic-7",
"groupIDsToAdd": [
"gryff-01"
],
"groupIDsToRemove": []
}'Here is the response for a successful call:
{
"id": "rb-12",
"name": "Roby",
"displayName": "Roby",
"creationTime": "2021-10-20T15:20:29.1302044Z",
"lastLoginTime": null,
"groupIds": ["gryff-01"]
}{
"id": "rb-12",
"name": "Roby",
"displayName": "Roby",
"creationTime": "2021-10-20T15:20:29.1302044Z",
"lastLoginTime": null,
"groupIds": ["gryff-01"]
}