REST API - Global Permissions
- Adam Labus
Available since v. 2.23.0
Get all global permissions
Available for Confluence Administrators
This API supports Pagination
Method type: GET
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/getAllGlobalPermissions
Response format: JSON
Example response:
{
"total": 3,
"permissions": [
{
"permissionType": "USECONFLUENCE",
"groupName": "confluence-administrators",
"isGroupPermission": true,
"isAnonymousPermission": false,
"isUserPermission": false
},
{
"permissionType": "USECONFLUENCE",
"isGroupPermission": false,
"isAnonymousPermission": false,
"userName": "admin",
"isUserPermission": true
},
{
"permissionType": "VIEWUSERPROFILES",
"isGroupPermission": false,
"isAnonymousPermission": true,
"isUserPermission": false
}
],
"maxResults": 100,
"startAt": 0
}
Get all global permissions (Groups)
Available for Confluence Administrators
Method type: GET
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/getAllGlobalPermissions
Response format: JSON
Example response:
{
"total": 2,
"permissions": [
{
"permissionType": "USECONFLUENCE",
"groupName": "confluence-administrators"
},
{
"permissionType": "PERSONALSPACE",
"groupName": "confluence-users"
}
],
"maxResults": 100,
"startAt": 0
}
Get all global permissions (Users)
Method type: GET
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/getAllGlobalPermissions
Response format: JSON
Example response:
{
"total": 2,
"permissions": [
{
"permissionType": "SYSTEMADMINISTRATOR",
"userName": "admin"
},
{
"permissionType": "USECONFLUENCE",
"userName": "user"
}
],
"maxResults": 100,
"startAt": 0
}
Add user to global permissions
Method type: PUT
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/{USER_NAME}/permission/{PERMISSION_TYPE}/addGlobalPermission
where {USER_NAME} is the user name
where {PERMISSION_TYPE} is the permission type from REST API - Global Permissions | Get all global permission types
Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/johnny.bravo/permission/USECONFLUENCE/addGlobalPermission
Add group to global permissions
Method type: PUT
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/{GROUP_NAME}/permission/{PERMISSION_TYPE}/addGlobalPermission
where {GROUP_NAME} is the group name
where {PERMISSION_TYPE} is the permission type from REST API - Global Permissions | Get all global permission types
Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/my_new_group/permission/SYSTEMADMINISTRATOR/addGlobalPermission
Remove user global permission
Method type: DELETE
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/{USER_NAME}/permission/{PERMISSION_TYPE}/removeGlobalPermission
where {USER_NAME} is the user name
where {PERMISSION_TYPE} is the permission type from REST API - Global Permissions | Get all global permission types
Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/johnny.bravo/permission/USECONFLUENCE/removeGlobalPermission
Remove group global permission
Method type: DELETE
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/{GROUP_NAME}/permission/{PERMISSION_TYPE}/removeGlobalPermission
where {GROUP_NAME} is the group name
where {PERMISSION_TYPE} is the permission type from REST API - Global Permissions | Get all global permission types
Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/my_new_group/permission/SYSTEMADMINISTRATOR/removeGlobalPermission
Get all global permission types
Method type: GET
URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/permissionTypes
Response format: JSON
Example response:
Pagination
This REST API uses pagination to improve performance for all users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:
Where:
startAtis the index of the first item returned in the page of results.maxResultsis the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 100)totalis the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.