GET

Get detailed directory data list

Lists detailed directory data for all directories which match the search and active criteria queried by the System Admin

Request

Query parameters

start

integer

limit

integer

search

string

active

boolean

Responses

a paginated list of detailed directories data matching system admins search criteria

application/json

any

GET/rest/admin/1.0/directory/detailed
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/directory/detailed' \ --header 'Accept: application/json'
200Response
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 { "values": [ { "id": 1, "displayName": "Directory One", "directoryType": "INTERNAL", "descriptiveName": "Crowd Internal Directory", "active": true, "synchronizable": false, "synchronizationStatus": null }, { "id": 2, "displayName": "Directory Two", "directoryType": "CONNECTOR", "descriptiveName": "Apache Directory Server 1.5.x", "active": true, "synchronizable": true, "synchronizationStatus": { "status": "SUCCESS", "startDate": 0, "endDate": 1, "type": "FULL" } } ], "size": 2, "start": 0, "limit": 50, "isLastPage": true }
GET

Get detailed directory data

Retrieves detailed directory data for directory specified by ID by system admin

Request

Path parameters

directoryId

integer

Required

Responses

detailed directory data for specified directory

application/json

any

GET/rest/admin/1.0/directory/detailed/{directoryId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/directory/detailed/{directoryId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 { "id": 1, "displayName": "Directory One", "directoryType": "INTERNAL", "descriptiveName": "Crowd Internal Directory", "active": true, "synchronizable": false, "synchronizationStatus": null }
POST

Schedule synchronisation

Schedules a Synchronisation for the given directory specified

Request

Path parameters

directoryId

integer

Required

Responses

synchronisation action was performed successfully

POST/rest/admin/1.0/directory/detailed/{directoryId}/synchronize
1 2 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/directory/detailed/{directoryId}/synchronize'
GET

Get managed directories

Lists the directories managed by the logged in user

Request

Query parameters

start

integer

limit

integer

Responses

the search was performed successfully

application/json

any

GET/rest/admin/1.0/directory/managed
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/directory/managed' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "values": [ { "id": 1, "displayName": "Directory One", "directoryType": "INTERNAL" }, { "id": 2, "displayName": "Directory Two", "directoryType": "INTERNAL" } ], "size": 2, "start": 0, "limit": 50, "isLastPage": true }

Rate this page: