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

IDSSLDAPSettings3 Interface Reference

Inherits IDSSLDAPSettings2.

Inherited by IDSSLDAPSettings4.

List of all members.

Detailed Description

IDSSLDAPSettings3 is an interface exposed from DSSAuthSettings COM object.

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

1. LDAP search filters
2. Synchronization between LDAP user and MicroStrategy user
3. LDAP server string coding


Public Member Functions

HRESULT LDAPAttributeForGroupName ([in] BSTR LDAPAttributeForGroupName)
 The LDAP attribute for MicroStrategy group name.
HRESULT LDAPAttributeForGroupName ([out, retval] BSTR *pLDAPAttributeForGroupName)
 The LDAP attribute for MicroStrategy group name.
HRESULT LDAPAttributeForUserName ([in] BSTR LDAPAttributeForUserName)
 The LDAP attribute for MicroStrategy user name.
HRESULT LDAPAttributeForUserName ([out, retval] BSTR *pLDAPAttributeForUserName)
 The LDAP attribute for MicroStrategy user name.
HRESULT LDAPSearchFilterForDNFromLogin ([in] BSTR LDAPSearchFilterForDNFromLogin)
 The LDAP search filter to find the LDAP user based on LDAP login.
HRESULT LDAPSearchFilterForDNFromLogin ([out, retval] BSTR *pLDAPSearchFilterForDNFromLogin)
 The LDAP search filter to find the LDAP user based on LDAP login.
HRESULT LDAPSearchFilterForGroup ([in] BSTR LDAPSearchFilterForGroup)
 The LDAP search filter to find the LDAP groups of a LDAP user.
HRESULT LDAPSearchFilterForGroup ([out, retval] BSTR *pLDAPSearchFilterForGroup)
 The LDAP search filter to find the LDAP groups of a LDAP user.
HRESULT LDAPStringCoding ([in] EnumDSSLDAPStringCoding LDAPSynch)
 The string coding used in the LDAP server.
HRESULT LDAPStringCoding ([out, retval] EnumDSSLDAPStringCoding *pLDAPSynch)
 The string coding used in the LDAP server.
HRESULT LDAPSynch ([in] EnumDSSLDAPSynch LDAPSynch)
 The indicator of whether to synchronize users and/or groups.
HRESULT LDAPSynch ([out, retval] EnumDSSLDAPSynch *pLDAPSynch)
 The indicator of whether to synchronize users and/or groups.

Member Function Documentation

HRESULT IDSSLDAPSettings3::LDAPAttributeForGroupName (  [in] BSTR  LDAPAttributeForGroupName  ) 
 

The LDAP attribute for MicroStrategy group name.

The name of the LDAP attribute that maps the MicroStrategy group name. It is used to fill/update the name property of the MicroStrategy group when importing and synchronizing.

When the Vendor is set, the default value will be assigned as following.
Vendor Default Value
Novell cn
MicroSoft ADS cn
Sun/NetScape cn
Parameters:
LDAPAttributeForGroupName The BSTR that contains the name of the LDAP attribute
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPAttributeForGroupName is not allocated.

HRESULT IDSSLDAPSettings3::LDAPAttributeForGroupName (  [out, retval] BSTR *  pLDAPAttributeForGroupName  ) 
 

The LDAP attribute for MicroStrategy group name.

The name of the LDAP attribute that maps the MicroStrategy group name. It is used to fill/update the name property of the MicroStrategy group when importing and synchronizing.

When the Vendor is set, the default value will be assigned as following.
Vendor Default Value
Novell cn
MicroSoft ADS cn
Sun/NetScape cn
Parameters:
pLDAPAttributeForGroupName The pointer to the BSTR that contains the name of the LDAP attribute
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPAttributeForGroupName is not allocated.

HRESULT IDSSLDAPSettings3::LDAPAttributeForUserName (  [in] BSTR  LDAPAttributeForUserName  ) 
 

The LDAP attribute for MicroStrategy user name.

The name of the LDAP attribute that maps the MicroStrategy user name. It is used to fill/update the name property of the MicroStrategy user when importing and synchronizing.

When the Vendor is set, the default value will be assigned as following.
Vendor Default Value
Novell cn
MicroSoft ADS cn
Sun/NetScape cn
Parameters:
LDAPAttributeForUserName The BSTR that contains the name of the LDAP attribute
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPAttributeForUserName is not allocated.

HRESULT IDSSLDAPSettings3::LDAPAttributeForUserName (  [out, retval] BSTR *  pLDAPAttributeForUserName  ) 
 

The LDAP attribute for MicroStrategy user name.

The name of the LDAP attribute that maps the MicroStrategy user name. It is used to fill/update the name property of the MicroStrategy user when importing and synchronizing.

When the Vendor is set, the default value will be assigned as following.
Vendor Default Value
Novell cn
MicroSoft ADS cn
Sun/NetScape cn
Parameters:
pLDAPAttributeForUserName The pointer to the BSTR that contains the name of the LDAP attribute
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPAttributeForUserName is not allocated.

HRESULT IDSSLDAPSettings3::LDAPSearchFilterForDNFromLogin (  [in] BSTR  LDAPSearchFilterForDNFromLogin  ) 
 

The LDAP search filter to find the LDAP user based on LDAP login.

The predefined symbol for LDAP login, #LDAP_LOGIN#, should be in the search filter at least once. It will be replaced by the real LDAP login when searching for the LDAP user.

When the Vendor property is set, the default value will be assigned as following:
Vendor Default search filter
Novell (&(objectclass=person)(cn=#LDAP_LOGIN#))
Microsoft ADS (&(objectclass=person)(sAMAccountName=#LDAP_LOGIN#))
Sun/Novell (&(objectclass=person)(uid=#LDAP_LOGIN#))
Parameters:
LDAPSearchFilterForDNFromLogin The BSTR that contains the search filter
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPSearchFilterForDNFromLogin is not allocated.

HRESULT IDSSLDAPSettings3::LDAPSearchFilterForDNFromLogin (  [out, retval] BSTR *  pLDAPSearchFilterForDNFromLogin  ) 
 

The LDAP search filter to find the LDAP user based on LDAP login.

The predefined symbol for LDAP login, #LDAP_LOGIN#, should be in the search filter at least once. It will be replaced by the real LDAP login when searching for the LDAP user.

When the Vendor property is set, the default value will be assigned as following:
Vendor Default search filter
Novell (&(objectclass=person)(cn=#LDAP_LOGIN#))
Microsoft ADS (&(objectclass=person)(sAMAccountName=#LDAP_LOGIN#))
Sun/Novell (&(objectclass=person)(uid=#LDAP_LOGIN#))
Parameters:
pLDAPSearchFilterForDNFromLogin The pointer to the BSTR that contains the search filter
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPSearchFilterForDNFromLogin is not allocated.

HRESULT IDSSLDAPSettings3::LDAPSearchFilterForGroup (  [in] BSTR  LDAPSearchFilterForGroup  ) 
 

The LDAP search filter to find the LDAP groups of a LDAP user.

HRESULT IDSSLDAPSettings3::LDAPSearchFilterForGroup (  [out, retval] BSTR *  pLDAPSearchFilterForGroup  ) 
 

The LDAP search filter to find the LDAP groups of a LDAP user.

HRESULT IDSSLDAPSettings3::LDAPStringCoding (  [in] EnumDSSLDAPStringCoding  LDAPSynch  ) 
 

The string coding used in the LDAP server.

It is an enumeration value that indicates which character coding is used. Currently, the available enumeration values are

  • DssLDAPStringCodingUTF8 UTF8
  • DssLDAPStringCodingMultiByte MultiByte
    When the Vendor property is set, the default value will be assigned as following.
    Vendor Default String Coding
    Novell DssLDAPStringCodingUTF8
    MicroSoft ADS DssLDAPStringCodingMultiByte
    Sun/Netscape DssLDAPStringCodingUTF8
    Parameters:
    LDAPSynch The long value that indicates the string coding.
    Returns:
    Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPStringCoding is not allocated.

HRESULT IDSSLDAPSettings3::LDAPStringCoding (  [out, retval] EnumDSSLDAPStringCoding *  pLDAPSynch  ) 
 

The string coding used in the LDAP server.

It is an enumeration value that indicates which character coding is used. Currently, the available enumeration values are

  • DssLDAPStringCodingUTF8 UTF8
  • DssLDAPStringCodingMultiByte MultiByte
    When the Vendor property is set, the default value will be assigned as following.
    Vendor Default String Coding
    Novell DssLDAPStringCodingUTF8
    MicroSoft ADS DssLDAPStringCodingMultiByte
    Sun/Netscape DssLDAPStringCodingUTF8
    Parameters:
    pLDAPSynch The pointer to the long value that indicates the string code
    Returns:
    Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPStringCoding is not allocated.

HRESULT IDSSLDAPSettings3::LDAPSynch (  [in] EnumDSSLDAPSynch  LDAPSynch  ) 
 

The indicator of whether to synchronize users and/or groups.

It is a bit-wise value that indicates whether to synch user and/or group during authentication process. The current bit-wise values are:

  • DssLDAPSynchUser Synchronize user during authentication process
  • DssLDAPSynchGroup Synchronize group during authentication process
    Parameters:
    LDAPSynch The long value that contains the synch indicator
    Returns:
    Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPSynch is not allocated

HRESULT IDSSLDAPSettings3::LDAPSynch (  [out, retval] EnumDSSLDAPSynch *  pLDAPSynch  ) 
 

The indicator of whether to synchronize users and/or groups.

It is a bit-wise value that indicates whether to synch user and/or group during authentication process. The current bit-wise values are:

  • DssLDAPSynchUser Synchronize user during authentication process
  • DssLDAPSynchGroup Synchronize group during authentication process
    Parameters:
    pLDAPSynch The pointer to the long value that contains the synch indicator
    Returns:
    Usual COM result code:
  • S_OK
  • E_POINTER The memory of pLDAPSynch is not allocated

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