models.ldap_provider module

class models.ldap_provider.LdapProvider(ad_domain_name=None, auth_type=None, base_distinguished_name=None, domain_name=None, name=None, port=None, preferred_ldap_server_list=None, tenant_id=None, use_ssl=None, user_distinguished_name=None, user_password=None)

Bases: object

Implementation of the ‘LdapProvider’ model.

Specifies the configuration settings for an LDAP provider.

Attributes:

ad_domain_name (string): Specifies the domain name of an Active

Directory which is mapped to this LDAP provider

auth_type (AuthTypeEnum): Specifies the authentication type used while

connecting to LDAP servers. Authentication level. ‘kAnonymous’ indicates LDAP authentication type ‘Anonymous’ ‘kSimple’ indicates LDAP authentication type ‘Simple’

base_distinguished_name (string): Specifies the base distinguished

name used as the base for LDAP search requests.

domain_name (string): Specifies the name of the domain name to be used

for querying LDAP servers from DNS. If PreferredLdapServerList is set, then DomainName field is ignored.

name (string): Specifies the name of the LDAP provider. port (int): Specifies LDAP server port. preferred_ldap_server_list (list of string): Specifies the preferred

LDAP servers. Server names should be either in fully qualified domain name (FQDN) format or IP addresses.

tenant_id (string): Specifies the unique id of the tenant. use_ssl (bool): Specifies whether to use SSL for LDAP connections. user_distinguished_name (string): Specifies the user distinguished

name that is used for LDAP authentication. It should be provided if the AuthType is set to either kSimple or kSasl.

user_password (string): Specifies the user password that is used for

LDAP authentication.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.