get /about/api/default/userdirectory

Stability index

LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Query parameters

listentries (optional)

Return type

UserDirectory

Example data

Content-Type: application/json

{ "configured" : true, "privileges" : [ "privileges", "privileges" ], "settings" : [ { "userDirectorySettingType" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "modifiedByUserName" : "modifiedByUserName", "secretValue" : "secretValue", "schemaPath" : "schemaPath", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "name" : "name", "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "secret" : true, "category" : "category", "value" : "value" }, { "userDirectorySettingType" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "modifiedByUserName" : "modifiedByUserName", "secretValue" : "secretValue", "schemaPath" : "schemaPath", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "name" : "name", "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "secret" : true, "category" : "category", "value" : "value" } ], "schemaPath" : "schemaPath", "operationalError" : "operationalError", "operational" : true, "type" : "type", "userDirectoryName" : "userDirectoryName", "syncLastSuccessfulEnded" : "2000-01-23T04:56:07.000+00:00", "tags" : [ { "privileges" : [ "privileges", "privileges" ], "name" : "name", "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" }, { "privileges" : [ "privileges", "privileges" ], "name" : "name", "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" } ], "configuredError" : "configuredError", "creationType" : 1, "createdDate" : "2000-01-23T04:56:07.000+00:00", "modifiedByUserName" : "modifiedByUserName", "syncLastStarted" : "2000-01-23T04:56:07.000+00:00", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "name" : "name", "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "syncStatus" : 0, "syncOnlyLoggedInUsers" : true }

Responses

200
OK