User Directories
General information
Available since v. 1.31.*
Available ONLY for Jira Administrators
Get all user directories
Method type -Â GET
URL: {JIRA_URL}/rest/extender/1.0/userDirectories/all
Response format -Â JSON
Example response
{
"userDirectories": [
{
"lastSyncStartDate": 1560411989302,
"lastSyncStatusKey": "directory.caching.sync.completed.FULL",
"lastSyncDuration": 40026,
"name": "LDAP Accounts",
"description": null,
"active": true,
"id": 10100,
"position": 1
},
{
"name": "JIRA Internal Directory",
"description": "JIRA Internal Directory",
"active": true,
"id": 1,
"position": 2
},
{
"lastSyncStartDate": 1552660659493,
"lastSyncStatusKey": null,
"lastSyncDuration": 37692,
"name": "Other LDAP Accounts",
"description": null,
"active": false,
"id": 10200,
"position": 3
}
],
"results": "3"
}
Â
Synchronize user directories
Method type -Â POST
URL: {JIRA_URL}/rest/extender/1.0/userDirectories/{DIRECTORY_ID}/synchronize
where {DIRECTORY_ID}Â is a directory id, like 10100
Example URL:
{JIRA_URL}/rest/extender/1.0/userDirectories/10100/synchronize
{JIRA_URL}/rest/extender/1.0/userDirectories/10100/synchronize?fullSynchronisation=true&runInBackground=true
Response format -Â JSON
Example response
{
"message": "synchronization request for directory '1' has been sent"
}
{
"message": "directory '10100' is now synchronising"
}
Parameters:
fullSynchronisation - optional - (true or empty) - if you need run full synchronization set to true, otherwise synchronization is incremental
FULL - Synchronise with the entire user base from remote directory
INCREMENTAL - Synchronise the changes since the last synchronization
You can check the configuration of your user directory in the settings, go to User Directories -> Edit -> Advanced Settings -> Enable Incremental Synchronization
runInBackground - optional - (true or empty) - if set to true, synchronization run in background mode, otherwise the request will wait at the end of synchronization