Office Communications Server Provider::GetSipUserProperties

This procedure retrieves a listing of SIP User properties from an Active Directory account enabled for Office Communications Server.

Arguments

Input argument	Required	Type	Description
<preferredDomainController>	Yes	string	The domain controller to use for Active Directory actions.
<userDN>	Yes	string	The distinguished name of the Active Directory object that is associated with the OCS user.

Output argument	Type	Description
<allowOrganizeMeetingWithAnonymousParticipants>	boolean	This parameter indicates whether to allow the user to invite anonymous users to meetings. If true the user is allowed to invite anonymous users. If false the user is not allowed to invite anonymous users. The default is false.
<archiveFederatedCommunications>	boolean	This setting indicates whether to archive the user's communications across federated domains.
<archiveInternalCommunications>	boolean	This setting indicates whether to archive the user's communications within their internal domain.
<contactType>	string	When the UserCategory property is set to contact, ContactType specifies whether the contact is an auto attendant (AA) or a normal (default) contact. Possible values: default: The contact is a normal contact. AA: The contact is an auto attendant.
<enabled>	boolean	This parameter indicates whether to enable the user for Office Communications Server. If true, the user is enabled for Office Communications Server. If false, the user does not have specific support under SIP.
<enabledForEnhancedPresence>	boolean	This parameter indicates whether to enable the user for enhanced presence. If true, the user is enabled for enhanced presence. If false, the user is not enabled for enhanced presence. The default is false.
<enabledForFederation>	boolean	This parameter indicates whether to enable the user for federation. If true, the user is enabled for federation. If false, the user is not enabled for federation. The default is false.
<enabledForInternetAccess>	boolean	This parameter indicates whether to enable the user for Internet access. If true, the user is enabled for Internet access. If false, the user is not enabled for Internet access. The default is false.
<homeServerDN>	string	This parameter specifies the distinguished name of the Pool Service (msRTCSIP-PoolService) where the Office Communications Server user is hosted.
<instanceID>	string	A GUID value that uniquely identifies an instance of this class. It is the object GUID of the Active Directory object associated with this user. The GUID is encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".
<ipPBXSoftPhoneRoutingEnabled>	boolean	If true, the user is enabled for both remote call control and Enterprise Voice. This requires that UCEnabled be set to true.
<lineServerURI>	string	The SIP URI of the telephony gateway server assigned to this user for remote-call control (RCC). A valid SIP URI uses the following form: Sip:abc@pbx1.phones.microsoft.com. This property is not indexed, but is marked for global container replication. If RemoteCallControlTelephoneyEnabled is true, this value cannot be NULL. The value of this property is not case-sensitive. The maximum length of the string is 454 characters.
<lineURI>	string	Either the SIP URI or the Tel. URI of the user's phone line. This value is used by the Microsoft Office Communicator client and by Enterprise Voice for call routing. A valid SIP URI uses the following form: sip:+14257777777@phones.fabrikam.com;user=phone.This SIP URI value must be unique. A valid Tel. URI uses the following form: tel:+14257071111;ext=71111;attribute=telephone number This property is indexed and marked for global container replication. If RemoteCallControlTelephoneyEnabled is true, this value cannot be NULL. The value of this property is not case-sensitive. The maximum length of the string is 454 characters.
<meetingPolicy>	string	This parameter specifies the name of the meeting policy to be applied to the user.
<primaryURI>	string	The primary SIP URI of the user. This URI must be unique and must be represented in the form "sip:user@domain" where the domain substring is either a fully qualified domain name or a valid IP address. The maximum length of the string is 454 characters.
<publicNetworkEnabled>	boolean	This parameter indicates whether the user is able to exchange instant messages with other users who are hosted by one or more public Instant Messaging (IM) service providers. If true, the user is authorized for public IM connectivity. If false, the user is not authorized for public IM connectivity. The default is false.
<targetServerDNIfMoving>	string	This parameter indicates the distinguished name of the target server to which the Active Directory user object is moving, if a user move is in progress.
<remoteCallControlTelephonyEnabled>	boolean	This parameter indicates whether the user is able to use the Microsoft Office Communicator client in combination with the user's computer to initiate, receive, and forward phone calls. If true, the user is authorized for remote call control. If false, the user is not authorized for remote call control. If the value is true, LineURI and LineServerURI cannot be null. The default value is false.
<ucEnabled>	boolean	This parameter indicates whether to enable the user for Unified Communications. If true, the user is enabled for Unified Communications. If false, the user is not enabled for Unified Communications. The default is false.
<ucPolicy>	string	This parameter specifies the distinguished name of the Unified Communications policy assigned for this user. This parameter is required if the user is enabled for Unified Communications.
<userCategory>	string	This parameter indicates whether the user is represented in Active Directory by a "user" object, a "contact" object, or an "inetOrgPerson" object.
<userDN>	string	This parameter specifies the distinguished name of the Active Directory object that is associated with the Office Communications Server user.

Remarks

Sample Code

Example XML Request

<request>
  <data>
	<preferredDomainController>ad01.fabrikam.com</preferredDomainController>
	<userDN>CN=JohnC@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</userDN>
  </data>
  <procedure>
	<execute namespace="Office Communications Server Provider" procedure="GetSipUserProperties" impersonate="2">
	<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
	<before source="data" sourcePath="userDN" destination="executeData" mode="move" />
	<after source="executeData" destination="data" mode="merge" />
	</execute>
  </procedure>
</request>

Example XML Response

<response>
  <data>
	<userDN>CN=johnc@alpineskihouse.com,OU=alpineskihouse,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=com</userDN>
	<homeServerDN>CN=LC Services,CN=Microsoft,CN=pool01,CN=Pools,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</homeServerDN>
	<primaryURI>sip:johnc)@alpineskihouse.com</primaryURI>
	<enabled>true</enabled>
	<enabledForEnhancedPresence>true</enabledForEnhancedPresence>
	<enabledForFederation>false</enabledForFederation>
	<enabledForInternetAccess>false</enabledForInternetAccess>
	<publicNetworkEnabled>false</publicNetworkEnabled>
	<allowOrganizeMeetingWithAnonymousParticipants>true</allowOrganizeMeetingWithAnonymousParticipants>
	<archiveFederatedCommunications>true</archiveFederatedCommunications>
	<archiveInternalCommunications>true</archiveInternalCommunications>
	<ipPBXSoftPhoneRoutingEnabled>false</ipPBXSoftPhoneRoutingEnabled>
	<lineServerURI>sip:server01@pbx1.phones.fabrikam.com</lineServerURI>
	<lineURI>tel:+15555550101</lineURI>
	<meetingPolicy>CN={6B151D61-D98B-4A16-9D6C-8BBB3111228A},CN=Policies,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</meetingPolicy>
	<remoteCallControlTelephonyEnabled>true</remoteCallControlTelephonyEnabled>
	<ucEnabled>false</ucEnabled>
	<ucPolicy>CN={6B41BE99-5C45-41E5-B34C-F6B8D0079E7B},CN=Policies,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</ucPolicy>
	<displayName>John Chen</displayName>
	<instanceID>{ee04a1e0-b99a-464a-b9cf-53b230669e5c}</instanceID>
	<userCategory>user</userCategory>
	<contactType>default</contactType>
  </data>
</response>

Applies To