Share via

Hosted Live Communications::GetUserProperties

  • Article

The GetUserProperties procedure returns the Live Communications Server 2005 properties for a specified user.

Arguments

Input argument Required Description

<path>

Yes

The Lightweight Directory Access Protocol (LDAP) path of the user.

<preferredDomainController>

Yes

The name of the preferred domain controller.
Output argument Description

<homeServerPool>

The Live Communications Server 2005 homeServerPool distinguished name (DN).

<federationEnabled>

A boolean value (true/false).

<internetAccessEnabled>

An integer value (0 = use global default,1 = archive,2 = do not archive).

<archivingEnabled>

A boolean value (true/false).

<planName>

The user's Plan name.

Remarks

Process Steps

The following processes occur to return user properties with the GetUserProperties procedure:

  1. Get user's plan: call QueryPlansByCustomer

  2. Call Managed Live Communications::GetUserProperties

Security

The GetUserProperties procedure has the following security requirements:

  • The caller is impersonated.

Sample Code

Example XML Request

The following is an example of an XML request for the GetUserProperties procedure of the Hosted Live Communication Namespace:

<request> 
        <procedure> 
                <execute namespace="Hosted Live Communications" 
                 procedure="GetUserProperties" impersonate="1"> 
        <executeData> 
                        <path>LDAP://CN=andrewm@alpineskihouse.com,OU=alpineskihouse, 
                         OU=consolidatedmessenger,OU=Hosting,DC=FAbrikam,DC=Com</path> 
                        <preferredDomainController>AD01.fabrikam.com 
                        </preferredDomainController> 
                        </executeData> 
                        <after source="executeData" destination="data" mode="merge"/> 
                </execute> 
        </procedure> 
</request>

Example XML Response

The following is an example of an XML response for the GetUserProperties procedure of the Hosted Live Communication Namespace:

<response> 
        <data> 
        <path>LDAP://CN=jimc@alpineskihouse.com,OU=alpineskihouse, 
         OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path> 
        <preferredDomainController>AD01.fabrikam.COM 
        </preferredDomainController> 
        <homeServerPool>CN=LCSPool02,CN=Pools,CN=RTC  
         Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</homeServerPool> 
        <federationEnabled>true</federationEnabled> 
        <internetAccessEnabled>true</internetAccessEnabled> 
        <archivingEnabled>1</archivingEnabled> 
        <planName>LCSBasic</planName> 
        </data> 
</response>

Applies To

Hosted Live Communications Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

See also

Tasks

Hosted Live Communications::DisableOrganizationUsers