Skip to end of banner
Go to start of banner

How to use setShareScope action in Jira Command Line Interface (CLI)

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This article explains how to set the scope of a filter in Jira to either Global or Private using Jira Command Line Interface (CLI).

Instructions

The setShareScope action in Jira Command Line Interface, allows the filters to be available to either Global or Private.

  1. Before creating a filter in Jira, set the scope of the filter using the action setShareScope as given in the below example.

    --action setShareScope --value Global

    The above action defaults the filter share scope for the current user to GLOBAL.

  2. Create a filter using createFilter action as given in the below example:

    --action createFilter --name filterforTSboard --jql "project = TESTER01 ORDER BY Rank ASC"

    The above action creates a filter named "filterforTSboard" for the Jira project "TESTER01".

  3. To verify the filter permissions from Jira UI, follow the below instructions:
    1. Log in to Jira as an administrator. 
    2. From the top navigation bar, click on Issues.
    3. From the dropdown select Manage filters option, as shown in the screenshot below:
    4. As the below screenshot indicates, the filter "filterforTSboard" has no restrictions and can be viewed by any logged-in user.
  4. Similarly, the filters can be restricted by setting the scope to "PRIVATE". Refer to the sample action given below for the same.

    --action setShareScope --value private
    --action createFilter --name filterforTSboard-1 --jql "project = TESTER01 ORDER BY Rank ASC"
  5. The filter "filterforTSboard-1" is set as Private in Jira as shown in the below screenshot:

Please note that the filter scope can only be applied during filter creation but not while updating. Hence setShareScope doesn't set the filter scope when performing updateFilter CLI action.


It is recommended to test this scenario in a non-production environment, or, run the action with the --simulate parameter to verify the behavior before deploying.

  • No labels