automation-suite
2023.4
false
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
[Preview] Update Group
Automation Suite API Guide
Last updated Jul 12, 2024
[Preview] Update Group
Updates the information about the specified local group.
--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.
Param |
Data type |
Description |
---|---|---|
(required) |
String |
The Id of the group you want to update. |
The request body contains the organization ID the group belongs to, and the information you want to update, such as group name and memberships.
{
"partitionGlobalId": "string",
"name": "string",
"directoryUserIDsToAdd": [
"string"
],
"directoryUserIDsToRemove": [
"string"
]
}
{
"partitionGlobalId": "string",
"name": "string",
"directoryUserIDsToAdd": [
"string"
],
"directoryUserIDsToRemove": [
"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 keep the group name as it is.
-
You want to add users Luna and Neville to the group. These users have the following user IDs:
- Luna user identifier:
lun-1302
- Neville user identifier:
nev-3007
- Luna user identifier:
The call should look like below (cURL):
curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/gryff-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"partitionGlobalId": "magic-7",
"name": "Gryffindors",
"directoryUserIDsToAdd": [
"lun-1302", "nev-3007"
],
"directoryUserIDsToRemove": []
}'
curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/gryff-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"partitionGlobalId": "magic-7",
"name": "Gryffindors",
"directoryUserIDsToAdd": [
"lun-1302", "nev-3007"
],
"directoryUserIDsToRemove": []
}'
Here is the response for a successful call:
{
"id": "gryff-01",
"name": "Gryffindors",
"displayName": "Gryffindors",
"type": 1,
"creationTime": "2021-10-19T15:37:49.1853184",
"lastModificationTime": "2021-10-19T16:46:20.0742901",
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Hermione",
"lastName": "Granger",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Hermione Granger",
"source": "local",
"identifier": "her-1909",
"name": "Hermione",
"email": "hermione@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Harry",
"lastName": "Potter",
"jobTitle": ""student"",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Harry Potter",
"source": "local",
"identifier": "har-3107",
"name": "Harry",
"email": "harry@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Luna",
"lastName": "Lovegood",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Luna Lovegood",
"source": "local",
"identifier": "lun-1302",
"name": "Luna",
"email": "luna@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Ron",
"lastName": "Weasley",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Ron Weasley",
"source": "local",
"identifier": "ron-0103",
"name": "Ron",
"email": "ron@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Neville",
"lastName": "Longbottom",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Neville Longbottom",
"source": "local",
"identifier": "nev-3007",
"name": "Neville",
"email": "neville@hogwarts.com"
}
]
}
{
"id": "gryff-01",
"name": "Gryffindors",
"displayName": "Gryffindors",
"type": 1,
"creationTime": "2021-10-19T15:37:49.1853184",
"lastModificationTime": "2021-10-19T16:46:20.0742901",
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Hermione",
"lastName": "Granger",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Hermione Granger",
"source": "local",
"identifier": "her-1909",
"name": "Hermione",
"email": "hermione@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Harry",
"lastName": "Potter",
"jobTitle": ""student"",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Harry Potter",
"source": "local",
"identifier": "har-3107",
"name": "Harry",
"email": "harry@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Luna",
"lastName": "Lovegood",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Luna Lovegood",
"source": "local",
"identifier": "lun-1302",
"name": "Luna",
"email": "luna@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Ron",
"lastName": "Weasley",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Ron Weasley",
"source": "local",
"identifier": "ron-0103",
"name": "Ron",
"email": "ron@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Neville",
"lastName": "Longbottom",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Neville Longbottom",
"source": "local",
"identifier": "nev-3007",
"name": "Neville",
"email": "neville@hogwarts.com"
}
]
}