ICIADAuthManagerSettings Interface

Use the ICIADAuthManagerSettings interface to specify Active Directory authentication settings on a Site.

interface ICIADAuthManagerSettings : IDispatch {

VARIANT_BOOL equals VARIANT_TRUE(-1) when it is true and  VARIANT_FALSE(0) when it is false.

See also:

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

Properties

  • Property AssignHomeFolderFromUserProfile As Boolean

    • Retrieves or specifies whether to create a virtual folder using the user's home folder in the user's AD profile or to create a physical folder under the Site root folder using the user's username.

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

    TRUE(-1) =Virtual folder; FALSE(0) =Physical folder

    EFT v6.3 and later

  • Property CreateUsersOnlyByLogin As Boolean

    • HRESULT CreateUsersOnlyByLogin([out, retval] VARIANT_BOOL* pVal); 
[propput, id(9), helpstring("property CreateUsersOnlyByLogin")]
HRESULT CreateUsersOnlyByLogin([in] VARIANT_BOOL newVal);

    EFT v6.3 and later

  • Property Domain As String

    • Retrieves or specifies the domain name of the AD server. 

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

    EFT v6.3 and later

  • Property Group As String

    • Retrieves or specifies the group to use for Windows authentication (Everyone or a specific group). Multiple groups can be specified, separated by commas.

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

    EFT v6.3 and later

  • Property KeepHomeFoldersInSync As Boolean

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

    EFT v6.3 and later

  • Property LogonAttribute As ADAuthManagerLogonAttribute

    • Retrieves or specifies which user attribute to use for the logon name.

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

    EFT v6.3 and later

  • Property RefreshIntervalMinutes As Long

    • Retrieves or specifies the number of minutes between refreshing the user database.

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

    EFT v6.3 and later

  • Property SkipDomainPrefix As Boolean

    • Retrieves or specifies whether to add the domain prefix to the folder name.

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

    TRUE(-1) = Skip domain prefix; FALSE(0) =Do not skip domain prefix

    Example (VBScript):

    Retrieving: 

    MsgBox "Skip domain prefix: " & CStr(oADAM.SkipDomainPrefix)

    Specifying: 

    oADAM.SkipDomainPrefix = False

    EFT v6.3 and later

  • Property Type As ADAuthManagerType

    • Retrieves or specifies whether to use an AD server or local system account for Windows authentication.

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

    EFT v6.3 and later

  • Property UseWindowsAccessPermissions

    • Retrieves or specifies whether to use Windows access permissions.

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

    EFT v7.4.9 and later

Dialog Box Equivalents

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