orchestrator
2023.4
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
- 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
- Get All Groups
- Get Specific Group
- Delete Specific Group
- Create a New Local Group
- Update Group
Returns information about a group, based on the organization and group ID.
API Endpoint
GET https://{yourDomain}/identity/api/Group/{partitionGlobalId}/{groupId}
Scopes
Requires the following scopes:
- PM.Group
- PM.Group.Read
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 containing the desired group. |
groupID(required) | String | The ID of the group you want to retrieve. |
Responses
200 OK
The specified group information is returned.
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 - The
{groupID}is:2512
The call should resemble the following example (cURL):
curl --location --request GET 'https://{yourDomain}/identity/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://{yourDomain}/identity/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
Here's the response body for a successful call:
{
"id": "2512",
"name": "Automation Developers",
"displayName": "Automation Developers",
"type": 0,
"creationTime": "2021-10-19T14:25:01.6574988",
"lastModificationTime": "2021-10-19T14:25:01.6574988",
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Albus",
"lastName": "D",
"jobTitle": "master",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Albus D",
"source": "local",
"identifier": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"name": "albus",
"email": "[email protected]"
}
]
}
{
"id": "2512",
"name": "Automation Developers",
"displayName": "Automation Developers",
"type": 0,
"creationTime": "2021-10-19T14:25:01.6574988",
"lastModificationTime": "2021-10-19T14:25:01.6574988",
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Albus",
"lastName": "D",
"jobTitle": "master",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Albus D",
"source": "local",
"identifier": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"name": "albus",
"email": "[email protected]"
}
]
}