Confluence JSON-RPC Scopes
For more information about the Confluence JSON-RPC APIs, please consult the documentation on developer.atlassian.com
and check out the Product API Browser.
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.| Method | Scope |
|---|
addAnonymousPermissionToSpace | ADMIN |
addAnonymousPermissionsToSpace | ADMIN |
addAnonymousUsePermission | ADMIN |
addAnonymousViewUserProfilePermission | ADMIN |
addAttachment | WRITE |
addComment | WRITE |
addGlobalPermission | ADMIN |
addGlobalPermissions | ADMIN |
addLabelById | WRITE |
addLabelByName | WRITE |
addLabelByNameToSpace | WRITE |
addLabelByObject | WRITE |
addPermissionToSpace | SPACE_ADMIN |
addPermissionsToSpace | SPACE_ADMIN |
addPersonalSpace | ADMIN |
addPersonalSpaceWithDefaultPermissions | ADMIN |
addProfilePicture | WRITE |
addSpace | ADMIN |
addSpaceGroup | ADMIN |
addSpaceWithDefaultPermissions | ADMIN |
convertWikiToStorageFormat | READ |
editComment | WRITE |
emptyTrash | SPACE_ADMIN |
exportSite | ADMIN |
exportSpace | ADMIN |
getActiveUsers | ADMIN |
getAncestors | READ |
getAttachment | READ |
getAttachmentData | READ |
getAttachments | READ |
getBlogEntries | READ |
getBlogEntry | READ |
getBlogEntryByDateAndTitle | READ |
getBlogEntryByDayAndTitle | READ |
getChildren | READ |
getClusterInformation | ADMIN |
getClusterNodeStatuses | ADMIN |
getComment | READ |
getComments | READ |
getContentPermissionSet | READ |
getContentPermissionSets | READ |
getDescendents | READ |
getGroups | ADMIN |
getLabelContentById | READ |
getLabelContentByName | READ |
getLabelContentByObject | READ |
getLabelsByDetail | READ |
getLabelsById | READ |
getMostPopularLabels | READ |
getMostPopularLabelsInSpace | READ |
getPage | READ |
getPageHistory | READ |
getPagePermissions | READ |
getPageSummary | READ |
getPages | READ |
getPermissions | READ |
getPermissionsForUser | SPACE_ADMIN |
getRecentlyUsedLabels | READ |
getRecentlyUsedLabelsInSpace | READ |
getRelatedLabels | READ |
getRelatedLabelsInSpace | READ |
getServerInfo | READ |
getSpace | READ |
getSpaceGroup | ADMIN |
getSpaceGroups | ADMIN |
getSpaceLevelPermissions | READ |
getSpaceStatus | READ |
getSpaces | READ |
getSpacesContainingContentWithLabel | READ |
getSpacesInGroup | READ |
getSpacesWithLabel | READ |
getTopLevelPages | READ |
getTrashContents | ADMIN |
getUser | READ |
getUserByKey | READ |
getUserByName | READ |
getUserGroups | ADMIN |
getUserInformation | READ |
getUserPreferenceBoolean | WRITE |
getUserPreferenceLong | WRITE |
getUserPreferenceString | WRITE |
getWatchersForPage | SPACE_ADMIN |
getWatchersForSpace | SPACE_ADMIN |
hasGroup | READ |
hasUser | READ |
importSpace | ADMIN |
isActiveUser | READ |
isWatchingPage | SPACE_ADMIN |
isWatchingSpace | SPACE_ADMIN |
isWatchingSpaceForType | SPACE_ADMIN |
moveAttachment | DELETE |
movePage | WRITE |
movePageToTopLevel | WRITE |
purgeFromTrash | SPACE_ADMIN |
removeAllPermissionsForGroup | ADMIN |
removeAnonymousPermissionFromSpace | ADMIN |
removeAnonymousUsePermission | ADMIN |
removeAnonymousViewUserProfilePermission | ADMIN |
removeAttachment | DELETE |
removeComment | DELETE |
removeGlobalPermission | ADMIN |
removeLabelById | WRITE |
removeLabelByName | WRITE |
removeLabelByNameFromSpace | WRITE |
removeLabelByObject | WRITE |
removePage | DELETE |
removePageVersionById | SPACE_ADMIN |
removePageVersionByVersion | SPACE_ADMIN |
removePageWatch | WRITE |
removePageWatchForUser | SPACE_ADMIN |
removePermissionFromSpace | SPACE_ADMIN |
removeSpace | ADMIN |
removeSpaceGroup | ADMIN |
removeSpaceWatch | WRITE |
renderContent | READ |
search | READ |
setContentPermissions | WRITE |
setSpaceStatus | SPACE_ADMIN |
storeBlogEntry | WRITE |
storePage | WRITE |
storeSpace | ADMIN |
updatePage | WRITE |
watchPage | WRITE |
watchPageForUser | SPACE_ADMIN |
watchSpace | WRITE |