Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
Celebration

Earn badges and make progress

You're on your way to the next level! Join the Kudos program to earn points and save your progress.

Deleted user Avatar
Deleted user

Level 1: Seed

25 / 150 points

Next: Root

Avatar

1 badge earned

Collect

Participate in fun challenges

Challenges come and go, but your rewards stay with you. Do more to earn more!

Challenges
Coins

Gift kudos to your peers

What goes around comes around! Share the love by gifting kudos to your peers.

Recognition
Ribbon

Rise up in the ranks

Keep earning points to reach the top of the leaderboard. It resets every quarter so you always have a chance!

Leaderboard

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,458,250
Community Members
 
Community Events
176
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

0 votes

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

Atlassian Community Events