To generate documents automatically and attach them to your Jira issues, the app requires certain permissions. Here is a simplified explanation of why each set of permissions is needed:
📂 Reading Issue and Field Data
-
Scopes:
read:jira-work,read:user:jira,read:jira-user -
Purpose: To fill out your templates, the app needs to read information from your Jira issues, such as the Summary, Description, and any custom fields you have set up. It also needs to see who is assigned to an issue or who reported it so that their names can appear correctly in your generated documents.
📎 Attaching Documents
-
Scopes:
write:attachment:jira,read:attachment:jira,write:jira-work -
Purpose: The primary function of the app is to create a document and save it back to your Jira issue. These permissions allow the app to upload the final
.docxor.pdffiles directly to the relevant issue for your team to access.
📝 Support for JSM Forms
-
Scope:
read:servicedesk-request -
Purpose: If you use Jira Service Management (JSM), this app can extract data from the forms your customers fill out. This permission allows the app to "see" those form answers so it can include them in your document templates.
💾 Template Storage
-
Scope:
storage:app -
Purpose: The app needs its own "filing cabinet" within the Atlassian cloud to store the
.docxtemplates you upload in the admin settings. This ensures your templates are always available whenever an automation is triggered.
⚙️ App Security and Identity
-
Scopes:
read:app-user-token,read:app-system-token,report:personal-data,read:avatar:jira -
Purpose: These are technical requirements that allow the app to securely identify itself and act on your behalf within Atlassian’s security guidelines. They ensure that all document generation is performed safely and follows your site's privacy rules.