Returns groups that are administered by logged in user
integer
integer
the filter that the result should match
integer
string
returned if groups were successfully retrieved
any
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/rest/admin/1.0/groups/query' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"{\n \"search\" : \"admins\",\n \"directoryId\" : 1900\n}\"\n"'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
"values": [
{
"id": "1900-Z3JvdXAx",
"displayName": "group1",
"description": "The best group",
"directory": {
"id": 19,
"displayName": "mainDirectory",
"directoryType": "INTERNAL"
}
},
{
"id": "1900-Z3JvdXAy",
"displayName": "group2",
"description": "The most valuable group",
"directory": {
"id": 19,
"displayName": "mainDirectory",
"directoryType": "INTERNAL"
}
}
],
"size": 2,
"start": 0,
"limit": 2,
"isLastPage": false
}Returns group details
string
Requiredreturned if group details were successfully retrieved
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/admin/1.0/groups/{groupId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"id": null,
"displayName": "groupName",
"description": null,
"directory": {
"id": 19,
"displayName": "mainDirectory",
"directoryType": "INTERNAL"
}
}Returns group's direct members (users)
string
Requiredinteger
integer
returned if group's direct members were successfully retrieved
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/admin/1.0/groups/{groupId}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"id": null,
"displayName": "groupName",
"description": null,
"directory": {
"id": 19,
"displayName": "mainDirectory",
"directoryType": "INTERNAL"
}
}Adds multiple users to a single group placed in the same directory
string
RequiredEntity with user'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/groups/{groupId}/users' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"1900-Z3JvdXAx",
"1900-Z3JvdXAy",
"1900-Z3JvdXAz"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"successes": [
"1900-Z3JvdXAx"
],
"failures": [
{
"entity": "1900-Z3JvdXAy",
"reason": "Some reason of failure"
},
{
"entity": "1900-Z3JvdXAz",
"reason": "Another reason of failure"
}
]
}Removes multiple users from single group placed in the same directory
string
RequiredEntity with user's unique identifiers
array<string>
returned if operation of removing users from group was completed
any
1
2
3
4
5
6
7
8
9
10
11
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/admin/1.0/groups/{groupId}/users' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"1900-Z3JvdXAx",
"1900-Z3JvdXAy",
"1900-Z3JvdXAz"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"successes": [
"1900-Z3JvdXAx"
],
"failures": [
{
"entity": "1900-Z3JvdXAy",
"reason": "Some reason of failure"
},
{
"entity": "1900-Z3JvdXAz",
"reason": "Another reason of failure"
}
]
}Returns users that can be assigned to the given group
string
Requiredstring
integer
returned if users assignable to the group were successfully retrieved
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/admin/1.0/groups/{groupId}/users/suggestions' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
"values": [
{
"username": "ariel",
"email": "ariel@some.domain.com",
"active": true,
"directory": {
"id": 0,
"displayName": "Open LDAP",
"directoryType": "INTERNAL"
}
},
{
"username": "carie",
"email": "carie@some.domain.com",
"active": true,
"directory": {
"id": 0,
"displayName": "Open LDAP",
"directoryType": "INTERNAL"
}
},
{
"username": "clarita",
"email": "clarita@some.domain.com",
"active": true,
"directory": {
"id": 0,
"displayName": "Open LDAP",
"directoryType": "INTERNAL"
}
},
{
"username": "john",
"email": "john@some.domain.com",
"active": true,
"directory": {
"id": 0,
"displayName": "Open LDAP",
"directoryType": "INTERNAL"
}
},
{
"username": "libby",
"email": "libby@some.domain.com",
"active": true,
"directory": {
"id": 0,
"displayName": "Open LDAP",
"directoryType": "INTERNAL"
}
},
{
"username": "magdalena",
"email": "magdalena@some.domain.com",
"active": true,
"directory": {
"id": 1,
"displayName": "Active Directory",
"directoryType": "INTERNAL"
}
},
{
"username": "naomi",
"email": "naomi@some.domain.com",
"active": true,
"directory": {
"id": 1,
"displayName": "Active Directory",
"directoryType": "INTERNAL"
}
},
{
"username": "patricia",
"email": "patricia@some.domain.com",
"active": true,
"directory": {
"id": 1,
"displayName": "Active Directory",
"directoryType": "INTERNAL"
}
},
{
"username": "starwars",
"email": "starwars@some.domain.com",
"active": true,
"directory": {
"id": 1,
"displayName": "Active Directory",
"directoryType": "INTERNAL"
}
},
{
"username": "winona",
"email": "winona@some.domain.com",
"active": true,
"directory": {
"id": 1,
"displayName": "Active Directory",
"directoryType": "INTERNAL"
}
}
],
"size": 10,
"start": 0,
"limit": 10,
"isLastPage": false
}Rate this page: