DirectoriesApi
| Method | HTTP request | Description |
|---|---|---|
| get_directory_attr_mapping_using_get | GET /api/web/v1/attributemappings/{id} | Get a directory attribute mapping |
| get_directory_attr_mappings_using_get | GET /api/web/v1/directories/{id}/attributemappings | List directory attribute mappings |
| get_directory_sync_status_info_using_get | GET /api/web/v1/directorysyncinfo/{id} | Get directory synchronization status |
| get_directory_sync_using_get | GET /api/web/v1/directorysyncs/{id} | Get directory synchronization settings |
| get_directory_syncs_using_get | GET /api/web/v1/directories/{id}/directorysyncs | List directory sync settings |
| get_directory_using_get | GET /api/web/v1/directories/{id} | Get a directory |
| get_group_filter_using_get | GET /api/web/v1/groupfilters/{id} | Get directory group filter |
| get_group_filters_using_get | GET /api/web/v1/directories/{id}/groupfilters | List directory group filters |
| get_search_base_using_get | GET /api/web/v1/searchbases/{searchbaseid} | Get a searchbase |
| get_search_bases_using_get | GET /api/web/v1/directories/{id}/searchbases | List directory searchbases |
| list_directories_using_get | GET /api/web/v1/directories | List directories |
get_directory_attr_mapping_using_get
DirectoryAttributeMapping get_directory_attr_mapping_using_get(id)
Get a directory attribute mapping
Get the specified directory attribute mapping. Caller requires the DIRECTORIES:VIEW permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_directory_attr_mappings_using_get
List[DirectoryAttributeMapping] get_directory_attr_mappings_using_get(id)
List directory attribute mappings
List all directory attribute mappings for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_directory_sync_status_info_using_get
DirectorySyncStatusInfo get_directory_sync_status_info_using_get(id)
Get directory synchronization status
Get the specified directory synchronization status details. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_directory_sync_using_get
DirectorySync get_directory_sync_using_get(id)
Get directory synchronization settings
Get the specified directory synchronization settings. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_directory_syncs_using_get
List[DirectorySync] get_directory_syncs_using_get(id)
List directory sync settings
List all directory sync settings associated with the given directory sync agent. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_directory_using_get
Directory get_directory_using_get(id)
Get a directory
Get the specified directory. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_group_filter_using_get
GroupFilter get_group_filter_using_get(id)
Get directory group filter
Get the specified directory group filter. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_group_filters_using_get
List[GroupFilter] get_group_filters_using_get(id)
List directory group filters
List all directory group filters for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_search_base_using_get
SearchBase get_search_base_using_get(searchbaseid)
Get a searchbase
Get the specified searchbase. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchbaseid | str | 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 | - |
get_search_bases_using_get
List[SearchBase] get_search_bases_using_get(id)
List directory searchbases
List all searchbases for a given directory. Caller requires the DIRECTORIES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
list_directories_using_get
List[Directory] list_directories_using_get()
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
- Api Key Authentication (AdminAPIAuthentication):
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 | - |