Returns users that can be assigned by to any group administered by the current user
Forge and OAuth2 apps cannot access this REST resource.
integer
integer
search criteria
boolean
integer
array<integer>
string
operation of removing user from groups was completed
any
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/rest/admin/1.0/users/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"search": "username",
"directoryIds": [
1900
],
"active": true,
"avatarSizeHint": 128
}'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
}Adds single user to multiple groups placed in the same directory
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredan entity with group's unique identifiers
array<string>
operation of adding user to groups 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/users/{userId}/groups' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"1900-dXNlcjE",
"1900-dXNlcjI",
"1900-dXNlcjM"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"successes": [
"1900-dXNlcjE"
],
"failures": [
{
"entity": "1900-dXNlcjI",
"reason": "Some reason of failure"
},
{
"entity": "1900-dXNlcjM",
"reason": "Another reason of failure"
}
]
}Removes multiple users from single group placed in the same directory
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredan entity with group's unique identifiers
array<string>
operation of removing user from groups 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/users/{userId}/groups' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"1900-dXNlcjE",
"1900-dXNlcjI",
"1900-dXNlcjM"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"successes": [
"1900-dXNlcjE"
],
"failures": [
{
"entity": "1900-dXNlcjI",
"reason": "Some reason of failure"
},
{
"entity": "1900-dXNlcjM",
"reason": "Another reason of failure"
}
]
}Rate this page: