Searches the given directory for groups matching the search term
Forge and OAuth2 apps cannot access this REST resource.
integer
Requiredinteger
integer
string
boolean
a paginated list of groups
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/admin/1.0/group/search/{directoryId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"values": [
{
"id": "1-Y3Jvd2QtYWRtaW5pc3RyYXRvcnM",
"active": true,
"name": "crowd-administrators",
"description": "Crowd administrators"
},
{
"id": "1-Y3Jvd2QtYWRtaW5pc3RyYXRvcnM",
"active": true,
"name": "crowd-administrators",
"description": "Crowd administrators"
}
],
"size": 2,
"start": 1,
"limit": 2,
"isLastPage": false
}Returns group's direct members (groups)
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
integer
a paginated list of nested groups
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/admin/1.0/group/{groupId}/groups' \
--header 'Accept: application/json'Adds multiple groups to a single group placed in the same directory
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredentity with group's unique identifiers
array<string>
returned if operation of adding users to group was completed
any
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/rest/admin/1.0/group/{groupId}/groups' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"1900-Y3Jvd2QtdXNlcnM",
"1900-YmFkZ2Vycw",
"1900-c3Rhc2gtdXNlcnM"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"successes": [
"1900-Y3Jvd2QtdXNlcnM"
],
"failures": [
{
"entity": "1900-YmFkZ2Vycw",
"reason": "Some reason of failure"
},
{
"entity": "1900-c3Rhc2gtdXNlcnM",
"reason": "Another reason of failure"
}
]
}Rate this page: