nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

ScriptRunner - script to remove inactive users from all groups

Chris Shepherd

I'm looking for a script that removes all inactive users from any groups they are in. Does anyone have such a thing?

thanks in advance

Chris

Accepted answers

Tayyab Bashir

Hi,

Ive used deprecated method in it, but it should work i think.

{code}

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.security.groups.GroupManager
import com.atlassian.jira.user.ApplicationUser
import com.atlassian.jira.user.util.UserManager
import com.atlassian.jira.user.util.UserUtil

def userManager = ComponentAccessor.getUserManager()
def userUtil = ComponentAccessor.userUtil

def users = userManager.getAllApplicationUsers()
def array = users.toArray()

def groupManager = ComponentAccessor.getGroupManager()

for (int i =0; i < array.size(); i ++){
def iter = array[i].getName().toString()
print iter
def groups = groupManager.getGroupsForUser(iter)
def currentApplicationUser = userManager.getUserByName(iter)
print currentApplicationUser
if(!userManager.getUserByName(iter).isActive()){
userUtil.removeUserFromGroups(groups, currentApplicationUser)
}
}

{code}

Chris Shepherd

For anyone who searches this, this is what I did in the end - including some logging and the ability to exclude groups that are controlled via ldap:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.security.groups.GroupManager
import com.atlassian.jira.user.ApplicationUser
import com.atlassian.jira.user.util.UserManager
import com.atlassian.jira.user.util.UserUtil
import org.apache.log4j.Logger
import org.apache.log4j.Level
def log = Logger.getLogger("com.jira.DelActiveScript")
log.setLevel(Level.DEBUG)

def userManager = ComponentAccessor.getUserManager()
def userUtil = ComponentAccessor.userUtil
def users = userManager.getAllApplicationUsers()
def array = users.toArray()
def groupManager = ComponentAccessor.getGroupManager()

for (int i =0; i < array.size(); i ++){
 def user = array[i].getName().toString()

 if(!userManager.getUserByName(user).isActive()){
   def groups = groupManager.getGroupsForUser(user)

   for (int j =0; j < groups.size(); j ++){
      if(groups[j].getName().toString() != "jira-users"){
         def groupName = groups[j].getName().toString()
         log.debug(user + " - " + groupName)

         def group = groupManager.getGroup(groupName)
         userUtil.removeUserFromGroup(group, userManager.getUserByName(user))
      }
    }
 }
}

All comments

Tayyab Bashir

Hi,

Ive used deprecated method in it, but it should work i think.

{code}

def userManager = ComponentAccessor.getUserManager()
def userUtil = ComponentAccessor.userUtil

def users = userManager.getAllApplicationUsers()
def array = users.toArray()

def groupManager = ComponentAccessor.getGroupManager()

{code}

Chris Shepherd

Thanks so much, it wasn't exactly what I needed but got me right to the edge of what was required.

Thanks Loads

Chris Shepherd

For anyone who searches this, this is what I did in the end - including some logging and the ability to exclude groups that are controlled via ldap:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.security.groups.GroupManager
import com.atlassian.jira.user.ApplicationUser
import com.atlassian.jira.user.util.UserManager
import com.atlassian.jira.user.util.UserUtil
import org.apache.log4j.Logger
import org.apache.log4j.Level
def log = Logger.getLogger("com.jira.DelActiveScript")
log.setLevel(Level.DEBUG)

def userManager = ComponentAccessor.getUserManager()
def userUtil = ComponentAccessor.userUtil
def users = userManager.getAllApplicationUsers()
def array = users.toArray()
def groupManager = ComponentAccessor.getGroupManager()

for (int i =0; i < array.size(); i ++){
 def user = array[i].getName().toString()

 if(!userManager.getUserByName(user).isActive()){
   def groups = groupManager.getGroupsForUser(user)

   for (int j =0; j < groups.size(); j ++){
      if(groups[j].getName().toString() != "jira-users"){
         def groupName = groups[j].getName().toString()
         log.debug(user + " - " + groupName)

         def group = groupManager.getGroup(groupName)
         userUtil.removeUserFromGroup(group, userManager.getUserByName(user))
      }
    }
 }
}

Mauri Suomivuori

Thanks for this. Still works well!

kdickason

@Chris Shepherd I am looking to remove Inactive users from all my groups, including jira-users. I think this is what you were trying to achieve. Can you help me understand what is happening in this portion of your script above?

for (int j =0; j < groups.size(); j ++){
      if(groups[j].getName().toString() != "jira-users"){
         def groupName = groups[j].getName().toString()
         log.debug(user + " - " + groupName)

I am not strong with scripting (obviously). Thank you.

Chris Shepherd

Well, it's 5 years since I wrote it but:

for (int j =0; j < groups.size(); j ++){

is creating a counter (j) to loop through all the groups

if(groups[j].getName().toString() != "jira-users"){

Get the group name for the counter.
If the group name is not equal (!=) to jira-users then do the next bit

def groupName = groups[j].getName().toString()

get the group name (again! who wrote this rubbish )

log.debug(user + " - " + groupName)

write it to the log file to show whats going on

def group = groupManager.getGroup(groupName)
         userUtil.removeUserFromGroup(group, userManager.getUserByName(user))

Then take them out the group.

I ignore the jira-users group as that is controlled by ldap in our instance. but if you don't want to do that remove the

if(groups[j].getName().toString() != "jira-users"){

HTH
Chris

Efren Miguel

Thanks for this, I faced a similar req, but removing just from a specific group since we synch groups from LDAP, here's my modified version, saved it in ScriptEditor, and used it with different group names as separate ScriptRunner Jobs:

/**

* Script scans for inactive users and removes it from group specified as parameter.

* @author xxx

* @version 1.0

* @since 2022-08-01

import com.atlassian.jira.component.ComponentAccessor

import com.atlassian.jira.security.groups.GroupManager

import com.atlassian.jira.user.ApplicationUser

import com.atlassian.jira.user.util.UserUtil

import com.onresolve.scriptrunner.parameters.annotation.*

import org.apache.log4j.Logger

import org.apache.log4j.Level

def log = Logger.getLogger(getClass())

log.setLevel(Level.DEBUG)

def userManager = ComponentAccessor.getUserManager()

def userUtil = ComponentAccessor.userUtil

def groupManager = ComponentAccessor.getGroupManager()

@ShortTextInput(label = "Group To Remove From", description = "Enter a group to remove inactive users from.")

String groupToRemoveFrom

def users = userManager.getAllApplicationUsers()

users.each {user ->

def userName = user.getName()

// process only Inactive users

if ( !user.isActive() ) {

def userDisplayName = user.getDisplayName()

def groups = groupManager.getGroupsForUser(userName)

groups.each {group ->

def groupName = group.getName().toString()

if ( groupToRemoveFrom == null || groupName.equals(groupToRemoveFrom) ) {

userUtil.removeUserFromGroup(group, user)

log.debug("User [${userName}] ${userDisplayName} removed from group ${groupName}")

}

return null

Michiel Schuijer_yj4jdb

Thanks for that @efrel !

I have tried using this and see some warnings appear in ScriptEditor.

The first is concerning line 17 and the variable "log":

Screen Shot 2022-09-29 at 09.51.20.png

If I change that to "logs" another warning appears, this time on line 27, concerning an improved search method:

Screen Shot 2022-09-29 at 09.51.44.png

Do you have any tips on how to deal with this?

Can it safely be ignored, or could you improve it, maybe?

Many thanks and kind regards.

Michiel

Efren Miguel

Hi Michiel, apparently there are newer more efficient ways to accomplish this now, I upgraded my code as well and tested successfully on 8.22.6, here it is:

/**

* Script scans for inactive users and removes it from group specified as parameter.

* @author Efren Miguel

* @version 2.0

* @since 2022-10-05

import com.atlassian.jira.bc.user.search.UserSearchParams

import com.atlassian.jira.bc.user.search.UserSearchService

import com.atlassian.jira.component.ComponentAccessor

import com.atlassian.jira.user.UserFilter

import com.atlassian.crowd.embedded.api.Group

import com.onresolve.scriptrunner.parameters.annotation.GroupPicker

@GroupPicker(label = 'Group to Remove From', description = 'Pick a group to remove Inactive users from.', placeholder = 'Pick a group')

Group theUsersGroup

def userSearchService = ComponentAccessor.getComponent(UserSearchService)

def userUtil = ComponentAccessor.userUtil

// user search parameters

def allowEmptyQuery = true

def includeActive = false // IMPORTANT: MUST BE true

def includeInactive = true

def canMatchEmail = false

Set<Long> projectIds = null

int limit = 100 // this is the max value

def sorted = false

def ignorePermissionCheck = true

UserFilter groupUserFilter = new UserFilter(true, null as Collection<Long>, [theUsersGroup.getName()] as Collection<String>)

def searchParams = new UserSearchParams(allowEmptyQuery, includeActive, includeInactive, canMatchEmail, groupUserFilter, projectIds, limit, sorted, ignorePermissionCheck)

def outputLines = ["REPORT:" as String]

def totalUsers = 0

// execute 5 times to process a maximum of (5 x limit) inactive users

for (int i=0; i<5; i++) {

// get users (inactive and in specified group), then remove from group

def inactiveUsersInGroup = userSearchService.findUsers('', searchParams)

outputLines.add("${inactiveUsersInGroup?.size()} inactive users found in group ${theUsersGroup.getName()}." as String)

inactiveUsersInGroup.each {user ->

// double check to make sure user is inactive, before removing from group

if (user.isActive()==false) {

userUtil.removeUserFromGroup(theUsersGroup, user)

outputLines.add("User [${user.getName()}] ${user.getDisplayName()} removed from group ${theUsersGroup.getName()}." as String)

totalUsers++

}

if (inactiveUsersInGroup.size()==0) {

break

}

outputLines.add("Total of ${totalUsers} inactive users deleted from group ${theUsersGroup.getName()}." as String)

// return outputLines as HTML string

return "<p>"+outputLines.join("<br/>")+"</p>"

Michiel Schuijer_yj4jdb

Super! Thanks a lot for that.

Olivia Case

Does anyone know how to do this for Jira Cloud using ScriptRunner?

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

scriptrunner

jira

groovy

group

user