Rate this page:
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).
App scope required: READ
read:confluence-groupsinteger
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: int321 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group' \
--header 'Accept: application/json'Returned if the requested groups are returned.
| Content type | Value |
|---|---|
| application/json | allOf [GroupArray, object] |
POST /wiki/rest/api/group
Creates a new user group.
Permissions required: User must be a site admin.
Apps cannot access this REST resource.
write:confluence-groupsstring
1 2 3 4 5 6 7
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'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.
Apps cannot access this REST resource.
write:confluence-groupsstring
Name of the group to delete.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group?name={name}'Returned if the group was removed successfully.
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).
App scope required: READ
read:confluence-groupsstring
The name of the group. This is the same as the group name shown in the Confluence administration console.
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group/by-name?name={name}' \
--header 'Accept: application/json'Returned if the requested group is returned.
| Content type | Value |
|---|---|
| application/json |
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).
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
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupName}' \
--header 'Accept: application/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).
App scope required: READ
read:confluence-groupsstring
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
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group/member?name={name}' \
--header 'Accept: 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).
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
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupName}/member' \
--header 'Accept: 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.
Apps cannot access this REST resource.
write:confluence-groupsstring
Name of the group whose membership is updated
string
1 2 3 4 5 6
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group/user?name={name}' \
--header 'Content-Type: application/json' \
--data '{
"accountId": "<string>"
}'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.
Apps cannot access this REST resource.
write:confluence-groupsstring
Name of the group whose membership is updated.
string
AccountId of the user whose membership is removed.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/group/user?name={name}&accountId={accountId}'Returned if the group was removed successfully.
Rate this page: