WARNING The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point.
Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
read:confluence-groupsread:group:confluenceConnect app scope required: READ
integer
integer
string
Returned if the requested groups are returned.
Same as GroupArray but with _links property.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"type": "group",
"name": "<string>",
"id": "<string>",
"_links": {}
}
],
"start": 2154,
"limit": 2154,
"size": 2154,
"totalSize": 150,
"_links": {}
}Creates a new user group.
Permissions required: User must be a site admin.
write:confluence-groupsread:group:confluence, write:group:confluenceConnect apps cannot access this REST resource.
Name of the group that is to be created.
string
RequiredReturned if the group was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"name": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
{
"type": "group",
"name": "<string>",
"id": "<string>",
"_links": {}
}Returns a user group for a given group id.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
read:confluence-groupsread:group:confluenceConnect app scope required: READ
string
RequiredReturned if the requested group is returned.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group/by-id?id={id}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
{
"type": "group",
"name": "<string>",
"id": "<string>",
"_links": {}
}Delete user group.
Permissions required: User must be a site admin.
write:confluence-groupswrite:group:confluenceConnect apps cannot access this REST resource.
string
RequiredReturned if the group was removed successfully.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group/by-id?id={id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Get search results of groups by partial query provided.
read:confluence-groupsread:group:confluenceConnect app scope required: READ
string
Requiredinteger
integer
boolean
Returns a full JSON representation of group collection.
Same as GroupArray but with _links property.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group/picker?query={query}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"type": "group",
"name": "<string>",
"id": "<string>",
"_links": {}
}
],
"start": 2154,
"limit": 2154,
"size": 2154,
"totalSize": 150,
"_links": {}
}Returns the users that are members of a group.
Use updated Get group API
Permissions required: Permission to access the Confluence site ('Can use' global permission).
read:confluence-groupsread:group:confluence, read:user:confluenceConnect app scope required: READ
string
Requiredinteger
integer
boolean
array<string>
Returned if the requested users are returned.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group/{groupId}/membersByGroupId`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
{
"results": [
{
"type": "known",
"username": "<string>",
"userKey": "<string>",
"accountId": "<string>",
"accountType": "atlassian",
"email": "<string>",
"publicName": "<string>",
"profilePicture": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
},
"displayName": "<string>",
"timeZone": "<string>",
"externalCollaborator": true,
"isExternalCollaborator": true,
"isGuest": true,
"operations": [
{
"operation": "administer",
"targetType": "<string>"
}
],
"details": {
"business": {
"position": "<string>",
"department": "<string>",
"location": "<string>"
},
"personal": {
"phone": "<string>",
"im": "<string>",
"website": "<string>",
"email": "<string>"
}
},
"personalSpace": {
"id": 2154,
"key": "<string>",
"alias": "<string>",
"name": "<string>",
"icon": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
},
"description": {
"plain": {
"value": "<string>",
"representation": "plain",
"embeddedContent": [
{}
]
},
"view": {
"value": "<string>",
"representation": "plain",
"embeddedContent": [
{}
]
},
"_expandable": {
"view": "<string>",
"plain": "<string>"
}
},
"homepage": {
"type": "<string>",
"status": "<string>"
},
"type": "<string>",
"metadata": {
"labels": {
"results": [
{
"prefix": "<string>",
"name": "<string>",
"id": "<string>",
"label": "<string>"
}
],
"size": 2154
},
"_expandable": {}
},
"operations": [
{
"operation": "administer",
"targetType": "<string>"
}
],
"permissions": [
{
"operation": {
"operation": "administer",
"targetType": "<string>"
},
"anonymousAccess": true,
"unlicensedAccess": true
}
],
"status": "<string>",
"settings": {
"routeOverrideEnabled": true,
"_links": {}
},
"theme": {
"themeKey": "<string>"
},
"lookAndFeel": {
"headings": {
"color": "<string>"
},
"links": {
"color": "<string>"
},
"menus": {
"hoverOrFocus": {
"backgroundColor": "<string>"
},
"color": "<string>"
},
"header": {
"backgroundColor": "<string>",
"button": {
"backgroundColor": "<string>",
"color": "<string>"
},
"primaryNavigation": {
"color": "<string>",
"hoverOrFocus": {
"backgroundColor": "<string>",
"color": "<string>"
}
},
"secondaryNavigation": {
"color": "<string>",
"hoverOrFocus": {
"backgroundColor": "<string>",
"color": "<string>"
}
},
"search": {
"backgroundColor": "<string>",
"color": "<string>"
}
},
"content": {},
"bordersAndDividers": {
"color": "<string>"
}
},
"history": {
"createdDate": "<string>"
},
"_expandable": {
"settings": "<string>",
"metadata": "<string>",
"operations": "<string>",
"lookAndFeel": "<string>",
"permissions": "<string>",
"icon": "<string>",
"description": "<string>",
"theme": "<string>",
"history": "<string>",
"homepage": "<string>",
"identifiers": "<string>"
},
"_links": {}
},
"_expandable": {
"operations": "<string>",
"details": "<string>",
"personalSpace": "<string>"
},
"_links": {}
}
],
"start": 2154,
"limit": 2154,
"size": 2154,
"totalSize": 150,
"_links": {}
}Adds a user as a member in a group represented by its groupId
Permissions required: User must be a site admin.
write:confluence-groupswrite:group:confluenceConnect apps cannot access this REST resource.
string
RequiredAccountId of the user who needs to be added as member.
string
RequiredReturned if the group was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"accountId": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group/userByGroupId?groupId={groupId}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Remove user as a member from a group.
Permissions required: User must be a site admin.
write:confluence-groupswrite:group:confluenceConnect apps cannot access this REST resource.
string
Requiredstring
string
string
Returned if the group was removed successfully.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/group/userByGroupId?groupId={groupId}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: