Documentation

Confluence JSON-RPC Scopes

For more information about the Confluence JSON-RPC APIs, please consult the documentation on developer.atlassian.com.

Both version 1 and 2 of JSON-RPC are supported, i.e. RPC calls to the following endpoints are covered:

  • /confluenceservice-v1
  • /confluenceservice-v2

The required scope for your add-on depends on the methods that your add-on invokes. The table below shows the required scope for every RPC method call.
MethodScope
addAnonymousPermissionToSpaceADMIN
addAnonymousPermissionsToSpaceADMIN
addAnonymousUsePermissionADMIN
addAnonymousViewUserProfilePermissionADMIN
addAttachmentWRITE
addCommentWRITE
addGlobalPermissionADMIN
addGlobalPermissionsADMIN
addLabelByIdWRITE
addLabelByNameWRITE
addLabelByNameToSpaceWRITE
addLabelByObjectWRITE
addPermissionToSpaceSPACE_ADMIN
addPermissionsToSpaceSPACE_ADMIN
addPersonalSpaceADMIN
addPersonalSpaceWithDefaultPermissionsADMIN
addSpaceADMIN
addSpaceGroupADMIN
addSpaceWithDefaultPermissionsADMIN
convertWikiToStorageFormatREAD
editCommentWRITE
emptyTrashSPACE_ADMIN
exportSiteADMIN
exportSpaceADMIN
getActiveUsersADMIN
getAncestorsREAD
getAttachmentREAD
getAttachmentDataREAD
getAttachmentsREAD
getBlogEntriesREAD
getBlogEntryREAD
getBlogEntryByDateAndTitleREAD
getBlogEntryByDayAndTitleREAD
getChildrenREAD
getClusterInformationADMIN
getClusterNodeStatusesADMIN
getCommentREAD
getCommentsREAD
getContentPermissionSetREAD
getContentPermissionSetsREAD
getDescendentsREAD
getGroupsADMIN
getLabelContentByIdREAD
getLabelContentByNameREAD
getLabelContentByObjectREAD
getLabelsByDetailREAD
getLabelsByIdREAD
getMostPopularLabelsREAD
getMostPopularLabelsInSpaceREAD
getPageREAD
getPageHistoryREAD
getPagePermissionsREAD
getPageSummaryREAD
getPagesREAD
getPermissionsREAD
getPermissionsForUserSPACE_ADMIN
getRecentlyUsedLabelsREAD
getRecentlyUsedLabelsInSpaceREAD
getRelatedLabelsREAD
getRelatedLabelsInSpaceREAD
getServerInfoREAD
getSpaceREAD
getSpaceGroupADMIN
getSpaceGroupsADMIN
getSpaceLevelPermissionsREAD
getSpacePermissionSetSPACE_ADMIN
getSpacePermissionSetsSPACE_ADMIN
getSpaceStatusREAD
getSpacesREAD
getSpacesContainingContentWithLabelREAD
getSpacesInGroupREAD
getSpacesWithLabelREAD
getTopLevelPagesREAD
getTrashContentsADMIN
getUserREAD
getUserByKeyREAD
getUserByNameREAD
getUserGroupsADMIN
getUserInformationREAD
getUserPreferenceBooleanWRITE
getUserPreferenceLongWRITE
getUserPreferenceStringWRITE
getWatchersForPageSPACE_ADMIN
getWatchersForSpaceSPACE_ADMIN
hasGroupREAD
hasUserREAD
importSpaceADMIN
isActiveUserREAD
isWatchingPageSPACE_ADMIN
isWatchingSpaceSPACE_ADMIN
isWatchingSpaceForTypeSPACE_ADMIN
moveAttachmentDELETE
movePageWRITE
movePageToTopLevelWRITE
purgeFromTrashSPACE_ADMIN
removeAllPermissionsForGroupADMIN
removeAnonymousPermissionFromSpaceADMIN
removeAnonymousUsePermissionADMIN
removeAnonymousViewUserProfilePermissionADMIN
removeAttachmentDELETE
removeCommentDELETE
removeGlobalPermissionADMIN
removeLabelByIdWRITE
removeLabelByNameWRITE
removeLabelByNameFromSpaceWRITE
removeLabelByObjectWRITE
removePageDELETE
removePageVersionByIdSPACE_ADMIN
removePageVersionByVersionSPACE_ADMIN
removePageWatchWRITE
removePageWatchForUserSPACE_ADMIN
removePermissionFromSpaceSPACE_ADMIN
removeSpaceADMIN
removeSpaceGroupADMIN
removeSpaceWatchWRITE
renderContentREAD
searchREAD
setContentPermissionsWRITE
setSpaceStatusSPACE_ADMIN
storeBlogEntryWRITE
storePageWRITE
storeSpaceADMIN
updatePageWRITE
watchPageWRITE
watchPageForUserSPACE_ADMIN
watchSpaceWRITE