Jira App || User Suspension || Documentation
1. Introduction:
This Atlassian Marketplace app can be used to allow administrators to manage user suspensions based on specific criteria. Below is a screenshot of the plugin on Atlassian Marketplace.
2. App Installation:
Step 1: Login as a JIRA administrator. Go to -> Administration -> Add-on -> Find Add-on
Step 2: Find "User Suspension" and click "Install".
3. Functionality Process:
Step 1: Go to Jira Home -> Click on Apps drop down ->Click on “User Suspension”.
Step 2: Enter your Email address, API Token, Org Id and Bearer Token. You cannot access other tabs without entering the right credentials.
Step 3: Once you fill out all the fields, click on "Validate". To reset all fields, please select the "Clear" option.
Step 4: If you have entered the right credentials, you will see a "Success" message, and you can continue using other tabs.
Step 5: If you enter the wrong credentials, you will see an "Invalid Authentication" message, which will restrict you from accessing other tabs.
Suspending by selecting users from the list
Step 1: Once you get the "Success" message in "Validation Tab" , click on "User Scanning".
Step 2: Here three filters available for searching users:
1. Search users based on "Name" / "Email”
2. Search users based on JIRA Groups
3. Search users based on Last Active Date
select any one filter and click on search to get users list.
Step 3: You can see the user list based on selected filter, Select the users you want to suspend by using "Checkbox" and click on "Suspend Selected Users" to suspend the users.
Step 4: Confirmation Dialog is shown to the Admin before the deletion process is initiated, by clicking on 'Yes' button the suspension process continues or by clicking on 'X' mark, suspension process will be aborted.
Step 5: Once the process of suspension is completed, Admin can see the "Status Page" which will display the "Suspended users list" along with "Status" of the suspension process. Check the "Status" column of all records to know if the user is suspended or not. Admin can also see the "Status Message" if the user is not suspended in the "Remark" column.
Step 6: If the user is org-admin then we can’t able to suspend the user because organization admin role possess the highest level of permissions for administering settings, users, and groups. If we select that user and try to suspend the user then you’ll get a failed status page with remark says check the user is org admin
4. Filter users by search
"Search users", "JIRA Groups" and “Date“ fields helps to get particular set of records from the user table.
Note: Admin can search users either based on name / email or JIRA Groups but not both. and also they search by date
Search users based on "Name" / "Email" / "Date"
Enter the "Name" or "Email" or “Date” and click on "Search" button to view the results. Click on 'Reset' button to clear the filter criteria. JIRA Groups field will be disabled when you start searching based on name / email.
Search users based on JIRA Groups
Choose the "JIRA Group" from the dropdown and click on "Search" button to view the results. Click on 'Reset' button to clear the filter criteria.
Search users based on JIRA Groups
Choose the "Date" from the date filter and click on "Search" button to view the results. Click on 'Reset' button to clear the filter criteria.
5. Suspend users by creating a scheduled job
Clicking on the "Schedule Jobs" tab allows you to access and view scheduled processes, including both "Job Creation" and the "Job List."
By default, it will open schedule job creation page.
And also it will show the message at the top of the panel says that “Users with the organization admin role possess the highest level of permissions for administering settings, users, and groups. So we do not have the ability to suspend those users.”
Create Jobs
When creating a job in Jira, the user must select Jira groups, specify the last active date, and choose the schedule type (weekly or monthly). If the schedule type is set to weekly, the user can further select a day from Sunday to Saturday. For monthly schedules, options range from 1 to 30.
Additionally, users need to decide whether to enable auto suspension, with options being "Yes" or "No." If "Yes" is selected, the system will automatically suspend users at the scheduled intervals. Conversely, choosing "No" means the job will run at the specified intervals, and the UI dialog will display a list of users without suspending them.
Jobs List
Upon selecting all the fields on the "Create Jobs" page and clicking the "Create" button, we will get the success message as “Job Created Successfully“ and the system will redirect to the "Job List" page, displaying the newly created job in a table.
To remove a job, simply click on the "Delete" button. Once done, a confirmation message will appear, indicating that the “Mapping record deleted successfully”.
To make changes to a job, simply click the "Edit" button. This action will open an edit dialog containing pre-filled values that can be modified. Once the necessary edits are completed, save the changes by clicking on “Save” button.
Clicking on a “View” button allows us to access and view the schedule of its runs. It will show the runs name as like date followed by time and groupName
Clicking on the "Job Runs" option allows us to view users who will be suspended when auto-suspension is set to "No". For jobs with auto-suspension set to "No", we can initiate the run by clicking the "Run" button.
However, when auto-suspension is set to "Yes", there is no "Run" button available as it directly suspends users, and the interface only displays the list of suspended users.