Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSLDAPSettings5 Interface Reference

Inherits IDSSLDAPSettings4.

Inherited by IDSSLDAPSettings6.

List of all members.

Detailed Description

IDSSLDAPSettings5 is an interface exposed from DSSAuthSettings COM object.

It is derived from IDSSLDAPSettings, IDSSLDAPSettings2, IDSSLDAPSettings3, and IDSSLDAPSettings4. In addition to properties and methods of those interfaces, it contains the following setting for LDAP authentication:

1. LDAP Authentication User Binding
2. LDAP User Credential Verification
3. LDAP User Credential for Warehouse Connection


Public Member Functions

HRESULT AllowReusePreviousLDAPSecurityFilter ([in] VARIANT_BOOL iAllowReusePreviousLDAPSecurityFilter)
 Indicator of whether to allow using of previous LDAP security filter if a new one can not be created due to lack of LDAP attribuite values.
HRESULT AllowReusePreviousLDAPSecurityFilter ([out, retval] VARIANT_BOOL *opAllowReusePreviousLDAPSecurityFilter)
 Indicator of whether to allow using of previous LDAP security filter if a new one can not be created due to lack of LDAP attribuite values.
HRESULT BatchImportGroup ([in] EnumDSSLDAPImport iBatchImportGroup)
 The indicator of whether to import a LDAP group during batch LDAP import/synchronization.
HRESULT BatchImportGroup ([out, retval] EnumDSSLDAPImport *opBatchImportGroup)
 The indicator of whether to import a LDAP group during batch LDAP import/synchronization.
HRESULT BatchImportUser ([in] EnumDSSLDAPImport iBatchImportUser)
 The indicator of whether to import a LDAP user during batch LDAP import/synchronization.
HRESULT BatchImportUser ([out, retval] EnumDSSLDAPImport *opBatchImportUser)
 The indicator of whether to import a LDAP user during batch LDAP import/synchronization.
HRESULT BatchSearchFilterForGroups ([in] BSTR iBatchSearchFilterForGroups)
 The LDAP search filter for batch import/synchronize LDAP groups.
HRESULT BatchSearchFilterForGroups ([out, retval] BSTR *opBatchSearchFilterForGroups)
 The LDAP search filter for batch import/synchronize LDAP groups.
HRESULT BatchSearchFilterForUsers ([in] BSTR iBatchSearchFilterForUsers)
 The LDAP search filter for batch import/synchronize LDAP users.
HRESULT BatchSearchFilterForUsers ([out, retval] BSTR *opBatchSearchFilterForUsers)
 The LDAP search filter for batch import/synchronize LDAP users.
HRESULT BatchSynch ([in] EnumDSSLDAPSynch iBatchSynch)
 Indicator of whether to synch user and/or group during batch LDAP import/synchronization.
HRESULT BatchSynch ([out, retval] EnumDSSLDAPSynch *opBatchSynch)
 Indicator of whether to synch user and/or group during batch LDAP import/synchronization.
HRESULT LDAPAttributeDataTypes ([in] VARIANT *ipLDAPAttributeDataTypes)
 The list of LDAP attribute datatypes.
HRESULT LDAPAttributeDataTypes ([out, retval] VARIANT *opLDAPAttributeDataTypes)
 The list of LDAP attribute datatypes.
HRESULT LDAPAttributes ([in] VARIANT *ipLDAPAttributes)
 The list of LDAP attributes, which values will be read during login.
HRESULT LDAPAttributes ([out, retval] VARIANT *opLDAPAttributes)
 The list of LDAP attributes, which values will be read during login.
HRESULT LDAPAuthUserBind ([in] Int32 iLDAPAuthUserBind)
 Indicator of whether to keep or drop the authentication user bind after a LDAP login request.
HRESULT LDAPAuthUserBind ([out, retval] Int32 *opLDAPAuthUserBind)
 Indicator of whether to keep or drop the authentication user bind after a LDAP login request.
HRESULT LDAPVerification ([in] EnumDSSLDAPVerification iLDAPVerification)
 Indicator of whether to use password comparing or bind to verify the user credential.
HRESULT LDAPVerification ([out, retval] EnumDSSLDAPVerification *opLDAPVerification)
 Indicator of whether to use password comparing or bind to verify the user credential.
HRESULT NTAuthenticationWithLDAP ([in] VARIANT_BOOL iNTAuthenticationWithLDAP)
 Indicator of whether to use LDAP import/synch in Windows NT Authentication.
HRESULT NTAuthenticationWithLDAP ([out, retval] VARIANT_BOOL *opNTAuthenticationWithLDAP)
 Indicator of whether to use LDAP import/synch in Windows NT Authentication.
HRESULT RecursiveLDAPGroupSearchLevel ([in] Int32 iRecursiveLDAPGroupSearchLevel)
 Number of recursive LDAP group search level.
HRESULT RecursiveLDAPGroupSearchLevel ([out, retval] Int32 *opRecursiveLDAPGroupSearchLevel)
 Number of recursive LDAP group search level.
HRESULT SimpleSecurityPlugInWithLDAP ([in] VARIANT_BOOL iSimpleSecurityPlugInWithLDAP)
 Indicator of whether to use LDAP import/synch in Windows NT Authentication.
HRESULT SimpleSecurityPlugInWithLDAP ([out, retval] VARIANT_BOOL *opSimpleSecurityPlugInWithLDAP)
 Indicator of whether to use LDAP import/synch in Simple Security Plug-In Authentication.

Member Function Documentation

HRESULT IDSSLDAPSettings5::AllowReusePreviousLDAPSecurityFilter (  [in] VARIANT_BOOL  iAllowReusePreviousLDAPSecurityFilter  ) 
 

Indicator of whether to allow using of previous LDAP security filter if a new one can not be created due to lack of LDAP attribuite values.

The user will be refuesd to login the project if the user can not reuse the previous LDAP security filter.

Parameters:
iAllowReusePreviousLDAPSecurityFilter The boolean value that indicates whether to allow using of previous LDAP security filter.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSLDAPSettings5::AllowReusePreviousLDAPSecurityFilter (  [out, retval] VARIANT_BOOL *  opAllowReusePreviousLDAPSecurityFilter  ) 
 

Indicator of whether to allow using of previous LDAP security filter if a new one can not be created due to lack of LDAP attribuite values.

The user will be refuesd to login the project if the user can not reuse the previous LDAP security filter.

Parameters:
opAllowReusePreviousLDAPSecurityFilter The pointer to the boolean that indicates whether to allow using of previous LDAP security filter.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opAllowReusePreviousLDAPSecurityFilter is not allocated.

HRESULT IDSSLDAPSettings5::BatchImportGroup (  [in] EnumDSSLDAPImport  iBatchImportGroup  ) 
 

The indicator of whether to import a LDAP group during batch LDAP import/synchronization.

Parameters:
iBatchImportGroup The enumeration value that indicates whether to import group during batch LDAP import/synchronization.

HRESULT IDSSLDAPSettings5::BatchImportGroup (  [out, retval] EnumDSSLDAPImport *  opBatchImportGroup  ) 
 

The indicator of whether to import a LDAP group during batch LDAP import/synchronization.

Parameters:
opBatchImportGroup The pointer to the enumeration that indicates whether to import group during batch LDAP import/synchronization.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchImportGroup is not allocated.

HRESULT IDSSLDAPSettings5::BatchImportUser (  [in] EnumDSSLDAPImport  iBatchImportUser  ) 
 

The indicator of whether to import a LDAP user during batch LDAP import/synchronization.

Parameters:
iBatchImportUser The enumeration value that indicates whether to import user during batch LDAP import/synchronization.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchImportUser is not allocated.

HRESULT IDSSLDAPSettings5::BatchImportUser (  [out, retval] EnumDSSLDAPImport *  opBatchImportUser  ) 
 

The indicator of whether to import a LDAP user during batch LDAP import/synchronization.

Parameters:
opBatchImportUser The pointer to the enumeration that indicates whether to import user during batch LDAP import/synchronization.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchImportUser is not allocated.

HRESULT IDSSLDAPSettings5::BatchSearchFilterForGroups (  [in] BSTR  iBatchSearchFilterForGroups  ) 
 

The LDAP search filter for batch import/synchronize LDAP groups.

Parameters:
iBatchSearchFilterForGroups The string that indicates contains the LDAP search filter for batch import/synchronize LDAP groups.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchSearchFilterForGroups is not allocated.

HRESULT IDSSLDAPSettings5::BatchSearchFilterForGroups (  [out, retval] BSTR *  opBatchSearchFilterForGroups  ) 
 

The LDAP search filter for batch import/synchronize LDAP groups.

Parameters:
opBatchSearchFilterForGroups The pointer to the String that contains the LDAP search filter for batch import/synchronize LDAP groups.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchSearchFilterForGroups is not allocated.

HRESULT IDSSLDAPSettings5::BatchSearchFilterForUsers (  [in] BSTR  iBatchSearchFilterForUsers  ) 
 

The LDAP search filter for batch import/synchronize LDAP users.

Parameters:
iBatchSearchFilterForUsers The string that indicates contains the LDAP search filter for batch import/synchronize LDAP users.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchSearchFilterForUsers is not allocated.

HRESULT IDSSLDAPSettings5::BatchSearchFilterForUsers (  [out, retval] BSTR *  opBatchSearchFilterForUsers  ) 
 

The LDAP search filter for batch import/synchronize LDAP users.

Parameters:
opBatchSearchFilterForUsers The pointer to the String that contains the LDAP search filter for batch import/synchronize LDAP users.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchSearchFilterForUsers is not allocated.

HRESULT IDSSLDAPSettings5::BatchSynch (  [in] EnumDSSLDAPSynch  iBatchSynch  ) 
 

Indicator of whether to synch user and/or group during batch LDAP import/synchronization.

The current bit-wise values are:

  • DssLDAPSynchUser Synchronize user during authentication process
  • DssLDAPSynchGroup Synchronize group during authentication process
    Parameters:
    iBatchSynch The enumeration value that indicates whether to synch user and/or group during batch LDAP import/synchronization.
    Returns:
    Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchSynch is not allocated.

HRESULT IDSSLDAPSettings5::BatchSynch (  [out, retval] EnumDSSLDAPSynch *  opBatchSynch  ) 
 

Indicator of whether to synch user and/or group during batch LDAP import/synchronization.

The current bit-wise values are:

  • DssLDAPSynchUser Synchronize user during authentication process
  • DssLDAPSynchGroup Synchronize group during authentication process
    Parameters:
    opBatchSynch The pointer to the enumeration that indicates whether to synch user and/or group during batch LDAP import/synchronization.
    Returns:
    Usual COM result code:
  • S_OK
  • E_POINTER The memory of opBatchSynch is not allocated.

HRESULT IDSSLDAPSettings5::LDAPAttributeDataTypes (  [in] VARIANT *  ipLDAPAttributeDataTypes  ) 
 

The list of LDAP attribute datatypes.

The data type of a string-valued LDAP attribute is VT_BTSR. The data type of a DATE-valued LDAP attribute is VT_DATE. This list matches the LDAP attribute name list in LDAPAttributes.

Parameters:
ipLDAPAttributeDataTypes The VARIANT that contains an array of integers.
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG ipLDAPAttributeDataTypes is null or ipLDAPAttributeDataTypes does not contain an array of integer (VT_I4).

HRESULT IDSSLDAPSettings5::LDAPAttributeDataTypes (  [out, retval] VARIANT *  opLDAPAttributeDataTypes  ) 
 

The list of LDAP attribute datatypes.

The data type of a string-valued LDAP attribute is VT_BTSR. The data type of a DATE-valued LDAP attribute is VT_DATE. This list matches the LDAP attribute name list in LDAPAttributes.

Parameters:
opLDAPAttributeDataTypes The VARIANT that contains an array of integers.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opLDAPAttributeDataTypes is not allocated.

HRESULT IDSSLDAPSettings5::LDAPAttributes (  [in] VARIANT *  ipLDAPAttributes  ) 
 

The list of LDAP attributes, which values will be read during login.

Parameters:
ipLDAPAttributes The VARIANT that contains an array of string values for LDAP attribute names
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG ipLDAPAttributes is null or ipLDAPAttributes does not contain an array of strings.

HRESULT IDSSLDAPSettings5::LDAPAttributes (  [out, retval] VARIANT *  opLDAPAttributes  ) 
 

The list of LDAP attributes, which values will be read during login.

Parameters:
opLDAPAttributes The VARIANT that contains an array of string values for LDAP attribute names
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opLDAPAttributes is not allocated.

HRESULT IDSSLDAPSettings5::LDAPAuthUserBind (  [in] Int32  iLDAPAuthUserBind  ) 
 

Indicator of whether to keep or drop the authentication user bind after a LDAP login request.

Parameters:
iLDAPAuthUserBind The integer that indicates whether to keep or drop the authentication user bind.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opLDAPAuthUserBind is not allocated.

HRESULT IDSSLDAPSettings5::LDAPAuthUserBind (  [out, retval] Int32 *  opLDAPAuthUserBind  ) 
 

Indicator of whether to keep or drop the authentication user bind after a LDAP login request.

Value Meaning
0 Always drop the authentication user bind
1 or any positive number Keep the authentication user bind
Parameters:
opLDAPAuthUserBind The pointer to the integer that indicates whether to keep or drop the authentication user bind.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opLDAPAuthUserBind is not allocated.

HRESULT IDSSLDAPSettings5::LDAPVerification (  [in] EnumDSSLDAPVerification  iLDAPVerification  ) 
 

Indicator of whether to use password comparing or bind to verify the user credential.

It is an enumeration value. The current enumeration values are:
  • DssLDAPVerificationDefault Default value. Use the setting in the environment variable in the Intelligence Server.
  • DssLDAPVerificationBind Use LDAP bind to verify the LDAP user credential
  • DssLDAPVerificationPasswordCompare Use password comparing to verify the LDAP user credential if it is supported by the LDAP server.
Parameters:
iLDAPVerification The enumeration value that indicates whether to use LDAP bind or password comparing to verify the LDAP user credential.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opLDAPValification is not allocated.

HRESULT IDSSLDAPSettings5::LDAPVerification (  [out, retval] EnumDSSLDAPVerification *  opLDAPVerification  ) 
 

Indicator of whether to use password comparing or bind to verify the user credential.

It is an enumeration value. The current enumeration values are:
  • DssLDAPVerificationDefault Default value. Use the setting in the environment variable in the Intelligence Server.
  • DssLDAPVerificationBind Use LDAP bind to verify the LDAP user credential
  • DssLDAPVerificationPasswordCompare Use password comparing to verify the LDAP user credential if it is supported by the LDAP server.
Parameters:
opLDAPVerification The pointer to the enumeration that indicates whether to use LDAP bind or password comparing to verify the LDAP user credential.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opLDAPValification is not allocated.

HRESULT IDSSLDAPSettings5::NTAuthenticationWithLDAP (  [in] VARIANT_BOOL  iNTAuthenticationWithLDAP  ) 
 

Indicator of whether to use LDAP import/synch in Windows NT Authentication.

Parameters:
iNTAuthenticationWithLDAP The enumeration value that indicates whether to use LDAP import/synch in Windows NT Authentication.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opNTAuthenticationWithLDAP is not allocated.

HRESULT IDSSLDAPSettings5::NTAuthenticationWithLDAP (  [out, retval] VARIANT_BOOL *  opNTAuthenticationWithLDAP  ) 
 

Indicator of whether to use LDAP import/synch in Windows NT Authentication.

Parameters:
opNTAuthenticationWithLDAP The pointer to the boolean that indicates whether to use LDAP import/synch in Windows NT Authentication.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opNTAuthenticationWithLDAP is not allocated.

HRESULT IDSSLDAPSettings5::RecursiveLDAPGroupSearchLevel (  [in] Int32  iRecursiveLDAPGroupSearchLevel  ) 
 

Number of recursive LDAP group search level.

The default is 1. O means no LDAP group search.

Parameters:
iRecursiveLDAPGroupSearchLevel The integer indicates how many deepth to recusively search LDAP groups that a LDAP user belongs to.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSLDAPSettings5::RecursiveLDAPGroupSearchLevel (  [out, retval] Int32 *  opRecursiveLDAPGroupSearchLevel  ) 
 

Number of recursive LDAP group search level.

The default is 1. O means no LDAP group search.

Parameters:
opRecursiveLDAPGroupSearchLevel The pointer to the integer that indicates how many deepth to recusively search LDAP groups that a LDAP user belongs to.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opSimpleSecurityPlugInWithLDAP is not allocated.

HRESULT IDSSLDAPSettings5::SimpleSecurityPlugInWithLDAP (  [in] VARIANT_BOOL  iSimpleSecurityPlugInWithLDAP  ) 
 

Indicator of whether to use LDAP import/synch in Windows NT Authentication.

Parameters:
iSimpleSecurityPlugInWithLDAP The enumeration value that indicates whether to use LDAP import/synch in Simple Security Plug-In Authentication.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSLDAPSettings5::SimpleSecurityPlugInWithLDAP (  [out, retval] VARIANT_BOOL *  opSimpleSecurityPlugInWithLDAP  ) 
 

Indicator of whether to use LDAP import/synch in Simple Security Plug-In Authentication.

Parameters:
opSimpleSecurityPlugInWithLDAP The pointer to the boolean that indicates whether to use LDAP import/synch in Simple Security Plug-In Authentication.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of opSimpleSecurityPlugInWithLDAP is not allocated.

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.