- 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
- 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
API reference for creating a robot account and assigning it to groups via the Identity API
Creates a new robot account in the specified organization ID, and assigns it to the indicated groups.
API Endpoint
POST https://{yourDomain}/identity/api/RobotAccount
Scopes
Requires the following scopes:
- PM.RobotAccount
- PM.RobotAccount.Write
Request Headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
To obtain the {access_token}, make sure to authenticate through one of the methods described here.
Request Body
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"
]
}
Responses
201 Successful
The custom group is created in the indicated organization and gets an ID.
Example Request
Let's say you gathered all the information needed to build the API call.
- Your
{baseURL}is: https://{yourDomain}/identity - Your
{access_token}is:1234(for length considerations). - The
{partitionGlobalId}is:3fa85f64-5717-4562-b3fc-2c963f66afa6 - 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 resemble the following example (cURL):
curl --location --request POST 'https://{yourDomain}/identity/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Roby",
"displayName": "Roby",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"groupIDsToAdd": [
"gryff-01"
],
"groupIDsToRemove": []
}'
curl --location --request POST 'https://{yourDomain}/identity/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Roby",
"displayName": "Roby",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"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"]
}