Last updated Nov 21, 2024

Scopes for Connect apps

Scopes enable an app to request a level of access to an Atlassian product.

The scopes may provide the potential to access beta or non-public APIs that are later changed or removed from the Atlassian product. The inclusion of the API endpoint in a scope doesn't imply that the product makes this endpoint public. Read the Confluence Cloud REST API documentation for details.
Some scopes automatically imply that the app is granted other scopes.

Scopes for Atlassian Connect apps

If you are building an Atlassian Connect app for Confluence, use the following scopes:

Scope name	Description	Implied scopes
`NONE`	Access app-defined data. This scope doesn't need to be declared in the descriptor.
`READ`	View, browse, read information from Confluence.	`NONE`
`WRITE`	Can create or edit content in Confluence, but not delete them.	`READ`, `NONE`
`DELETE`	Delete entities from Confluence.	`WRITE`, `READ`, `NONE`
`SPACE_ADMIN`	Administer a space in Confluence.	`DELETE`, `WRITE`, `READ`, `NONE`
`ADMIN`	Administer the entire Confluence instance.	`SPACE_ADMIN`, `DELETE`, `WRITE`, `READ`, `NONE`
`ACT_AS_USER`	Access content using the permissions of the user running the app.
`ACCESS_EMAIL_ADDRESSES`	Get the email addresses of users.

Scope names can be provided in all lowercase or all upper case, for example, read or READ.

Scopes are declared as a top level attribute of atlassian-connect.json app descriptor as in this example:

1
2
{
    "baseUrl": "http://my-addon.com",
    "key": "atlassian-connect-addon",
    "scopes": [
        "read", "write"
    ],
    "modules": {}
}