Get user directories

GET
/api/v2/user-directories

Retrieve all user directories with pagination and filtering.

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

In: header

Query Parameters

sort_by?string

Sort by field name (optional). Available fields: "Name", "Type", "LastStartedSync", "SyncStatus"

name?string

User directory name used for filtering. Optional filter operators can be applied to refine the search:

  • equal (default)
  • contains
  • startswith
  • endswith
page?integer

Page number (1-based). Default is 1. Ignored when get_all = true.

Formatint32
Range1 <= value <= 2147483647
page_size?integer

Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true.

Formatint32
Range1 <= value <= 50
get_all?boolean

When true, pagination is disabled and all items are returned.

sort_direction?string

Sort direction: "asc" or "desc". Default is "asc" (optional)

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v2/user-directories"
{  "isSuccess": true,  "error": {},  "errorDetails": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "name": "string",      "prefix": "string",      "userDirectoryName": "string",      "azureClientId": "string",      "azureTenantId": "string",      "hostName": "string",      "port": 0,      "userName": "string",      "sendNotification": true,      "defaultUserRole": "12c86826-3b6a-4b8e-a933-763c01234cdc",      "filter": "string",      "synchronization": "string",      "frequency": "string",      "frequencyTime": "string",      "timeZone": "string",      "timeZoneOfset": "string",      "lastStartedSyncDate": "2019-08-24T14:15:22Z",      "lastSuccessfulSyncDate": "2019-08-24T14:15:22Z",      "nextExecutionDate": "2019-08-24T14:15:22Z",      "syncMessage": "string",      "syncStatus": "string",      "isActive": true,      "createdDate": "2019-08-24T14:15:22Z",      "modifiedDate": "2019-08-24T14:15:22Z",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"    }  ],  "resultInfo": {    "page": 0,    "perPage": 0,    "totalCount": 0,    "totalPages": 0,    "hasPreviousPage": true,    "hasNextPage": true  }}