Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,296,828
Community Members
 
Community Events
165
Community Groups

How deactivate user (as rest parameter) via scriptrunner

Hello,

I would like to know if there is a way to deactivate a user using scriptrunner and pass username via the rest endpoint ?

Something like:  jiraBaseURL/rest/scriptrunner/latest/custom/deactivateUser/?userName=USERNAME

I saw this documentation: https://www.adaptavist.com/doco/display/SFJ/Automatically+deactivate+inactive+JIRA+users but it's for deactivating users that are inactive. Plus this code is not custom endpoint.

I'm a beginner on this area. I only have a skeleton code:

import com.atlassian.jira.component.ComponentAccessor
import com.onresolve.scriptrunner.runner.rest.common.CustomEndpointDelegate
import groovy.json.JsonBuilder
import groovy.transform.BaseScript

import javax.servlet.http.HttpServletRequest
import javax.ws.rs.core.Response

@BaseScript CustomEndpointDelegate delegate

deactivateUser(httpMethod: "GET", groups: ["jira-administrators"]) { queryParams, body, HttpServletRequest request ->
def userName = request.getParameter("userName")
if (userName) {

// Deactivate userName
// Test if success
// return Response.ok("SUCCESS").build()
// Test if failed (example: if user is project lead)
// return Response.ok("FAILED").build()
}
else
return Response.noContent().build()
}

Can someone help me to build that code ? 

Thank you very much.

 

1 answer

You're nearly there. The code you linked to shows pretty well how to deactivate a user, I think where you're struggling is how to get a user from query parameters. Something like this should do:

import com.atlassian.crowd.embedded.api.CrowdService
import com.atlassian.crowd.embedded.api.UserWithAttributes
import com.atlassian.crowd.embedded.impl.ImmutableUser
import com.atlassian.jira.bc.user.UserService
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.user.ApplicationUsers
import com.onresolve.scriptrunner.runner.rest.common.CustomEndpointDelegate
import groovy.json.JsonBuilder
import groovy.transform.BaseScript

import javax.servlet.http.HttpServletRequest
import javax.ws.rs.core.MultivaluedMap
import javax.ws.rs.core.Response

@BaseScript CustomEndpointDelegate delegate

deactivateUser(httpMethod: "GET", groups: ["jira-administrators"]) { MultivaluedMap queryParams, body, HttpServletRequest request ->
def userKey = queryParams.getFirst("userKey") as String
UserService userService = ComponentAccessor.getComponent(UserService)
def crowdService = ComponentAccessor.getComponent(CrowdService)
UserWithAttributes user = crowdService.getUserWithAttributes(userKey)
def updateUser = ApplicationUsers.from(ImmutableUser.newUser(user).active(false).toUser())
def validationResult = userService.validateUpdateUser(updateUser)
if (validationResult.isValid()) {
userService.updateUser(validationResult)
return Response.ok(new JsonBuilder("Deactivated $userKey").toString()).build()
} else {
log.error "Failed to update user with key $userKey"
log.error validationResult.errorCollection
return Response.status(Response.Status.BAD_REQUEST).build()
}
}

Notably, that will fail for users who are project leads, but it should log the error so that you can discern the source of the problem.

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Posted in Jira Service Management

Jira Service Management Documentation Opportunities

Hello everyone, Hope everyone is safe! A few months ago we posted an article sharing all the new articles and documentation that we, the AMER Jira Service Management team created. As mentioned ...

330 views 0 10
Join discussion

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you