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(id)
Get a directory attribute mapping
Get the specified directory attribute mapping. Caller requires the DIRECTORIES:VIEW permission.
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(id)
List directory attribute mappings
List all directory attribute mappings for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
Get directory synchronization status
Get the specified directory synchronization status details. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
Get directory synchronization settings
Get the specified directory synchronization settings. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
List directory sync settings
List all directory sync settings associated with the given directory sync agent. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
Get a directory
Get the specified directory. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
Get directory group filter
Get the specified directory group filter. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
List directory group filters
List all directory group filters for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
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(searchbaseid)
Get a searchbase
Get the specified searchbase. Caller requires the DIRECTORIES:VIEW permission.
Example
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(id)
List directory searchbases
List all searchbases for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
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
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 | - |