Approved for Confluence Data Center
Simple add-on to remove License for Inactive users and Deactivate or remove Security access groups for users who left organization.
Use Cases:
- To Remove License for Confluence users who are Never Login or Not active.
- To Deactivate or Remove License Access Security Groups for Confluence users who left company or Not exists in organization directory.
- To restore license Or Grant Access on Successful Login attempt.
- To Search inactive users certain number of days and export to CSV.
Features:
- All Atlassian provided user directories are supported.
- Supports custom remote external Directories.
- Option to choose multiple User Directories to process users.
- Option to process users from specific groups.
- Option to skip users from specific groups.
- Option to rename Deactivated user to {username}_inactive_yyyyMMdd
- Useful REST APIs
- Also available for Cloud hosting:
Top Users
Quick Start Steps.
Here is Quick Start Steps to start using this plugin.
STEP-1
Go to, System General Configuration > Click Manage Inactive Users.
Step-1A: Configure Skip users for inactivation or deactivation process.
Step-1B: Verify Admin user in App settings > Click update again to confirm.
Note. If your admin username is email prefix then please ensure this email address is not associated for other users.
STEP-2
Go to, System General Configuration > Click Manage Inactive Users
Use Case 1 > To reduce the license count.
Configuration to Remove License or Access Security Groups for Confluence users who are Never Login or Not active.
Note:
- User Directory Name: To process users for inactivation specific to these directories
- Processing Group (Optional): It gives flexibility to process users for inactivation from specific group (e.g confluence-users).
- For testing you can use the group with small number of users.
- If empty it processes all users
- Deactivate Users (Optional):
- Set False to reduce license count.
- Set False if user directory is read-only.
- Remove Groups: Enter a comma separated license groups (e.g. confluence-users) to remove for inactive users.
- Add Groups (Optional): To add those users inactive users e.g. confluence-inactive-users.
- All Atlassian provided user directories are supported:
- Supports license groups removal and helps to reduce license count.
- For Deactivation: User Directory must have read + write permissions.
- For Crowd Directory: Enable Read/Write access at crowd properties
Use Case 2 > To deactivate users. (Optional)
Configuration to Deactivate and Access Security Groups for Jira users who left company or Not exists in organization directory.
Note:
- User Directory Name: To process users for inactivation specific to these directories
- Processing Group (Optional): It gives flexibility to process users for inactivation from specific group (e.g confluence-users).
- For testing you can use the group with small number of users.
- If empty it processes all users
- Deactivate Users:
- Set False to remove defined license / access groups for inactive users and reduces license count.
- Set False if user directory is read-only.
- Remove Groups: Enter a comma separated license groups (e.g. confluence-users) to remove for inactive users.
- Add Groups (Optional): To add those users inactive users e.g. confluence-deactivated-users.
- All Atlassian provided user directories are supported:
- Supports license groups removal and helps to reduce license count.
- For Deactivation: User Directory must have read + write permissions.
- For Crowd Directory: Enable Read/Write access at crowd properties
- For Internal Directory you need to consider using custom remote directory to validate user status.
- In addition to default Atlassian Supported User Directories, it also Supports custom remote external Directories.
Step-2A (Optional)
- For Manual runs:
- Go to, On Demand Run > Click Never Login Users Clean
- Go to, On Demand Run > Click Inactive Users Clean
- Go to, On Demand Run > Click Former Users Clean
To enable / grant Login access back to those inactive users automatically:
See Confluence License reclamation
STEP-3
Go to, System General Configuration > Scheduled Jobs
Default schedule for Automatic user de-activation.
STEP-4
To Debug Manage Inactive Users App:
Go to, System General Configuration > Logging and profiling > Add New Entry
Class/Package Name: com.tse.confluence.deactivateusers.plugin Level: Debug
Click Add.
HINTS
- Known Confluence product bug:
- On Confluence restart, if any custom schedule settings are reverted to default but still schedule runs with default settings.
- Workaround, you need to re-save the custom settings. See, https://jira.atlassian.com/browse/CONFSERVER-55455