Confluence API Scopes

Details Confluence API scopes used by Fellow for our Confluence integration

Amin Mirzaee avatar
Written by Amin Mirzaee
Updated over a week ago

If you or your IT team are looking for more information about the Confluence API scopes used by Fellow, the following article can help.

Confluence API Scopes

Fellow uses the OAuth2 protocol in order to connect to the Confluence API on behalf of users to access the necessary data for our Confluence integration. OAuth2 provides built-in security mechanisms where Fellow can only access resources based on the "scopes" which it is authorized for.

Delegated Scopes

Below is a list if all of the scopes that Fellow requires, along with the reasons behind each.

The following scopes govern what data Fellow can access from each user's Confluence account.

  • write:confluence-content

    Description: Write Confluence content

    Request Reason: This scope permits the creation of pages, blogs, comments and questions. Fellow uses it to allow exporting Fellow notes into Confluence pages. This API is only used while the user is in-app.

  • write:confluence-props

    Description: Write Confluence content properties

    Request Reason: Allows Fellow to write properties to Confluence content. Fellow adds special properties to the pages exported to Confluence, so that they may be identified later. This API is only used while the user is in-app.
    โ€‹

  • read:confluence-props

    Description: Read Confluence content properties

    Request Reason: Allows Fellow to read properties of Confluence content. Fellow uses this to look for the special properties we add to content, so that we can identify our exported content. This API is only used while the user is in-app.

  • search:confluence

    Description: Search Confluence content and space summaries

    Request Reason: Allows Fellow to search through confluence pages. We require this scope in order to allow people to select which parent page to export their confluence content to. This API is only used while the user is in-app.

  • read:confluence-content.summary

    Description: Read a summary of the content without expansions.

    Request Reason: Fellow uses this to display a summary of the content returned by search. This API is only used while the user is in-app.
    โ€‹

  • read:confluence-space.summary

    Description: Read a summary of space information without expansions.

    Request Reason: Fellow uses this to display a summary of spaces, so that users may select the appropriate place to export their Fellow notes into. This API is only used while the user is in-app.

Did this answer your question?