LDAP Configuration

Methods described in this section relate to the ldap configuration API. These methods can be accessed at TenableIE.ldap_configuration.

class LDAPConfigurationAPI(api: APISession)

details() → Dict

Get LDAP configuration singleton

Returns:

The LDAP configuration object

Return type:

dict

Examples

>>> tie.ldap_configuration.details()

update(**kwargs) → Dict

Update LDAP configuration singleton

Parameters:

• enabled (optional, bool) – Whether the ldap configuration enabled?

• url (optional, str) – The URL of authentication provider server.

• search_user_dn (optional, str) – The DN of service account to use to authenticate the user.

• search_user_password (optional, str) – The password of the service account used for authentication.

• user_search_base (optional, str) – The DN of the param object for items in LDAP server.

• user_search_filter (optional, str) – Used to change on what attribute the LDAP query is made to authenticate the user.

• allowed_groups (optional, List[Dict]) – The LDAP group a member need to be a member of so he can authenticate. The below listed params are expected in allowed groups dict.

• name (required, str) – The name of group.

• default_role_ids (required, List[int]) – The list default role identifiers.

• default_profile_id (required, int) – The default profile identifier.

Returns:

The LDAP configuration object

Example

>>> tie.ldap_configuration.update(
...     enabled=True,
...     allowed_groups=[{
...         'name': 'group name',
...         'default_role_ids': [1, 2],
...         'default_profile_id': 1
...     }]
... )