DirectoriesApi
| Method | HTTP request | Description |
|---|---|---|
| GetDirectoryAttrMappingUsingGET | GET /api/web/v1/attributemappings/{id} | Get a directory attribute mapping |
| GetDirectoryAttrMappingsUsingGET | GET /api/web/v1/directories/{id}/attributemappings | List directory attribute mappings |
| GetDirectorySyncStatusInfoUsingGET | GET /api/web/v1/directorysyncinfo/{id} | Get directory synchronization status |
| GetDirectorySyncUsingGET | GET /api/web/v1/directorysyncs/{id} | Get directory synchronization settings |
| GetDirectorySyncsUsingGET | GET /api/web/v1/directories/{id}/directorysyncs | List directory sync settings |
| GetDirectoryUsingGET | GET /api/web/v1/directories/{id} | Get a directory |
| GetGroupFilterUsingGET | GET /api/web/v1/groupfilters/{id} | Get directory group filter |
| GetGroupFiltersUsingGET | GET /api/web/v1/directories/{id}/groupfilters | List directory group filters |
| GetSearchBaseUsingGET | GET /api/web/v1/searchbases/{searchbaseid} | Get a searchbase |
| GetSearchBasesUsingGET | GET /api/web/v1/directories/{id}/searchbases | List directory searchbases |
| ListDirectoriesUsingGET | GET /api/web/v1/directories | List directories |
GetDirectoryAttrMappingUsingGET
DirectoryAttributeMapping GetDirectoryAttrMappingUsingGET (string id)
Get a directory attribute mapping
Get the specified directory attribute mapping. Caller requires the DIRECTORIES:VIEW permission.
Using the GetDirectoryAttrMappingUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory attribute mapping to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetDirectoryAttrMappingsUsingGET
List<DirectoryAttributeMapping> GetDirectoryAttrMappingsUsingGET (string id)
List directory attribute mappings
List all directory attribute mappings for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetDirectoryAttrMappingsUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory whose directory attribute mappings are to be returned. |
Return type
List<DirectoryAttributeMapping>
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetDirectorySyncStatusInfoUsingGET
DirectorySyncStatusInfo GetDirectorySyncStatusInfoUsingGET (string id)
Get directory synchronization status
Get the specified directory synchronization status details. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetDirectorySyncStatusInfoUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory whose synchronization status is to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetDirectorySyncUsingGET
DirectorySync GetDirectorySyncUsingGET (string id)
Get directory synchronization settings
Get the specified directory synchronization settings. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetDirectorySyncUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory synchronization settings to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetDirectorySyncsUsingGET
List<DirectorySync> GetDirectorySyncsUsingGET (string id)
List directory sync settings
List all directory sync settings associated with the given directory sync agent. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetDirectorySyncsUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory sync agent whose directory sync settings are to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetDirectoryUsingGET
Directory GetDirectoryUsingGET (string id)
Get a directory
Get the specified directory. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetDirectoryUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetGroupFilterUsingGET
GroupFilter GetGroupFilterUsingGET (string id)
Get directory group filter
Get the specified directory group filter. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetGroupFilterUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory group filter to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetGroupFiltersUsingGET
List<GroupFilter> GetGroupFiltersUsingGET (string id)
List directory group filters
List all directory group filters for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetGroupFiltersUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory whose group filters are to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetSearchBaseUsingGET
SearchBase GetSearchBaseUsingGET (string searchbaseid)
Get a searchbase
Get the specified searchbase. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetSearchBaseUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchbaseid | string | The UUID of the searchbase to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetSearchBasesUsingGET
List<SearchBase> GetSearchBasesUsingGET (string id)
List directory searchbases
List all searchbases for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
Using the GetSearchBasesUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the directory whose searchbases are to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ListDirectoriesUsingGET
List<Directory> ListDirectoriesUsingGET ()
List directories
List all directories. Caller requires the DIRECTORIES:VIEW permission.
The following attributes are not included in the returned Directory object: directoryAttributeMappings, directorySync, groupFilters, searchBases. The get directory API can be used to acquire these attribute for a specific directory.
Example
Using the ListDirectoriesUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |