ICILDAPAuthManagerSettings Interface

The LDAP Authentication Manager Settings interface members are listed below. See also ICISites - Multi-Site Management.

interface ICILDAPAuthManagerSettings : IDispatch

For an example using these properties, refer to the Windows Authentication script in Script Examples.

Members

  • Property AdditionalUserSettingsPath As String

  • Retrieves or specifies the path to the user database.

    HRESULT AdditionalUserSettingsPath([out, retval] BSTR* pVal);
    HRESULT AdditionalUserSettingsPath([in] BSTR newVal);

    EFT v6.3 and later

  • Property AutoCreateSettingsTemplate As String

  • Retrieves or specifies the path to the user database.

    HRESULT AutoCreateSettingsTemplate([out, retval] VARIANT_BOOL* pVal);
    HRESULT AutoCreateSettingsTemplate([in] VARIANT_BOOL newVal);

    EFT v7.4.13 and later

  • Property BaseDN As String

  • Retrieves or specifies the BaseDN.

    HRESULT BaseDN([out, retval] BSTR* pVal);
    HRESULT BaseDN([in] BSTR newVal);

    EFT v6.3 and later

  • Property ChaseReferrals As Boolean

  • Retrieves or specifies whether to enable chase referrals.

    HRESULT ChaseReferrals([out, retval] VARIANT_BOOL* pVal);
    HRESULT ChaseReferrals([in] VARIANT_BOOL newVal);

    EFT v6.3 and later

  • Property LDAPVersion As LDAPVersion

  • Retrieves or specifies the LDAP version.

    HRESULT LDAPVersion([out, retval] LDAPVersion* pVal);
    HRESULT LDAPVersion([in] LDAPVersion newVal);

    EFT v6.3 and later

  • Property LoginAttribute As String

  • Retrieves or specifies the login attribute.

    HRESULT LoginAttribute([out, retval] BSTR* pVal);
    HRESULT LoginAttribute([in] BSTR newVal);

    EFT v6.3 and later

  • Property PageSizeEntries As Long

  • Retrieves or specifies the search page size.

    HRESULT PageSizeEntries([out, retval] LONG* pVal);
    HRESULT PageSizeEntries([in] LONG newVal);

    EFT v6.3 and later

  • Property Port As Long

  • Retrieves or specifies the LDAP server port.

    HRESULT Port([out, retval] LONG* pVal);
    HRESULT Port([in] LONG newVal);

    EFT v6.3 and later

  • Property RefreshIntervalMinutes As Long

  • Retrieves or specifies how often to refresh the user database.

    HRESULT RefreshIntervalMinutes([out, retval] LONG* pVal);
    HRESULT RefreshIntervalMinutes([in] LONG newVal);

    EFT v6.3 and later

  • Property SearchAttributes As String

  • Retrieves or specifies the search attributes.

    HRESULT SearchAttributes([out, retval] BSTR* pVal);
    HRESULT SearchAttributes([in] BSTR newVal);

    EFT v6.3 and later

  • Property SearchScope As LDAPSearchScope

  • Retrieves or specifies the search scope.

    HRESULT SearchScope([out, retval] LDAPSearchScope* pVal);
    HRESULT SearchScope([in] LDAPSearchScope newVal);

    EFT v6.3 and later

  • Property Server As String

  • Retrieves or specifies the LDAP server host name.

    HRESULT Server([out, retval] BSTR* pVal);
    HRESULT Server([in] BSTR newVal);

    EFT v6.3 and later

  • Property ServerPassword As String

  • Retrieves or specifies the password for Simple authentication.

    HRESULT ServerPassword([out, retval] BSTR* pVal);
    HRESULT ServerPassword([in] BSTR newVal);

    EFT v6.3 and later

  • Property ServerUserName As String

  • Retrieves or specifies the username for Simple authentication.

    HRESULT ServerUserName([out, retval] BSTR* pVal);
    HRESULT ServerUserName([in] BSTR newVal);

    EFT v6.3 and later

  • Property SettingsTemplateAttributes As String

  • Retrieves or specifies Settings Template attributes.

    HRESULT SettingsTemplateAttributes([out, retval] BSTR* pVal);
    HRESULT SettingsTemplateAttributes([in] BSTR newVal);

    EFT v7.4.13 and later

  • Property TimeoutSeconds As Long

  • Retrieves or specifies the timeout in seconds.

    HRESULT TimeoutSeconds([out, retval] LONG* pVal);
    HRESULT TimeoutSeconds([in] LONG newVal);

    EFT v6.3 and later

  • Property UsePageControl As Boolean

  • Retrieves or specifies whether to control the search page size.

    HRESULT UsePageControl([out, retval] VARIANT_BOOL* pVal);
    HRESULT UsePageControl([in] VARIANT_BOOL newVal);

    EFT v6.3 and later

  • Property UserFilter As String

  • Retrieves or specifies the user filter.

    HRESULT UserFilter([out, retval] BSTR* pVal);
    HRESULT UserFilter([in] BSTR newVal);

    EFT v6.3 and later

  • Property UseSearchAttributes As Boolean

  • HRESULT UseSearchAttributes([out, retval] VARIANT_BOOL* pVal);
    HRESULT UseSearchAttributes([in] VARIANT_BOOL newVal);

    EFT v7.0.4 and later

  • Property UseSSL As Boolean

  • Retrieves or specifies whether to use SSL for LDAP authentication.

    HRESULT UseSSL([out, retval] VARIANT_BOOL* pVal);
    HRESULT UseSSL([in] VARIANT_BOOL newVal);

    EFT v6.3 and later

Dialog Box Equivalents

The ICILDAPAuthManagerSettings interface properties correlate to the following fields and controls in the EFT administration interface: