Manage Inactive Jira Users REST API
Get Users
GET http://localhost:8080/rest/deactivateusers/1.0/reports/list/all/active/users
GET http://localhost:8080/rest/deactivateusers/1.0/reports/list/all/neverlogin/users
GET http://localhost:8080/rest/deactivateusers/1.0/reports/list/all/deactive/users
GET http://localhost:8080/rest/deactivateusers/1.0/reports/list/all/users
Query Parameters:
- days (Number) - Days
- Set 0 to get all the users.
- type (Number)
- 0 - Since
- 1 - Before
- group (String)
Response: [Status: 200]
$ curl -u jirauser -XGET \ http://localhost:8080/rest/deactivateusers/1.0/reports/list/all/active/users?type=0&days=30&group=jira-users
Update User Attributes
POST http://localhost:8080/rest/deactivateusers/1.0/utility/update/user/{username}
Path Parameters:
- username (String) - Jira username
Query Parameters:
- newEmail
- newDisplayName
- newUserName
- newStatus
- deactivate
- activate
- addGroup (comma separated groups to add)
- removeGroup (comma separated groups to remove)
Response: [Status: 200]
$ curl -u superadmin -XPOST -H "Content-Type:application/json" \
"http://localhost:8080/rest/deactivateusers/1.0/utility/update/user/croadmin/? \
newEmail=croadmin@noreply.com"
{"status":1,"message":"[Info] Updated User attributes ~ croadmin"}
$
Re-Activate Users
RE-ACTIVATE USER
POST http://localhost:8080/rest/deactivateusers/1.0/utility/re-activate/user/{username}
Path Parameters:
- username (String) - Jira username
Response: [Status: 200]
RE-ACTIVATE USER (LEGACY)
POST http://localhost:8080/rest/deactivateusers/1.0/utility/reactivate/user/{username}
Path Parameters:
- username (String) - Jira username
Data Fields:
- groups (String[]) - Array e.g. ["group1", "group2"]
Response: [Status: 200]
De-Activate Users
DE-ACTIVATE USER
POST http://localhost:8080/rest/deactivateusers/1.0/utility/de-activate/user/{username}
Path Parameters:
- username (String) - Jira username
Response: [Status: 200]
DE-ACTIVATE USER (LEGACY)
POST http://localhost:8080/rest/deactivateusers/1.0/utility/deactivate/user/{username}
Path Parameters:
- username (String) - Jira username
Response: [Status: 200]
Remove Groups
REMOVE DEFINED GROUPS FOR USER
POST http://localhost:8080/rest/deactivateusers/1.0/utility/removegroups/user
Required Data Fields:
username (String) - Jira username
groups (String[]) - Array e.g. ["group1", "group2"]
Response: [Status: 200]
REMOVE ALL GROUPS FOR USER
POST http://localhost:8080/rest/deactivateusers/1.0/utility/removeallgroups/user/{username}
Path Parameters:
- username (String) - Jira username
Response: [Status: 200]
Run User De-activation
TRIGGER USER DE-ACTIVATION FROM CLI
POST http://localhost:8080/rest/deactivateusers/1.0/utility/run/userdeactivation
Response: [Status: 200]
TRIGGER ALERT NOTIFICATION
GET http://localhost:8080/rest/deactivateusers/1.0/form/user/alert/trigger
Response: 200
% curl -u admin -XGET http://localhost:8080/rest/deactivateusers/1.0/form/user/alert/trigger