Configure access for a scoped token

Added in version 2.15.

Note

Scoped tokens only apply to Confluence Cloud.

Setup a scoped token

To create a scoped token, venture to a user’s API token management page:

On this page:

  • Select the button Create API token with scopes.

  • Name the API token and configure a desired expiry date.

  • Select the Confluence application.

  • Check each of the following scopes required for this extension:

    • read:attachment:confluence

    • read:content-details:confluence

    • read:content.metadata:confluence

    • read:content.property:confluence

    • read:page:confluence

    • read:space:confluence

    • write:attachment:confluence

    • write:content.property:confluence

    • write:page:confluence

    • write:watcher:confluence

    • delete:attachment:confluence

    • delete:page:confluence

  • Review and create.

Configuring the extension

Using a scoped token requires at least one of the following two configuration changes. The easiest option is to hint to this extension that a scoped token is being used by configuring:

confluence_api_token_scoped = True

This should help automatically resolve a modern API endpoint for Confluence interaction. Alternatively, if wanting to explicitly configure the modern API endpoint, determine a space’s Cloud identifier (if not already) by venturing to:

https://<SPACE>.atlassian.net/_edge/tenant_info

For example:

https://example.atlassian.net/_edge/tenant_info

This page should provide a GUID value which can be used in a modern Confluence API endpoint required for scoped tokens:

confluence_server_url = 'https://api.atlassian.com/ex/confluence/<GUID>/'

For example:

confluence_server_url = 'https://api.atlassian.com/ex/confluence/550e8400-e29b-41d4-a716-446655440000/'