Delta Guard
Delta Guard: Custom Fields Security for Jira
Installation
Create protected field
Protection configuration
Apply protection to existing fields
Remove protection
API
Protected field history and email configuration
Delta Guard Custom Fields Security for Jira icon{name="custom DeltaGuard"} Delta Guard is a comprehensive tool for securing custom fields. You can create new protected fields or migrate existing ones seamlessly—our plugin ensures a smooth operation. It guarantees full protection for field data, including history, search, and third-party integrations. Enhance your data security with icon{name="custom DeltaGuard"} Delta Guard !
Installation Please follow the steps below to install icon{name="custom DeltaGuard"} Delta Guard to your Jira Data Center instance 1. Log into your instance of Jira as an admin. 2. Select the Settings drop down menu and select Manage apps . 3. Select Find new apps from the left side menu. 4. Once the screen loads, you can type Delta Guard in the search bar to find the appropriate app version. 5. Select free trial to begin the trial or buy now to purchase a license for \ delta-guard Delta Guard . 6. Select accept and install in the modal that opens up to confirm the app installation. 7. icon{name="custom DeltaGuard"} Delta Guard begins to download and you’ll be prompted to log into your MyAtlassian account. 8. Enter your credentials and select Generate license . 9. A license key will be generated, and select Apply license to get started with the app. If you're using an older version of UPM, you can copy and paste the license into your Jira instance. You’re now all set to start using the app.
Create protected field Follow the steps below to create custom field secured by \ delta-guard Delta Guard 1. Open Jira Administration → Issues → Custom fields 2. Click Add custom field button 3. Search for the desired field type and select the one marked with \[Protected] keyword 4. Perform necessary for the selected field type configuration ( name, description, context configuration, screens association, etc. ). 5. Once the basic configuration is complete, find your newly created custom field in Custom Fields or the Delta Guard Custom Fields menu. Click the button and select Configure 6. On the opened page, click Edit Permission Configuration 7. Add permissions for your protected field and click Save to apply protection
Protection configuration icon{name="custom DeltaGuard"} Delta Guard provides the following options for configuring protection Permission type - determines whether to Allow or Deny a particular type of access to the field. Access - specifies the type of access to grant—either View or Edit . Granted to - selects the entity to which the permission is granted Anyone - any Jira user, including anonymous users User - specific Jira user Group - specific group of users User field value - grants permissions based on the value of a specific custom field of the User Picker (single or multiple) type For example, edit permission can be granted to the current Assignee of the issue. Group field value - grants permissions based on the value of a specific text custom field that contains the group name For example, you may have a field containing the name of the group you'd like to grant access to your protected field data. These group names can vary between different issues. Add button adds configured permissions. Remove ( ) button removes permission from the current configuration. Example configuration Let’s imagine you need to restrict general access to the field, providing edit access only to the current Assignee or Jira Administrators , and view access to users in the Reviewers field. The configuration of your protected field would look like this (it’s quite simple, isn’t it?)
Apply protection to existing fields icon{name="custom DeltaGuard"} Delta Guard provides a simple wizard to migrate your fields to a protected state. 1. Navigate to Jira Administration → Issues → Delta Guard custom fields 2. Click Protect field 3. Select the field you want to protect, choose a history protection option, and click Next 1. Make protected - field values history will be available only to entities configured in the permissions settings 2. Leave public - field value changes made before protection will remain visible to all issue viewers. 3. Permanently remove - deletes history of field value changes for all issues Note This action is irreversible, and history cannot be restored. 4. Configure field permissions and click Next 5. Select field configuration for the field and click Create That’s it! Your field it protected now by icon{name="custom DeltaGuard"} Delta Guard.
Remove protection icon{name="custom DeltaGuard"} Delta Guard provides simple way to remove protection from the field without losing your data. 1. Navigate to the Jira Administration → Issues → Delta Guard custom fields 2. Find the field you would like to remove protection from, click and select Disable protection option 3. You will be prompted to choose one of the two available options for field change history 1. Permanently remove - deletes history of field value changes for all issues Note This action is irreversible, and history cannot be restored. 2. Make public - makes the history of field value changes visible to all issue viewers 4. After selecting the desired history option, click Disable . That’s it! Your field protection is removed.
API Delta Guard API allows administrators to protect Jira custom fields by controlling visibility and edit permissions. It also manages how existing field history is handled when moving between protected and unprotected states. Endpoints v2 Base URL 1. Protect a Custom Field POST Transform a custom field into its protected form. You can choose how to handle its history and configure permissions per context. Path Parameters Name Description Example ------ ------------------------- ------ fieldId Custom field ID to protect Request Body Field Description Allowed Values -------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------ --------------------------------------------------------------------------- historyAction How to handle existing public history (keep public), (delete), (apply new permissions) contexts List of field config/context IDs Array of IDs <br / permissionData List of permission definitions (see CFPermissionGrant) JSON array Responses – Custom field successfully protected – Invalid request (bad , invalid context, already protected) – User is not an administrator – Field not found Example Unprotect a Custom Field POST Convert a protected field back to its unprotected version. Path Parameters Name Description Example ------ --------------------------- ------ fieldId Custom field ID to unprotect Query Parameters Name Description Allowed Values ------------ ------------------------------ ---------------------------------------------------- historyAction How to handle protected history (delete),<br / <br / (make public) Responses – Field successfully unprotected – Invalid request (bad , already unprotected) – User is not an administrator – Field not found Example Endpoints v1 Base URL 1. Protect a Custom Field POST Transform a custom field into its protected form. You can choose how to handle its history and configure permissions per context. Path Parameters Name Description Example ----------- ------------------------- ------------------ str\ fieldId Custom field ID to protect Request Body Field Description Allowed Values -------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------ --------------------------------------------------------------------------- historyAction How to handle existing public history (keep public), (delete), (apply new permissions) contexts List of field config/context IDs Array of IDs <br / permissionData List of permission definitions (see CFPermissionGrant) JSON array Responses – Custom field successfully protected – Invalid request (bad , invalid context, already protected) – User is not an administrator – Field not found Example 2. Unprotect a Custom Field POST Convert a protected field back to its unprotected version. Path Parameters Name Description Example ----------- --------------------------- ------------------ str\ fieldId Custom field ID to unprotect Query Parameters Name Description Allowed Values ------------ ------------------------------ ---------------------------------------------------- historyAction How to handle protected history (delete),<br / <br / (make public) Responses – Field successfully unprotected – Invalid request (bad , already unprotected) – User is not an administrator – Field not found Example 3. Apply Permissions to a Field Context POST Replace existing permissions for a field context. Path Parameters Name Description Example -------- ---------------- ------- fieldId Custom field ID configId Field context ID Request Body List of CFPermissionGrant objects in JSON format. Responses – Permissions applied successfully (returns applied permissions list) – Invalid request – User is not an administrator – Field or context not found Example 4. Get Permissions for a Field Context GET Retrieve permissions for a specific field context. Path Parameters Name Description Example -------- ---------------- ------- fieldId Custom field ID configId Field context ID Responses – Returns list of applied CFPermissionGrant – Invalid request – Field or context not found Example 5. Get Permissions for a Field (All Contexts) GET Retrieve all permissions across contexts for a protected custom field. Path Parameters Name Description Example ------ -------------- ------ fieldId Custom field ID Responses – Returns JSON object with contexts and applied permissions – User is not an administrator – Field or context not found Example Entities Field Config vs Context FieldConfig Jira’s internal term Context The label displayed in the Jira admin UI You can find field contexts in CFPermissionGrant Represents a permission granted to a subject for accessing a protected custom field. Each grant defines whether the subject is allowed or denied specific access. Field Description Allowed Values -------------- ----------------------------------------------------- ---------------- -------- access Type of access , type Permission action , subject The target entity to which the permission is applied. Subject Type Key User key ( ) Group name ( ) Field ID ( ) Field ID ( ) Role ID ( ) Example Permission List
Protected field history and email configuration icon{name="custom DeltaGuard"} Delta Guard stores the history of changes made to the protected fields in a private table to ensure data security. This is necessary to avoid sensitive data exposure via different Jira modules relying on public history. For the same reason updates to protected fields are excluded from email notifications. However, starting from 2.1.2 version the plugin offers a configuration option to make field change history public and include updates in email notifications under specific conditions Anyone Allow View permission is granted. No Deny View permissions set (though Deny Edit permissions may still apply). dark feature is enabled. When these conditions are met, the plugin will Create a public history for field changes. Send email notifications about those changes. To enable this functionality for particular field, ensure the following 1. Grant the Anyone Allow View permission. 2. Remove any Deny View permissions. 3. Activate dark feature via https //support.atlassian.com/jira/kb/manage-dark-features-in-jira-data-center/ [!NOTE] Make sure that the feature name is and not