Specifies the OAuth scopes that provider requests when authenticating with Confluence.

Syntax

Connect-Confluence -Scope string

Data Type

cstr

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

By default, the cmdlet requests all scopes required to access Confluence content and metadata. You can override this behavior by setting a space-separated list of scopes.

If you override the scopes, the OAuth app configured in Atlassian must also include the same scopes to prevent authorization failures.

For Cloud instances, the default scopes are: read:content:confluence read:content-details:confluence read:space-details:confluence read:analytics.content:confluence read:audit-log:confluence read:configuration:confluence read:page:confluence read:blogpost:confluence read:custom-content:confluence read:attachment:confluence read:comment:confluence read:template:confluence read:label:confluence read:content.permission:confluence read:content.property:confluence read:content.restriction:confluence read:content.metadata:confluence read:watcher:confluence read:group:confluence read:inlinetask:confluence read:relation:confluence read:space:confluence read:space.permission:confluence read:space.property:confluence read:space.setting:confluence read:user:confluence offline_access.

For Server instances, the default scopes are: READ WRITE

This property is useful when you want to restrict or customize the permissions granted to your OAuth application.