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.addAnonymousPermissionToSpaceSPACE_ADMIN
confluence1.addAnonymousPermissionsToSpaceSPACE_ADMIN
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.addPersonalSpaceWRITE
confluence1.addPersonalSpaceWithDefaultPermissionsWRITE
confluence1.addProfilePictureWRITE
confluence1.addSpaceSPACE_ADMIN
confluence1.addSpaceGroupSPACE_ADMIN
confluence1.addSpaceWithDefaultPermissionsSPACE_ADMIN
confluence1.convertWikiToStorageFormatREAD
confluence1.editCommentWRITE
confluence1.emptyTrashDELETE
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.getPermissionsForUserADMIN
confluence1.getRecentlyUsedLabelsREAD
confluence1.getRecentlyUsedLabelsInSpaceREAD
confluence1.getRelatedLabelsREAD
confluence1.getRelatedLabelsInSpaceREAD
confluence1.getServerInfoREAD
confluence1.getSpaceREAD
confluence1.getSpaceGroupREAD
confluence1.getSpaceGroupsREAD
confluence1.getSpaceLevelPermissionsREAD
confluence1.getSpaceStatusREAD
confluence1.getSpacesREAD
confluence1.getSpacesContainingContentWithLabelREAD
confluence1.getSpacesInGroupREAD
confluence1.getSpacesWithLabelREAD
confluence1.getTopLevelPagesREAD
confluence1.getTrashContentsREAD
confluence1.getUserADMIN
confluence1.getUserByKeyADMIN
confluence1.getUserByNameADMIN
confluence1.getUserGroupsADMIN
confluence1.getUserInformationADMIN
confluence1.getUserPreferenceBooleanADMIN
confluence1.getUserPreferenceLongADMIN
confluence1.getUserPreferenceStringADMIN
confluence1.getWatchersForPageREAD
confluence1.getWatchersForSpaceREAD
confluence1.hasGroupADMIN
confluence1.hasUserADMIN
confluence1.importSpaceADMIN
confluence1.isActiveUserADMIN
confluence1.isWatchingPageREAD
confluence1.isWatchingSpaceREAD
confluence1.isWatchingSpaceForTypeREAD
confluence1.moveAttachmentWRITE
confluence1.movePageWRITE
confluence1.movePageToTopLevelWRITE
confluence1.purgeFromTrashDELETE
confluence1.removeAllPermissionsForGroupADMIN
confluence1.removeAnonymousPermissionFromSpaceSPACE_ADMIN
confluence1.removeAnonymousUsePermissionADMIN
confluence1.removeAnonymousViewUserProfilePermissionADMIN
confluence1.removeAttachmentDELETE
confluence1.removeCommentDELETE
confluence1.removeGlobalPermissionADMIN
confluence1.removeLabelByIdDELETE
confluence1.removeLabelByNameDELETE
confluence1.removeLabelByNameFromSpaceDELETE
confluence1.removeLabelByObjectDELETE
confluence1.removePageDELETE
confluence1.removePageVersionByIdDELETE
confluence1.removePageVersionByVersionDELETE
confluence1.removePageWatchDELETE
confluence1.removePageWatchForUserDELETE
confluence1.removePermissionFromSpaceSPACE_ADMIN
confluence1.removeSpaceSPACE_ADMIN
confluence1.removeSpaceGroupSPACE_ADMIN
confluence1.removeSpaceWatchDELETE
confluence1.renderContentREAD
confluence1.searchREAD
confluence1.setContentPermissionsWRITE
confluence1.setSpaceStatusSPACE_ADMIN
confluence1.storeBlogEntryWRITE
confluence1.storePageWRITE
confluence1.storeSpaceSPACE_ADMIN
confluence1.updatePageWRITE
confluence1.watchPageWRITE
confluence1.watchPageForUserWRITE
confluence1.watchSpaceWRITE
confluence2.addAnonymousPermissionToSpaceSPACE_ADMIN
confluence2.addAnonymousPermissionsToSpaceSPACE_ADMIN
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.addPersonalSpaceWRITE
confluence2.addPersonalSpaceWithDefaultPermissionsWRITE
confluence2.addProfilePictureWRITE
confluence2.addSpaceSPACE_ADMIN
confluence2.addSpaceGroupSPACE_ADMIN
confluence2.addSpaceWithDefaultPermissionsSPACE_ADMIN
confluence2.convertWikiToStorageFormatREAD
confluence2.editCommentWRITE
confluence2.emptyTrashDELETE
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.getPermissionsForUserADMIN
confluence2.getRecentlyUsedLabelsREAD
confluence2.getRecentlyUsedLabelsInSpaceREAD
confluence2.getRelatedLabelsREAD
confluence2.getRelatedLabelsInSpaceREAD
confluence2.getServerInfoREAD
confluence2.getSpaceREAD
confluence2.getSpaceGroupREAD
confluence2.getSpaceGroupsREAD
confluence2.getSpaceLevelPermissionsREAD
confluence2.getSpaceStatusREAD
confluence2.getSpacesREAD
confluence2.getSpacesContainingContentWithLabelREAD
confluence2.getSpacesInGroupREAD
confluence2.getSpacesWithLabelREAD
confluence2.getTopLevelPagesREAD
confluence2.getTrashContentsREAD
confluence2.getUserADMIN
confluence2.getUserByKeyADMIN
confluence2.getUserByNameADMIN
confluence2.getUserGroupsADMIN
confluence2.getUserInformationADMIN
confluence2.getUserPreferenceBooleanADMIN
confluence2.getUserPreferenceLongADMIN
confluence2.getUserPreferenceStringADMIN
confluence2.getWatchersForPageREAD
confluence2.getWatchersForSpaceREAD
confluence2.hasGroupADMIN
confluence2.hasUserADMIN
confluence2.importSpaceADMIN
confluence2.isActiveUserADMIN
confluence2.isWatchingPageREAD
confluence2.isWatchingSpaceREAD
confluence2.isWatchingSpaceForTypeREAD
confluence2.moveAttachmentWRITE
confluence2.movePageWRITE
confluence2.movePageToTopLevelWRITE
confluence2.purgeFromTrashDELETE
confluence2.removeAllPermissionsForGroupADMIN
confluence2.removeAnonymousPermissionFromSpaceSPACE_ADMIN
confluence2.removeAnonymousUsePermissionADMIN
confluence2.removeAnonymousViewUserProfilePermissionADMIN
confluence2.removeAttachmentDELETE
confluence2.removeCommentDELETE
confluence2.removeGlobalPermissionADMIN
confluence2.removeLabelByIdDELETE
confluence2.removeLabelByNameDELETE
confluence2.removeLabelByNameFromSpaceDELETE
confluence2.removeLabelByObjectDELETE
confluence2.removePageDELETE
confluence2.removePageVersionByIdDELETE
confluence2.removePageVersionByVersionDELETE
confluence2.removePageWatchDELETE
confluence2.removePageWatchForUserDELETE
confluence2.removePermissionFromSpaceSPACE_ADMIN
confluence2.removeSpaceSPACE_ADMIN
confluence2.removeSpaceGroupSPACE_ADMIN
confluence2.removeSpaceWatchDELETE
confluence2.renderContentREAD
confluence2.searchREAD
confluence2.setContentPermissionsWRITE
confluence2.setSpaceStatusSPACE_ADMIN
confluence2.storeBlogEntryWRITE
confluence2.storePageWRITE
confluence2.storeSpaceSPACE_ADMIN
confluence2.updatePageWRITE
confluence2.watchPageWRITE
confluence2.watchPageForUserWRITE
confluence2.watchSpaceWRITE