- Audience and purpose
- At a glance: secure-by-default
- Day 0: pre-install considerations
- Day 1: post-install checklist
- Week 1: first-week monitoring
- Ongoing: monthly checklist
- Delegation playbook
- JSM portal specifics
- Template security
- Incident response quick reference
- Other security docs
Audience and purpose
This guide is for the Jira site administrator who installs Message Field for Jira Cloud (or inherits an existing installation) and needs to confirm that the configuration is production-ready. It does not replace the per-feature reference docs - it walks you through them in the right order, with the safest defaults flagged.
Read this once during install, then return to the Ongoing checklist on a monthly cadence. For a high-level view of what scopes the app requests, see the Permissions Reference. For a security review or DPIA, see the Security Reference for Auditors.
At a glance: secure-by-default
Message Field ships with conservative defaults. Most are safe to keep; a few are opt-in by intention.
| Setting | Default | Notes |
|---|---|---|
| Configuration management | Site admins only | Project admins gain access only when delegation is enabled per project |
| Actor policy on panels | Viewing user | The most restrictive option. Any other actor - the app identity, or a specific named Jira account - must be selected explicitly per panel by a site admin |
| Modules enabled | Controlled per module on the admin page | 14 toggles, one per rendering module: Issue Panel, Issue Activity, Issue Context, Issue Action, Custom Field, Dashboard Gadget, the app’s own Global Page and Project Page, the four JSM portal modules (Panel, Header, Subheader, Footer) and the two JSM create-form modules. There is no UI Modifications toggle and no Rovo toggle - see the note below the table. See Modules |
| JSM portal panels | unlicensedAccess: customer, unlicensed |
Required for JSM portal use cases; restrict via display conditions if any panel must not face external customers |
| Outbound network | None except weekly GDPR account report | No external: scopes declared. The app cannot make arbitrary HTTP calls. Module icon images are served from jibrok.com to the end user’s browser and carry no data - see the network allowlist |
| Forge platform encryption | At rest, Forge-managed | Configurations are stored in Forge KV (storage:app); transport is HTTPS via Forge ingress |
| Template engine sandbox | Always on | No eval, no fetch, no filesystem; iteration cap and 800 ms timeout per render |
| Issue mutation by the app | None | The app does not declare write:jira-work; it cannot create, update, transition, or delete work items. Its five write scopes are administrative only - see What the app writes |
| Personal data storage | Atlassian accountId only (creator, updater and actor attribution) |
No work item data is persisted; all issue content is fetched at render time |
Two things you cannot turn off. The module toggles cover the 14 rendering modules and nothing else. UI Modifications have no toggle - the app registers them for the configurations that need them, and the hourly
uim-sync-schedulerkeeps them in step; the way to remove a UIM is to disable or delete the configuration behind it, or to use the bulk UIM operations on the Modules page. The Rovo agents have no toggle either - their availability is governed by whether Rovo is enabled for your Atlassian site and whether a user holds a Rovo plan, which is an Atlassian-side control, not a Message Field one.
Day 0: pre-install considerations
Before clicking Install on the Marketplace listing:
- Review the Permissions Reference and the scope prompt that Jira will show during install.
- Coordinate with your DPO or privacy officer using the DPA.
- Decide who in your organization will hold Message Field admin access. Message Field admin = Jira site admin - there is no separate role.
- If you plan to delegate configuration management to project admins, decide which projects qualify and document the policy. Delegation is opt-in per project and can be revoked at any time.
- If you plan to use JSM portal panels, plan how to prevent leaking internal data to external customers - portal modules render content with
unlicensedAccess: customer, unlicensedby design. - If you run separate Jira sites for testing and production, install Message Field on each and validate configuration changes on the test site first.
Day 1: post-install checklist
Walk through these in order on the day you install Message Field. Most checks take less than 5 minutes each.
- Verify install context. Open Apps -> Manage your apps -> Message Field in Jira and confirm the version, Marketplace listing source, and installer match what you expect.
- Review module toggles. Open the global admin page (Apps -> Message Panel Settings). Disable any of the registered modules you do not plan to use - the safer the surface area, the smaller the blast radius. See Modules for what each module does.
- Decide on JSM portal exposure. If you do not have JSM portal use cases, disable the JSM portal modules globally now. If you do, plan to use display conditions and context filters to scope every JSM panel to the right request types and projects.
- Review actor defaults. Confirm that no existing panel uses a non-default actor without a documented JSM-portal or operational reason. The default - Viewing user - is safe for almost every use case. Note that the alternatives are not limited to the app identity: a site admin can pin a configuration to any named Jira account, and every viewer of that panel then reads through that account’s permissions. List the non-default actors and check each chosen account against the panel’s audience. See Impersonation in practice.
- Configure delegation deliberately. Open Apps -> Message Panel Settings -> Delegation and either keep delegation off (site-admin-only) or enable it for a specific list of projects. Avoid blanket all-projects delegation. See Delegation.
- Document who has Jira admin access. Anyone with Jira site admin can manage Message Field. Treat the Jira admin list as the Message Field admin list.
- Test a minimal panel. Create a “Hello world” panel scoped to a single project, view an issue in that project, confirm the panel renders, then disable it. This confirms the module toggle, configuration storage, and template rendering pipelines all work end to end.
- Personal-data reporting needs no action. The weekly
personal-data-reporttrigger is part of the app manifest: it submits the stored account IDs to Atlassian’s Personal Data Reporting API and applies the erase and refresh actions Atlassian returns, without administrator involvement. - Document your escalation paths. Who responds to a security incident? Who handles license expiry? Both are admin-only events.
Week 1: first-week monitoring
Once Message Field is running:
- Sample-check rendered panels in production projects. Open issues across a few projects with active panels and confirm:
- The viewing user only sees data they have permission to see (run as a non-admin user in incognito).
- Templates render without exposing fields the user should not see.
- JSM portal panels (if enabled) are scoped correctly via display conditions.
- Review delegation actions. If you enabled delegation, list every project where delegation is on and confirm each entry matches a request from a known project admin.
- Run Health Check. Use Health Check (through the Rovo admin agent or the configuration UI) to confirm every configuration still resolves its projects, fields and JQL.
Ongoing: monthly checklist
Schedule a recurring 30-minute review:
- Audit delegation. Remove projects from the delegation list whose project admins no longer need access.
- Audit panel configurations. Look for stale panels (no project still using the issue type, JQL referencing renamed fields, templates with hardcoded URLs). Disable or delete them. Run Health Check through the Rovo Admin Agent or the configuration UI to find broken configs in bulk.
- Audit module toggles. If a use case has been retired, disable its module to reduce surface area.
- Review Actor settings on existing panels. Any panel on a non-default actor - the app identity or a named account - without a documented reason should be reverted to Viewing user. Re-check that named actors still correspond to accounts that should be a data source for that panel’s audience; an account that has since gained broader Jira permissions widens the panel with it.
- Confirm license is active. An expired license disables panel rendering and Rovo agents. Renew before expiry.
- Spot-check JSM portal panels. Open a JSM portal request as a customer and confirm the panel content does not include any field, JQL result, or template-rendered data that should not be visible outside the licensed-Jira-user audience.
Delegation playbook
Delegation is the primary admin-controlled access pattern. By default, only Jira site administrators can create or edit any panel configuration. When a site admin enables delegation for a specific project, the project’s administrators gain a scoped subset of capabilities.
What a delegated project admin can do:
- Create, edit, and delete configurations scoped to their own projects
- Read - but not edit - global and multi-project configurations that can render in their projects
- Manage custom field configurations for their projects
- Preview, duplicate, and export/import configurations for their projects
- Access Project Settings -> Apps -> Message Panel Settings for their project
What a delegated project admin cannot do:
- Change the actor (impersonation) setting on any panel
- Edit configurations targeting multiple projects or all projects
- Access global module toggles or the delegation policy itself
- See audit metadata (creation/modification timestamps and users) for site-level configurations
Recommended posture:
- Default off. Keep delegation disabled until you have a concrete request from a project admin who needs autonomy.
- Project-by-project. Never enable delegation for “all projects” - delegate explicitly.
- Revoke when no longer needed. The monthly checklist above includes a delegation audit; remove projects whose admins no longer need access.
- Train delegated admins on actor implications. Make sure they understand that they cannot change the Actor setting: a panel that needs App user or Application user must be requested from a site admin.
For the full feature reference, see Delegation.
JSM portal specifics
Message Field’s six JSM portal modules (portalRequestDetailPanel, portalHeader, portalSubheader, portalFooter, and the two create-form modules) are registered with unlicensedAccess: customer, unlicensed. This is required by the Forge JSM module specification - portal panels render for customer-portal visitors who do not have Jira licenses. The setting is part of the app manifest; what a portal visitor sees is controlled per configuration (context filters, display conditions, actor), and the JSM portal modules can be disabled globally.
Three implications follow:
- Anything rendered by a JSM portal panel is visible to portal users. Templates, JQL results, linked-issue tables - all of it can reach a customer browser. Treat JSM portal panels as public surface area for the configured project.
- Use display conditions to scope precisely. The
displayConditionsJira expression on each module gates rendering at the platform layer (before resolver invocation). For JSM portal panels, scope the display condition to the request types and projects you actually intend to expose. See Display Conditions. - Choose the actor of JSM portal panels deliberately. Customers who are not Jira users have no Jira identity: a panel without an actor (the viewing user) is shown to them only when it is static content, and a panel with a named actor is not shown to them at all. A panel that must show them Jira data needs Application (for JSM Portal), which reads as the app - double-check that the data it can fetch is appropriate to expose. See JSM Integration.
If you have no JSM portal use case, disable the JSM portal modules globally on the admin page and skip this section entirely.
Template security
Templates run inside an in-process sandbox that strips the dangerous capabilities of a normal JavaScript runtime. The sandbox is always on; there is no admin toggle to disable it. The table below lists what the sandbox enforces.
| Protection | What it prevents |
|---|---|
No eval / no Function constructor |
Arbitrary code injection through template strings |
No fetch / XMLHttpRequest / network APIs |
Outbound network calls from a template |
No filesystem / process / require |
Filesystem access and module loading |
| Forbidden property keys | __proto__, constructor, prototype access blocked |
| Iteration cap (10,000 loops) | Infinite-loop denial of service |
| 800 ms render timeout | Long-running templates that would block the issue view |
| JQL auto-escaping | JQL built from template variables is escaped automatically; use the jqlRaw filter only for values you construct and validate yourself, such as project IDs and issue keys |
Templates can read issue, user, and linked-issue data; apply allow-listed filters and functions; use control flow; and emit text/HTML. Templates cannot make API calls, mutate any data, or escape the sandbox.
Admin-side recommendations:
- Treat templates as code: review changes before enabling, ideally via export/import flow rather than inline editing on production.
- Keep user fields (assignee, reporter) out of templates that render on JSM portal panels unless the portal audience is meant to see them.
- For panels that face external customers (JSM portal), keep templates simple and avoid pulling secondary issue data unless required.
For the full template reference, see Templates, Template Filters, and Template Advanced.
Incident response quick reference
If you suspect a panel is misbehaving or your installation is compromised:
| Action | Where |
|---|---|
| Disable a single panel | Toggle Enabled off on the panel in Configuration Basics |
| Disable a single module type (e.g. all JSM portal panels) | Toggle the module off on the global admin page - applies globally. See Modules |
| Stop all panel rendering | Disable every module on the admin page. The app stays installed but renders nothing |
| Revert delegation | Open Delegation in admin settings and clear the project list - site admins regain exclusive control immediately |
| Export configurations for forensics | Use Bulk Operations to export all configurations as JSON; preserve the export alongside an incident record |
| Uninstall the app | Standard Atlassian app uninstall. Forge handles configuration deletion per the DPA section 10 |
| Report a vulnerability | Use the Vulnerability Disclosure channel or contact security@jibrok.com |
Other security docs
- Permissions Reference - Every OAuth scope explained
- Security Reference for Auditors - Threat model, data flow, GDPR mapping
- Delegation - Project-admin access control
- Modules - Per-module enable/disable
- Display Conditions - Visibility rules at the Jira-platform layer
- JSM Integration - JSM portal modules and unlicensed access
- Limits - System limits and constraints
- Trust Center - SOC 2, GDPR, DPAs, and certifications
- DPA - Message Field for Jira Cloud - Data Processing Agreement

