REST API - User Directories

General information

Available ONLY for Confluence administrators

 


Get all user directories

Method type - GET

URL: {CONFLUENCE_URL}/rest/extender/1.0/userDirectories/all

Response format - JSON

Example response:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 { "userDirectories": [ { "lastSyncStartDate": 1560411989302, "lastSyncStatusKey": "directory.caching.sync.completed.FULL", "lastSyncDuration": 40026, "name": "LDAP Accounts", "description": null, "active": true, "position": 1, "id": 10100 }, { "name": "Confluence Internal Directory", "description": "Confluence Internal Directory", "active": true, "position": 2, "id": 1 }, { "lastSyncStartDate": 1552660659493, "lastSyncStatusKey": null, "lastSyncDuration": 37692, "name": "Other LDAP Accounts", "description": null, "active": false, "position": 3, "id": 10200 } ], "results": "3" }

 


Synchronize user directories

Method type - POST

URL: {CONFLUENCE_URL}/rest/extender/1.0/userDirectories/{DIRECTORY_ID}/synchronize

  • where {DIRECTORY_ID} is a directory id, like 10100

Example URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/userDirectories/10100/synchronize

  • {CONFLUENCE_URL}/rest/extender/1.0/userDirectories/10100/synchronize?fullSynchronisation=true&runInBackground=true

Response format - JSON

Example response:

 

1 2 3 { "message": "synchronization request for directory '1' has been sent" }
1 2 3 { "message": "directory '10100' has been synchronized" }

 

1 2 3 { "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

  • runInBackground - optional - (true or empty) - if set to true, synchronization run in background mode, otherwise the request will wait at the end of synchronization