Advanced

Publishing permissions

An account used for authentication will have the best experience with the following permissions when attempting to publish to a configured space:

  • Space – View

  • Page – Add, Delete

  • Attachments – Add, Delete

Delete permissions are only required for environments using the confluence_cleanup_purge (ref) capabilitity.

For environments using an OAuth connector, the following scopes are required:

delete:content:confluence
read:content-details:confluence
write:attachment:confluence
write:content:confluence
write:watcher:confluence

Wiping a space

Danger

Pages removed from this call cannot be recovered without the help of an administrator for the Confluence space which pages will be removed from.

A command line argument wipe is available for users wishing to remove pages from a configured space. This can be useful for users who need to clear multiple pages which have been pushed through automation or if the Confluence instance does not support automatically deleting page children.

A wipe request can be started using the following:

$ python -m sphinxcontrib.confluencebuilder wipe --danger
...

Are you sure you want to continue? [y/N] y

         URL: https://intranet-wiki.example.com/
       Space: TEST
       Pages: All Pages
 Total pages: 250

Are you sure you want to REMOVE these pages? [y/N] y

Removing pages.... done

If a user wishes to only remove child pages of a configured parent page, the option --parent can be used:

python -m sphinxcontrib.confluencebuilder wipe --danger --parent