automation-suite
2021.10
false
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
[Preview] Get Specific Group
OUT OF SUPPORT
Automation Suite API Guide
Last updated Nov 11, 2024
[Preview] Get Specific Group
Returns information about a group, based on the organization and group ID.
--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 param |
Data type |
Description |
---|---|---|
(required) |
String |
The ID of the organization containing the desired group. |
(required) |
String |
The ID of the group you want to retrieve. |
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 GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/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": "albus@hogwarts.com"
}
]
}
{
"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": "albus@hogwarts.com"
}
]
}