Rate this page:
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.
GET /wiki/rest/api/group
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).
Connect app scope required: READ
read:confluence-groupsread:group:confluenceinteger
The starting index of the returned groups.
0, Minimum: 0, Format: int32integer
The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.
200, Minimum: 0, Format: int32string
The group permission level for which to filter results.
Valid values: user, admin, site-admin
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.asApp().requestConfluence(route`/wiki/rest/api/group`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested groups are returned.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/group
Creates a new user group.
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupsread:group:confluence, write:group:confluencestring
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.asApp().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());Returned if the group was created successfully.
| Content type | Value |
|---|---|
| application/json |
DELETE /wiki/rest/api/group
Delete user group.
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupswrite:group:confluencestring
Name of the group to delete.
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.asApp().requestConfluence(route`/wiki/rest/api/group?name={name}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the group was removed successfully.
A schema has not been defined for this response code.
GET /wiki/rest/api/group/by-name
Returns a user group for a given group name.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Connect app scope required: READ
read:confluence-groupsread:group:confluencestring
The name of the group. This is the same as the group name shown in the Confluence administration console.
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.asApp().requestConfluence(route`/wiki/rest/api/group/by-name?name={name}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested group is returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/group/by-id
Returns a user group for a given group id.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Connect app scope required: READ
read:confluence-groupsread:group:confluencestring
The id of the group.
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.asApp().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());Returned if the requested group is returned.
| Content type | Value |
|---|---|
| application/json |
DELETE /wiki/rest/api/group/by-id
Delete user group.
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupswrite:group:confluencestring
Id of the group to delete.
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.asApp().requestConfluence(route`/wiki/rest/api/group/by-id?id={id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the group was removed successfully.
A schema has not been defined for this response code.
GET /wiki/rest/api/group/{groupName}
Returns a user group for a given group name.
Use updated Get group API
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Connect app scope required: READ
string
The name of the group. This is the same as the group name shown in the Confluence administration console.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/confluence/rest/#auth
import api, { route } from "@forge/api";
const response = await api.requestConfluence(route`/wiki/rest/api/group/{groupName}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested group is returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/group/member
Returns the users that are members of a group.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Connect app scope required: READ
read:confluence-groupsread:group:confluence, read:user:confluencestring
The name of the group to be queried for its members.
integer
The starting index of the returned users.
0, Minimum: 0, Format: int32integer
The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.
200, Minimum: 0, Format: int32boolean
Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
false1 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.asApp().requestConfluence(route`/wiki/rest/api/group/member?name={name}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested users are returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/group/{groupName}/member
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).
Connect app scope required: READ
string
The name of the group to be queried for its members.
integer
The starting index of the returned users.
0, Minimum: 0, Format: int32integer
The maximum number of users to return per page. Note, this may be restricted by fixed system limits.
200, Minimum: 0, Format: int321 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/confluence/rest/#auth
import api, { route } from "@forge/api";
const response = await api.requestConfluence(route`/wiki/rest/api/group/{groupName}/member`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested users are returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/group/picker
Get search results of groups by partial query provided.
Connect app scope required: READ
read:confluence-groupsread:group:confluencestring
the search term used to query results.
integer
The starting index of the returned groups.
0, Minimum: 0, Format: int32integer
The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.
200, Minimum: 0, Format: int32boolean
Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
false1 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.asApp().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());Returns a full JSON representation of group collection.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/group/userByGroupId
Adds a user as a member in a group represented by its groupId
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupswrite:group:confluencestring
GroupId of the group whose membership is updated
string
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.asApp().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());Returned if the group was created successfully.
A schema has not been defined for this response code.
DELETE /wiki/rest/api/group/userByGroupId
Remove user as a member from a group.
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupswrite:group:confluencestring
Id of the group whose membership is updated.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
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.asApp().requestConfluence(route`/wiki/rest/api/group/userByGroupId?groupId={groupId}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the group was removed successfully.
A schema has not been defined for this response code.
GET /wiki/rest/api/group/{groupId}/membersByGroupId
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).
Connect app scope required: READ
read:confluence-groupsread:group:confluence, read:user:confluencestring
The id of the group to be queried for its members.
integer
The starting index of the returned users.
0, Minimum: 0, Format: int32integer
The maximum number of users to return per page. Note, this may be restricted by fixed system limits.
200, Minimum: 0, Format: int32boolean
Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
false1 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.asApp().requestConfluence(route`/wiki/rest/api/group/{groupId}/membersByGroupId`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested users are returned.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/group/user
Adds a user as a member in a group.
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupswrite:group:confluencestring
Name of the group whose membership is updated
string
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.asApp().requestConfluence(route`/wiki/rest/api/group/user?name={name}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the group was created successfully.
A schema has not been defined for this response code.
DELETE /wiki/rest/api/group/user
Remove user as a member from a group.
Permissions required: User must be a site admin.
Connect apps cannot access this REST resource.
write:confluence-groupswrite:group:confluencestring
Name of the group whose membership is updated.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
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.asApp().requestConfluence(route`/wiki/rest/api/group/user?name={name}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the group was removed successfully.
A schema has not been defined for this response code.
Rate this page: