Versions Compared

Version Old Version 2 New Version Current
Changes made by

ILA eSolution

ILA eSolution

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

Get Users (version 1.3.2 and later)

GET http://localhost:8090/rest/deactivateusers/1.0/reports/list/all/active/users

GEThttp://localhost:8090/rest/deactivateusers/1.0/reports/list/all/neverlogin/users

GEThttp://localhost:8090/rest/deactivateusers/1.0/reports/list/all/deactive/users

GEThttp://localhost:8090/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]

Code Block
$ curl -u confuser -XGET \
http://localhost:8090/rest/deactivateusers/1.0/reports/list/all/active/users?type=0&days=30&group=confluence-users



Info

Update User Attributes (version 1.3.2 and later)

POST http://localhost:8090/rest/deactivateusers/1.0/utility/update/user/{username}

Path Parameters:

  • username (String) - Jira username

Query Parameters:

  • newEmail
  • newDisplayName
  • newUserName
  • addGroup (comma separated groups to add)

Response: [Status: 200]

Code Block
$ curl -u superadmin -XPOST -H "Content-Type:application/json" \
"http://localhost:8090/rest/deactivateusers/1.0/utility/update/user/croadmin/? \
newEmail=croadmin@noreply.com"
{"status":1,"message":"[Info] Updated User attributes ~ croadmin"}
$



Info

De-activate Users

Status
colourBlue
title

...

De-

...

Activate User

GETPOST http://localhost:8090/rest/deactivateusers/1.0/utility/list/deactiveusersde-activate/user/{username}  (version 1.3.2 and later)

Path Parameters:

  • username (String) - Jira username

Response: [Status: 200]

Code Block
$ curl -u"usersuperadmin:passwordsuperadmin" -XGETXPOST -H "Content-Type:application/json" \
http://localhost:8090/rest/deactivateusers/1.0/utility/list/deactiveusers \
["cro","thaikkp"]
de-activate/user/croadmin
{"status":1,"message":"[Info] De-activated User - croadmin"}
$

Status
colourBlue
titleDe-Activate User (Advance)

POST http://localhost:8090/rest/deactivateusers/1.0/utility/deactivate/user/{username}

...

  • username (String) - Jira username

Data Fields:

  • groups to remove e.g. ["group1", "group2"]

...

Code Block
$ curl -u"superadmin:superadmin" -XPOST -H "Content-Type:application/json" \
--data "['confluence-users']" \
http://localhost:8090/rest/deactivateusers/1.0/utility/deactivate/user/mamathavm4
{"status":1,"message":"[Info] De-activated User - mamathavm4"}
C:\>$




Info

Re-activate Users

Status
colourBlue
titleRe-Activate User

POST http://localhost:8090/rest/deactivateusers/1.0/utility/re-activate/user/{username}  (version 1.3.2 and later)

Path Parameters:

  • username (String) - Jira username

Response: [Status: 200]

Code Block
$ curl -u"superadmin:superadmin" -XPOST -H "Content-Type:application/json" \
http://localhost:8090/rest/deactivateusers/1.0/utility/reactivate/user/croadmin
{"status":1,"message":"[Info] Re-activated User - croadmin"}
$

Status
colourBlue
titleRe-Activate User (Advance)

POST http://localhost:8090/rest/deactivateusers/1.0/utility/reactivate/user/{username}

Path Parameters:

  • username (String) - Jira username

Data Fields:

  • groups to add e.g. ["group1", "group2"]

Response: [Status: 200]

Code Block
$ curl -u"superadmin:superadmin" -XPOST -H "Content-Type:application/json" \
--data "['confluence-users']" \
http://localhost:8090/rest/deactivateusers/1.0/utility/reactivate/user/mamathavm4
{"status":1,"message":"[Info] Re-activated User - mamathavm4"}
$

Note. It reverts rename prefix i.e. _inactive_ddmmyy


Status
colourBlue
title

...

run User De-Activation from CLI

POST http://localhost:8090/rest/deactivateusers/1.0/utility/run/userdeactivation

...

Code Block
$ curl -u"user:password" -XPOST -H "Content-Type:application/json" \
http://localhost:8090/rest/deactivateusers/1.0/utility/run/userdeactivation 
{"status":0,"message":"Users Updated - 0/2. Took 0.178 Seconds"}
$

Status
colourBlue
titleLEgacy run User De-Activation from CLI

POST http://localhost:8090/rest/deactivateusers/1.0/utility/legacyrun/userdeactivation

Response: [Status: 200]

Code Block
$ curl -u"user:password" -XPOST -H "Content-Type:application/json" \
http://localhost:8090/rest/deactivateusers/1.0/utility/legacyrun/userdeactivation 
{"status":0,"message":"Users Updated - 0/2. Took 0.178 Seconds"}
$

Note:

  • This legacy user deactivation processes all the users in confluence (irrespective of directories) but remote directory as default configured processing directory.

Status
colourBlue
titleRemove Defined Groups for User

...

Code Block
$ curl -u"user:password" -XPOST -H "Content-Type:application/json" \
--data "['confluence-users']" \
http://localhost:8090/rest/deactivateusers/1.0/utility/removegroups/user/prasadvecroadmin
{"status":1,"message":"[Info] Removed User Groups."}
$

...

Code Block
$ curl -u"user:password" -XPOST -H "Content-Type:application/json" \
http://localhost:8090/rest/deactivateusers/1.0/utility/removeallgroups/user/prasadvecroadmin
{"status":1,"message":"[Info] Removed User Groups."}
$

...

Code Block
$ curl -u"user:password" -XGET \
http://localhost:8090/rest/deactivateusers/1.0/utility/list/notactive/users/last/60
["croadmin","prasadveadminsuperadmin"]
$

Status
colourBlue
title

...

Get De-Activated Users

GET http://localhost:8090/rest/deactivateusers/1.0/utility/reactivate/user/{username}

Path Parameters:

  • username (String) - Jira username

Data Fields:

...

list/deactiveusers

Response: [Status: 200]

Code Block
$ curl -u"superadminuser:superadminpassword" -XPOST -H "Content-Type:application/json" --data "['confluence-users']" XGET \
http://localhost:8090/rest/deactivateusers/1.0/utility/reactivatelist/user/mamathavm4deactiveusers
{["statuscro":1,"message":thaikkp"[Info]
Re-activated User - mamathavm4"}
C:\>$