LDAP
ping_ldap(configuration=None)
async
Pings the LDAP service with a configuration. If the configuration is empty, the current configuration is loaded.
Note
The original documentation for this endpoint has extremely broken english, and it's unclear what its purpose is.
Original documentation
This endpoint ping the available ldap service for test related configuration parameters.
param ldapconf: ldap configuration. support input ldap service configuration. If it is a empty request, will load current configuration from the system
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
configuration |
Optional[LdapConf]
|
The configuration to use for the ping.
Uses current system configuration if |
None
|
Returns:
| Type | Description |
|---|---|
LdapPingResult
|
The result of the ping |
search_ldap_groups(group_name=None, group_dn=None, limit=None)
async
Search for LDAP groups with a name or DN.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_name |
str
|
The name of the LDAP group to search for. |
None
|
group_dn |
str
|
The DN of the LDAP group to search for. |
None
|
limit |
Optional[int]
|
The maximum number of results to return. |
None
|
Returns:
| Type | Description |
|---|---|
List[UserGroup]
|
The list of LDAP groups that match the search. |
search_ldap_users(username, limit=None)
async
import_ldap_users(user_ids)
async
Import LDAP users with the given IDs.
In case of failure, check the resulting exception's errors attribute for
more information on which users failed to import.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_ids |
List[str]
|
A list of strings representing the IDs of the users to import. The system attempts to determine the remaining user information based on each user's ID. |
required |