Documentation

Confluence XML-RPC Scopes

For more information about the Confluence XML-RPC APIs, please consult the documentation on developer.atlassian.com and check out the Product API Browser.

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
confluence1.addAnonymousPermissionToSpaceADMIN
confluence1.addAnonymousPermissionsToSpaceADMIN
confluence1.addAnonymousUsePermissionADMIN
confluence1.addAnonymousViewUserProfilePermissionADMIN
confluence1.addAttachmentWRITE
confluence1.addCommentWRITE
confluence1.addGlobalPermissionADMIN
confluence1.addGlobalPermissionsADMIN
confluence1.addLabelByIdWRITE
confluence1.addLabelByNameWRITE
confluence1.addLabelByNameToSpaceWRITE
confluence1.addLabelByObjectWRITE
confluence1.addPermissionToSpaceSPACE_ADMIN
confluence1.addPermissionsToSpaceSPACE_ADMIN
confluence1.addPersonalSpaceADMIN
confluence1.addPersonalSpaceWithDefaultPermissionsADMIN
confluence1.addProfilePictureWRITE
confluence1.addSpaceADMIN
confluence1.addSpaceGroupADMIN
confluence1.addSpaceWithDefaultPermissionsADMIN
confluence1.convertWikiToStorageFormatREAD
confluence1.editCommentWRITE
confluence1.emptyTrashSPACE_ADMIN
confluence1.exportSiteADMIN
confluence1.exportSpaceADMIN
confluence1.getActiveUsersADMIN
confluence1.getAncestorsREAD
confluence1.getAttachmentREAD
confluence1.getAttachmentDataREAD
confluence1.getAttachmentsREAD
confluence1.getBlogEntriesREAD
confluence1.getBlogEntryREAD
confluence1.getBlogEntryByDateAndTitleREAD
confluence1.getBlogEntryByDayAndTitleREAD
confluence1.getChildrenREAD
confluence1.getClusterInformationADMIN
confluence1.getClusterNodeStatusesADMIN
confluence1.getCommentREAD
confluence1.getCommentsREAD
confluence1.getContentPermissionSetREAD
confluence1.getContentPermissionSetsREAD
confluence1.getDescendentsREAD
confluence1.getGroupsADMIN
confluence1.getLabelContentByIdREAD
confluence1.getLabelContentByNameREAD
confluence1.getLabelContentByObjectREAD
confluence1.getLabelsByDetailREAD
confluence1.getLabelsByIdREAD
confluence1.getMostPopularLabelsREAD
confluence1.getMostPopularLabelsInSpaceREAD
confluence1.getPageREAD
confluence1.getPageHistoryREAD
confluence1.getPagePermissionsREAD
confluence1.getPageSummaryREAD
confluence1.getPagesREAD
confluence1.getPermissionsREAD
confluence1.getPermissionsForUserSPACE_ADMIN
confluence1.getRecentlyUsedLabelsREAD
confluence1.getRecentlyUsedLabelsInSpaceREAD
confluence1.getRelatedLabelsREAD
confluence1.getRelatedLabelsInSpaceREAD
confluence1.getServerInfoREAD
confluence1.getSpaceREAD
confluence1.getSpaceGroupADMIN
confluence1.getSpaceGroupsADMIN
confluence1.getSpaceLevelPermissionsREAD
confluence1.getSpaceStatusREAD
confluence1.getSpacesREAD
confluence1.getSpacesContainingContentWithLabelREAD
confluence1.getSpacesInGroupREAD
confluence1.getSpacesWithLabelREAD
confluence1.getTopLevelPagesREAD
confluence1.getTrashContentsADMIN
confluence1.getUserREAD
confluence1.getUserByKeyREAD
confluence1.getUserByNameREAD
confluence1.getUserGroupsADMIN
confluence1.getUserInformationREAD
confluence1.getUserPreferenceBooleanWRITE
confluence1.getUserPreferenceLongWRITE
confluence1.getUserPreferenceStringWRITE
confluence1.getWatchersForPageSPACE_ADMIN
confluence1.getWatchersForSpaceSPACE_ADMIN
confluence1.hasGroupREAD
confluence1.hasUserREAD
confluence1.importSpaceADMIN
confluence1.isActiveUserREAD
confluence1.isWatchingPageSPACE_ADMIN
confluence1.isWatchingSpaceSPACE_ADMIN
confluence1.isWatchingSpaceForTypeSPACE_ADMIN
confluence1.moveAttachmentDELETE
confluence1.movePageWRITE
confluence1.movePageToTopLevelWRITE
confluence1.purgeFromTrashSPACE_ADMIN
confluence1.removeAllPermissionsForGroupADMIN
confluence1.removeAnonymousPermissionFromSpaceADMIN
confluence1.removeAnonymousUsePermissionADMIN
confluence1.removeAnonymousViewUserProfilePermissionADMIN
confluence1.removeAttachmentDELETE
confluence1.removeCommentDELETE
confluence1.removeGlobalPermissionADMIN
confluence1.removeLabelByIdWRITE
confluence1.removeLabelByNameWRITE
confluence1.removeLabelByNameFromSpaceWRITE
confluence1.removeLabelByObjectWRITE
confluence1.removePageDELETE
confluence1.removePageVersionByIdSPACE_ADMIN
confluence1.removePageVersionByVersionSPACE_ADMIN
confluence1.removePageWatchWRITE
confluence1.removePageWatchForUserSPACE_ADMIN
confluence1.removePermissionFromSpaceSPACE_ADMIN
confluence1.removeSpaceADMIN
confluence1.removeSpaceGroupADMIN
confluence1.removeSpaceWatchWRITE
confluence1.renderContentREAD
confluence1.searchREAD
confluence1.setContentPermissionsWRITE
confluence1.setSpaceStatusSPACE_ADMIN
confluence1.storeBlogEntryWRITE
confluence1.storePageWRITE
confluence1.storeSpaceADMIN
confluence1.updatePageWRITE
confluence1.watchPageWRITE
confluence1.watchPageForUserSPACE_ADMIN
confluence1.watchSpaceWRITE
confluence2.addAnonymousPermissionToSpaceADMIN
confluence2.addAnonymousPermissionsToSpaceADMIN
confluence2.addAnonymousUsePermissionADMIN
confluence2.addAnonymousViewUserProfilePermissionADMIN
confluence2.addAttachmentWRITE
confluence2.addCommentWRITE
confluence2.addGlobalPermissionADMIN
confluence2.addGlobalPermissionsADMIN
confluence2.addLabelByIdWRITE
confluence2.addLabelByNameWRITE
confluence2.addLabelByNameToSpaceWRITE
confluence2.addLabelByObjectWRITE
confluence2.addPermissionToSpaceSPACE_ADMIN
confluence2.addPermissionsToSpaceSPACE_ADMIN
confluence2.addPersonalSpaceADMIN
confluence2.addPersonalSpaceWithDefaultPermissionsADMIN
confluence2.addProfilePictureWRITE
confluence2.addSpaceADMIN
confluence2.addSpaceGroupADMIN
confluence2.addSpaceWithDefaultPermissionsADMIN
confluence2.convertWikiToStorageFormatREAD
confluence2.editCommentWRITE
confluence2.emptyTrashSPACE_ADMIN
confluence2.exportSiteADMIN
confluence2.exportSpaceADMIN
confluence2.getActiveUsersADMIN
confluence2.getAncestorsREAD
confluence2.getAttachmentREAD
confluence2.getAttachmentDataREAD
confluence2.getAttachmentsREAD
confluence2.getBlogEntriesREAD
confluence2.getBlogEntryREAD
confluence2.getBlogEntryByDateAndTitleREAD
confluence2.getBlogEntryByDayAndTitleREAD
confluence2.getChildrenREAD
confluence2.getClusterInformationADMIN
confluence2.getClusterNodeStatusesADMIN
confluence2.getCommentREAD
confluence2.getCommentsREAD
confluence2.getContentPermissionSetREAD
confluence2.getContentPermissionSetsREAD
confluence2.getDescendentsREAD
confluence2.getGroupsADMIN
confluence2.getLabelContentByIdREAD
confluence2.getLabelContentByNameREAD
confluence2.getLabelContentByObjectREAD
confluence2.getLabelsByDetailREAD
confluence2.getLabelsByIdREAD
confluence2.getMostPopularLabelsREAD
confluence2.getMostPopularLabelsInSpaceREAD
confluence2.getPageREAD
confluence2.getPageHistoryREAD
confluence2.getPagePermissionsREAD
confluence2.getPageSummaryREAD
confluence2.getPagesREAD
confluence2.getPermissionsREAD
confluence2.getPermissionsForUserSPACE_ADMIN
confluence2.getRecentlyUsedLabelsREAD
confluence2.getRecentlyUsedLabelsInSpaceREAD
confluence2.getRelatedLabelsREAD
confluence2.getRelatedLabelsInSpaceREAD
confluence2.getServerInfoREAD
confluence2.getSpaceREAD
confluence2.getSpaceGroupADMIN
confluence2.getSpaceGroupsADMIN
confluence2.getSpaceLevelPermissionsREAD
confluence2.getSpaceStatusREAD
confluence2.getSpacesREAD
confluence2.getSpacesContainingContentWithLabelREAD
confluence2.getSpacesInGroupREAD
confluence2.getSpacesWithLabelREAD
confluence2.getTopLevelPagesREAD
confluence2.getTrashContentsADMIN
confluence2.getUserREAD
confluence2.getUserByKeyREAD
confluence2.getUserByNameREAD
confluence2.getUserGroupsADMIN
confluence2.getUserInformationREAD
confluence2.getUserPreferenceBooleanWRITE
confluence2.getUserPreferenceLongWRITE
confluence2.getUserPreferenceStringWRITE
confluence2.getWatchersForPageSPACE_ADMIN
confluence2.getWatchersForSpaceSPACE_ADMIN
confluence2.hasGroupREAD
confluence2.hasUserREAD
confluence2.importSpaceADMIN
confluence2.isActiveUserREAD
confluence2.isWatchingPageSPACE_ADMIN
confluence2.isWatchingSpaceSPACE_ADMIN
confluence2.isWatchingSpaceForTypeSPACE_ADMIN
confluence2.moveAttachmentDELETE
confluence2.movePageWRITE
confluence2.movePageToTopLevelWRITE
confluence2.purgeFromTrashSPACE_ADMIN
confluence2.removeAllPermissionsForGroupADMIN
confluence2.removeAnonymousPermissionFromSpaceADMIN
confluence2.removeAnonymousUsePermissionADMIN
confluence2.removeAnonymousViewUserProfilePermissionADMIN
confluence2.removeAttachmentDELETE
confluence2.removeCommentDELETE
confluence2.removeGlobalPermissionADMIN
confluence2.removeLabelByIdWRITE
confluence2.removeLabelByNameWRITE
confluence2.removeLabelByNameFromSpaceWRITE
confluence2.removeLabelByObjectWRITE
confluence2.removePageDELETE
confluence2.removePageVersionByIdSPACE_ADMIN
confluence2.removePageVersionByVersionSPACE_ADMIN
confluence2.removePageWatchWRITE
confluence2.removePageWatchForUserSPACE_ADMIN
confluence2.removePermissionFromSpaceSPACE_ADMIN
confluence2.removeSpaceADMIN
confluence2.removeSpaceGroupADMIN
confluence2.removeSpaceWatchWRITE
confluence2.renderContentREAD
confluence2.searchREAD
confluence2.setContentPermissionsWRITE
confluence2.setSpaceStatusSPACE_ADMIN
confluence2.storeBlogEntryWRITE
confluence2.storePageWRITE
confluence2.storeSpaceADMIN
confluence2.updatePageWRITE
confluence2.watchPageWRITE
confluence2.watchPageForUserSPACE_ADMIN
confluence2.watchSpaceWRITE