REST API - Global Permissions

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:

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 { "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:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "total": 2, "permissions": [ { "permissionType": "USECONFLUENCE", "groupName": "confluence-administrators" }, { "permissionType": "PERSONALSPACE", "groupName": "confluence-users" } ], "maxResults": 100, "startAt": 0 }

 


Get all global permissions (Users)

Available for Confluence Administrators

Method type: GET

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/getAllGlobalPermissions

Response format: JSON

Example response:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "total": 2, "permissions": [ { "permissionType": "SYSTEMADMINISTRATOR", "userName": "admin" }, { "permissionType": "USECONFLUENCE", "userName": "user" } ], "maxResults": 100, "startAt": 0 }

 


Add user to global permissions

Available only for Confluence Administrators

Method type: PUT

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/{USER_NAME}/permission/{PERMISSION_TYPE}/addGlobalPermission

Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/johnny.bravo/permission/USECONFLUENCE/addGlobalPermission

 


Add group to global permissions

Available only for Confluence Administrators

Method type: PUT

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/{GROUP_NAME}/permission/{PERMISSION_TYPE}/addGlobalPermission

Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/my_new_group/permission/SYSTEMADMINISTRATOR/addGlobalPermission

 


Remove user global permission

Available only for Confluence Administrators

Method type: DELETE

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/user/{USER_NAME}/permission/{PERMISSION_TYPE}/removeGlobalPermission

Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/johnny.bravo/permission/USECONFLUENCE/removeGlobalPermission

 


Remove group global permission

Available only for Confluence Administrators

Method type: DELETE

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/{GROUP_NAME}/permission/{PERMISSION_TYPE}/removeGlobalPermission

Example request: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/group/my_new_group/permission/SYSTEMADMINISTRATOR/removeGlobalPermission

 


Get all global permission types

Available for Confluence Administrators

Method type: GET

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/global/permissionTypes

Response format: JSON

Example response:

1 2 3 4 [ "USECONFLUENCE", "PERSONALSPACE", "CREATESPACE", "ADMINISTRATECONFLUENCE", "SYSTEMADMINISTRATOR" ]

 


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:

1 2 3 4 5 6 7 8 9 10 {     "startAt" : 0,     "maxResults" : 10,     "total": 200,     "objects": [         { /* result 0 */ },         { /* result 1 */ },         { /* result 2 */ }     ] }

Where:

  • startAt is the index of the first item returned in the page of results.

  • maxResults is 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)

  • total is 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.