How to Setup the miniOrange Data – PII Scanner (DLP) for Confluence
The PII Scanner (DLP) for Confluence is a powerful tool designed to enhance data privacy and governance within your Confluence environment. It scans your entire instance to identify and report potential exposures of Personally Identifiable Information (PII), enabling you to address risks proactively.
With data security and privacy becoming increasingly vital, the PII Scanner for Confluence gives you the ability to protect sensitive information, reduce exposure risks, and maintain strong data protection standards. Let's dive into how you can get started with this essential tool to boost your data privacy efforts.
Download and Installation
- Log in to your Confluence Cloud instance as an administrator.
- Navigate to the Apps in the top left navigation bar of your Confluence dashboard and click on the Explore more apps section.
- Search for Data - PII Scanner. Please note that this option is available only for users with Admin permissions.
- Click Try it free to begin the trial. Your trial will be valid for a period of 30 days.
Initial Configuration & API Setup
- To get started, go to the Configure Token tab in the app. To connect the plugin with your Atlassian instance, follow these steps to generate an Admin API Key:
- Open the Atlassian API Token Manager.
- Click Create API token without scopes, assign a clear name (e.g., MO_TOKEN), and set an expiration date.
- Tip: We recommend 12 months expiration for easier maintenance.
- Copy the generated token and paste it into the plugin settings.
- Enter the Admin Email. This must match the Atlassian account that created the token.
- Go to admin.atlassian.com.
- Select the site where the app is installed (e.g., your Atlassian organization).
- Navigate to Settings → API Keys and click Create API key.
- Choose the API key without the scopes option, then click Next.
- Enter a name (e.g., MO_UMP_KEY) and set an expiration period.
- Tip: We recommend 12 months for easier maintenance. Copy the generated API key and paste it into the plugin configuration screen.
- Click Save after entering both the Admin Email and API Token to avoid errors.
1.1 : API Token Setup
1.2: API Key Setup
Get Started
This guide will get you up and running in just a few minutes. The PII Scanner and DLP app is a security application designed to automatically find and protect sensitive information within your Confluence Spaces and pages.
Detection Rules
These are the fundamental building blocks. A rule tells the system
what to look for. For example, a rule could be a regular expression
that matches a Social Security Number.
Templates
A template is a reusable group of Detection Rules. For example, you
could create a "PII Compliance" template that contains the rules for
SSNs, credit cards, and phone numbers.
Policies
A policy is the final, actionable step. It takes one or more Templates
and applies an Action to them (e.g., "Redact Content"). You can turn
policies on and off. Only active policies are enforced during a scan.
Under Apps section in the top-Nav bar, you will find the app by the name Data - PII Scanner for Confluence. This will only appear for Admins and not users.
1: Review and Add Your Detection Rules
Navigate to the Detection Rules page. Familiarize yourself with the pre-built rules or create a new custom rule for any specific data unique to your organization. We have a set of 80 pre-built rules set.
To create a New Rule Select Detection Rules Tab
- Click Detection rules to view existing rules and manage them.
- Click New Rule to start creating a new data loss prevention rule.
- Click Rule Name to specify the name of your new rule.
- Enter your rule name to identify the detection criteria and click Type patterns and press Enter to add to input detection patterns and enter your pattern text to define what the rule should detect.
- Enter your keyword to associate with this detection rule then click Create to save the detection rule you configured. Your custom Detection rule is created and visible in the list.
2: Create a Template
- Go to the Templates page and click New Template. Give it a name (e.g., "Confidential Project Data") and select the detection rules you want to include.
- Click New Template to start creating a new message template.
- You can create your own template, add the description, description to explain the template's purpose and select the rules you would like to include in this template.
3: Create and Activate a Policy
- Head to the Policies page and click New Policy.
- Attach the template you just created, and most importantly, choose an action like Redact Content.
- After creating the policy, make sure you enable it using the toggle switch.
4: Run a Scan
- Go to the Scan & Redact page. Click the Run Global Scan button to start searching through all your Confluence content based on your active policies.
5: Review Results
As the scan progresses, results will appear on the same page. You can see which pages contain violations and what was found. From here, you can select items and use the bulk action tools to manage them. You can then take the necessary action to hide or redact information.
You can now create and manage detection rules, templates and Templates in Confluence to enhance data protection, privacy and governance on Cloud. Start by defining patterns and keywords, then associate templates to automate sensitive data redaction.
Additional Resources
Did this page help you?
Try it for free