- 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
- API Restrictions playbook
- Webhook and UIM specifics
- Incident response quick reference
- Other security docs
Audience and purpose
This guide is for the Jira site administrator who installs JiBrok Studio (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 overview of what scopes Studio requests, see the Permissions Reference. For a security review or DPIA, see the Security Reference for Auditors.
At a glance: secure-by-default
Studio ships with conservative defaults. Most are safe to keep; a few are opt-in by intention.
| Setting | Default | Notes |
|---|---|---|
| Run As modes available | Current User and Specific User | Application and Pre-configured Users must be enabled explicitly. Specific User is on by default - turn it off if you do not need it. See Administration |
| Trigger types enabled | Scheduled, Event, Async Event, Workflow (post function, validator, condition), Automation, Scripted Fields, JQL Function | UIM, Rovo, and Webtrigger are disabled until you enable them per use case |
| Scripted Fields, Recipe and JQL Function audit | Disabled | High-volume trigger types; enable only if you need execution-level forensics |
| Global API whitelist | Enabled (default list) | A call outside the list is rejected before it reaches Jira. Every call also passes the hardcoded API whitelist and the permanent blacklist of sensitive endpoints. After an app update, check the API Whitelist tab for missing default rules |
| Global API blacklist | Disabled | Optional admin-configurable blocklist on top of the permanent one |
| Diagnostic Logging | Off | When you enable it, set an end-time. Auto-disables after the window |
| Compliance Baselines | None | You create the first baseline manually. See Compliance & Drift Monitoring |
| Webhook tokens | AES-256-GCM encrypted at rest | Encryption key held in Forge secret storage |
| Outbound network | None except weekly GDPR account report | No external: scopes declared |
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 and Provider-Specific Terms.
- Decide who in your organization will hold Studio admin access. Studio admin = Jira site admin - there is no separate role.
- If you run separate Jira sites for testing and production, install Studio on each and keep their scripts and settings separate. Never test new scripts directly on the production site.
- If your compliance program requires documented controls, plan a Day-1 baseline (see step below).
Day 1: post-install checklist
Walk through these in order on the day you install Studio. Most checks take less than 5 minutes each.
- Confirm the installed version. In Apps -> Manage your apps -> JiBrok Studio, check that the installed version matches the current Marketplace release.
- Lock Run As to the modes you need. Specific User is on by default - turn it off explicitly if you do not need it. Leave Application and Pre-configured Users off until a real use case requires them. Each additional Run As mode increases the actor surface for misuse.
- Disable trigger types you do not plan to use. Webtrigger, UIM, and Rovo are off by default - keep them off unless you have a specific use case. See Administration for per-trigger toggles.
- Decide on Scripted Fields audit. It is off by default because field computations can run thousands of times per day on large instances. Enable only if you need per-execution forensics; otherwise rely on the Settings audit and Script Runs audit.
- Check audit retention against your policy. Audit records are kept in a rolling window - see Limits for the record count - and cannot be edited. If your policy requires longer retention, capture Compliance Baselines and Integrity Reports on a schedule that matches it.
- Review the API whitelist. The global whitelist is enabled by default with a default list (issue create/read/update without delete, search, agile basics, metadata reads, attachment reads, JSM); every call is also checked against the hardcoded whitelist and the permanent blacklist. Check that the list covers the endpoints your scripts call and narrow it if your compliance program requires. If the API Whitelist tab warns that the default list has rules your list does not, review them and click Add missing rules. See API Restrictions.
- Document who has Jira admin access. Anyone with Jira site admin can manage Studio. Treat the Jira admin list as the Studio admin list.
- Establish the first Compliance Baseline. Once you have your scripts, settings, whitelists, and labels in place, capture a baseline so future drift is visible. See Compliance & Drift Monitoring.
- Enable auto-check on the baseline. Scheduled drift checks then run automatically and store their results in the baseline’s history.
- Document your escalation paths. Who responds to a security incident? Who handles license expiry? Both are admin-only events surfaced in the audit log.
- Test a minimal script. Run a
print("hello")script in the Console to confirm the engine works and the audit trail captures it.
Week 1: first-week monitoring
Once Studio is running:
- Review the Script Runs audit daily for the first week. Look for unexpected actors, repeated errors, or scripts running outside business hours. See Audit Logs.
- Review the Settings audit. Every configuration change (trigger toggle, API restriction, Run As change, UIM registration) produces a Settings audit entry - use the first week to get familiar with the entries your team generates.
- Run a manual Drift Check. Confirm it returns Clean against your Day-1 baseline. If it returns Drifted, investigate.
- Review who has run scripts. The Script Runs audit shows actor accountIds. Match them against your authorized admin list.
Ongoing: monthly checklist
Schedule a recurring 30-minute review:
- Read the latest Drift Check report. Investigate any non-clean result.
- Review preconfigured users (if enabled). Remove anyone who left the team or no longer needs script-author identity.
- Rotate webhook tokens. Tokens are encrypted at rest, but rotation reduces blast radius from accidental disclosure. Regenerate the token from the script’s Config tab - Generate replaces the existing token (see Webhook Trigger).
- Review enabled trigger types. If a use case has been retired, disable its trigger type to reduce surface area.
- Re-baseline after major changes. A baseline taken months ago against a different script set no longer reflects your configuration - capture a fresh one.
- Review the Settings audit since last review. Confirm every change matches a known ticket or change request.
- Confirm the license is active. When the license lapses, event, scheduled, async and scripted-field triggers are skipped without producing errors, while workflow functions and the Automation action return a License required error. See FAQ - license expiry for the full behavior matrix.
API Restrictions playbook
Studio enforces a six-level pipeline on every API call, including a permanent blacklist that you cannot disable. The two layers you control as an admin are:
- Global whitelist - enabled by default. The default list (issue create/read/update without delete, search, agile basics, metadata reads, attachment reads, JSM) covers the most common automation patterns; check it against the endpoints your scripts call. Use the API Catalog to add other endpoint groups quickly. A saved list does not change on app updates: when the default list gains rules, the API Whitelist tab shows them with an Add missing rules button.
- Global blacklist - off by default. Enable when you want to block specific patterns while keeping everything else open. The blacklist is checked before the whitelist at the same level.
For per-script controls, define Custom Whitelist or Custom Blacklist profiles and assign them to individual scripts in the script’s Config tab. A script must pass both the global and the custom level.
To test an API restriction safely, run the script in Sandbox mode in the Script Console. Sandbox mode simulates POST/PUT/DELETE without affecting Jira data.
For the full reference, see API Restrictions.
Webhook and UIM specifics
If you enable webhooks (off by default):
- Studio generates a unique Basic Auth token per webhook trigger. Tokens are encrypted at rest with AES-256-GCM; the encryption key is held in Forge secret storage.
- Each webhook is limited to 60 requests per 60-second window. The window is fixed, not sliding, and the limit is hardcoded - there is no admin setting for it (see Limits).
- Token validation is timing-safe - protected against timing attacks.
- Rotate tokens periodically and immediately if you suspect disclosure.
If you enable UI Modifications (off by default):
- Each UIM context registration is recorded in the Settings audit with the registering admin’s accountId and the affected screen/project.
- UIM scripts run in read-only mode - only GET requests to Jira are allowed; any write attempt is blocked with an error.
- Use Manage UIMs in Administration to delete stale registrations after retiring a script.
Incident response quick reference
If you suspect a script is misbehaving or your installation is compromised:
| Action | Where |
|---|---|
| Stop a single script | Toggle the script’s trigger to disabled in the Script Library |
| Freeze a trigger type (e.g. all Webtriggers) | Disable the trigger type in Administration - applies globally |
| Stop all script executions | Disable every trigger type in Administration - Scheduled, Event, Async Event, UIM, Scripted Fields, Automation, Rovo, Workflow Post Function, Workflow Validator, Workflow Condition, Webtrigger and JQL Function. Active runs complete; new ones are blocked |
| Preserve evidence | Filter the Script Runs and Settings audit views to the incident window and generate an Integrity Report; see Audit Logs and Compliance & Drift Monitoring |
| Capture a forensic baseline | Create a new Compliance Baseline immediately - this freezes the current state with SHA-256 hashes for later comparison |
| 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
- Security Overview - Sandbox, API pipeline, execution identity, audit
- Forge Platform & Security Architecture - Platform-level protections
- Administration - Per-feature settings reference
- API Restrictions - Whitelist and blacklist configuration
- Audit Logs - Settings and script runs audit
- Compliance & Drift Monitoring - Baselines and drift detection
- Trust Center - SOC 2, GDPR, DPAs, and certifications
