Permissions

The permissions section of the manifest.yml file controls your app's access to remote resources.

OAuth 2 scopes

The scopes list declares which OAuth 2 scopes are required by your app when using the authenticated Product Fetch APIs, and Product events.

Example

Define each scope on a new line. Your app should use the minimum set of scopes required.

1
2
3
4

permissions:
  scopes:
    - 'read:confluence-content.summary'
    - 'write:jira-work'

If your app requires no OAuth 2 permissions, you must provide an empty scopes list as in the example below.

1
2

permissions:
  scopes: []

Note, Forge apps deployed in the development environment always receive all available OAuth 2 scopes.

Forge scopes

Certain platform features, such as the App storage API, are also authenticated using OAuth 2.

Product scopes

In addition to the reference tables below, you can find the required scopes in each product's REST API documentation and event documentation on a per-operation basis in the OAuth scopes required field. Note, not all operations support OAuth 2 authentication.

Confluence Cloud

The Confluence Cloud REST API and Confluence event scopes.

Jira Cloud platform

The Jira Cloud REST API and Jira event scopes.

Compass

The Compass GraphQL API scopes.

Content permissions

The content section declares which Content Security Policy (CSP) options are required by your app when using custom UI.

Scripts

The scripts list declares which sources are allowed for an app's script-src policy.

Example

In the example below, script-src 'unsafe-hashes' is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  content:
    scripts:
      - 'unsafe-hashes'

Styles

The styles list declares which sources are allowed for an app's style-src policy.

Example

In the example below, style-src 'unsafe-inline' is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  content:
    styles:
      - 'unsafe-inline'

External permissions

The external section declares the external resources that your custom UI app is allowed to access.

In addition, it also covers which external website your Forge function is allowed to communicate with. This covers both Custom UI resolvers and any other Forge functions.

In each section, you can add a list of external domains, which end up as a source in an equivalent CSP directive.

Valid domain formats

External domains must be in one of the following formats:

• An https or wss URL, such as https://www.example-dev.com
• A valid domain name, such as www.example-dev.com
• A valid wildcard domain starting with *, such as *.example-dev.com
• A generic wildcard to support every domain: *

External domains must not contain any invalid special characters. You can check your domain with the following regex pattern:

1

^(\*\.)?[.a-zA-Z0-9_\-\/:~#%]+$

Fetch

The fetch section has the following configurations, backend and client.

Backend

The fetch.backend list declares which external domains your Forge functions can talk to. This applies to both custom UI resolvers and any other Forge functions.

Example

In the example below, *.example-dev.com is allowed for all of the calls that your Forge function is making:

1
2
3
4
5

permissions:
  external:
    fetch:
      backend:
        - '*.example-dev.com'

Note, calls made to any domain that is not defined in the manifest.yml file of your app will be rejected. Learn more about runtime egress permissions.

Client

The fetch.client list declares which external sources are allowed for an app's connect-src policy.

Example

In the example below, connect-src *.example-dev.com is included in the CSP header for all modules using custom UI:

1
2
3
4
5

permissions:
  external:
    fetch:
      client:
        - '*.example-dev.com'

Note, using a wildcard such as *.example-dev.com for CSP does not include the parent domain. If you need to support both, explicitly add the parent domain as a second entry.

Fonts

The fonts list declares which external sources are allowed for an app's font-src policy.

Example

In the example below, font-src https://www.example-dev.com/fonts.css is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  external:
    fonts:
      - 'https://www.example-dev.com/fonts.css'

Frames

The frames list declares which external sources are allowed for an app's frame-src policy.

Example

In the example below, frame-src https://www.example-dev.com/embed/page is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  external:
    frames:
      - 'https://www.example-dev.com/embed/page'

Images

The images list declares which external sources are allowed for an app's img-src policy.

Example

In the example below, img-src https://www.example-dev.com/image.png is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  external:
    images:
      - 'https://www.example-dev.com/image.png'

Media

The media list declares which external sources are allowed for an app's media-src policy.

Example

In the example below, media-src https://www.example-dev.com/video.mp4 is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  external:
    media:
      - 'https://www.example-dev.com/video.mp4'

Scripts

The scripts list declares which external sources are allowed for an app's script-src policy.

Example

In the example below, script-src https://www.example-dev.com/script.js is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  external:
    scripts:
      - 'https://www.example-dev.com/script.js'

Styles

The styles list declares which external styles are allowed for an app's style-src policy.

Example

In the example below, style-src https://www.example-dev.com/stylesheet.css is included in the CSP header for all modules using custom UI:

1
2
3
4

permissions:
  external:
    styles:
      - 'https://www.example-dev.com/stylesheet.css'