Managed Live Communications Namespace API

This document provides the details of the application programming interface (API) for the Managed Live Communications namespace included with the Microsoft Provisioning System (MPS) in Contained herein are descriptions of the procedures of this namespace along with method input parameters and return values. In addition, example XML requests are provided along with a typical Extensible Markup Language (XML) response that the provisioning system returns after a request is submitted to MPS and tasks are completed.

Developers should use this API document as a reference when creating XML requests that initiate the provisioning of Microsoft Office Live Communications Server 2005 services or as a basis for review of the Live Communications Server 2005 named procedures that are implemented in the Web Service.

Overview

The Managed Live Communication namespace is a new namespace for Microsoft Office Live Communications Server 2005 Hosting that exposes a set of Microsoft Provisioning Framework (MPF) public named procedures for the provisioning of Live Communications Server 2005 services. The namespace enables service providers to provision Live Communications Server 2005-enabled users in the managed provisioning environment of MPS. The Managed Live Communications namespace interacts with the Managed Active Directory Namespace API namespace and the Managed Helpers namespace to support provisioning tasks such as:

  • Enabling and disabling users and organizations.

  • Modifying the user's Live Communications Server 2005 properties.

  • Getting user properties.

  • Modifying the Live Communications Server 2005 properties of all current organizational users.

The intended use of this API is for client Web services and client applications that will perform Live Communications Server 2005-specific provisioning tasks.

Enabling Live Communications Server 2005 Users in Active Directory

Enabling a user object for Live Communications Services requires the stamping of various Active Directory attributes. The minimum attributes that must be configured to enable a user for Live Communications Server 2005 are as follows:

  • msRTCSIP-UserEnabled - A boolean value.

  • msRTCSIP-PrimaryUserAddress - The SIP address of the user, which is typically the user's UPN, for example, sip:jimc@alpineskihouse.com

  • msRTCSIP-PrimaryHomeServer - The distinguished name (DN) of a valid Live Communications Server 2005 pool.

The named procedures described in this document set these parameters appropriately when required.

Dependencies

You install the Managed Live Communications Namespace with the MPS Deployment Tool. Because the functionality of this namespace depends on interaction with other namespaces, you must ensure that you queue the following additional namespace components for installation with the Tool at deployment design time:

  • Managed Active Directory namespace - installs with MPS core components.

  • Managed Helpers namespace - installs with the Managed Hosted Messaging and Collaboration Namespace.

Public Method Description

Managed Live Communications::EnableUser

Enables a user object for Live Communications Server 2005.

Managed Live Communications::DisableUser

Disables a user object for Live Communications Server 2005.

Managed Live Communications::ModifyUser

Modifies the user's Live Communications Server 2005 properties.

Managed Live Communications::GetUserProperties

Returns the Live Communications Server 2005 properties for a specified user.

Managed Live Communications::EnableOrganizationUsers

Enables all user objects in an organization for Live Communications Server 2005.

Managed Live Communications::DisableOrganizationUsers

Disables all user objects in an organization for Live Communications Server 2005.

Managed Live Communications::ModifyOrganizationUsers

Modifies all user objects in an organization for Live Communications Server 2005.

Applies To

  • Hosted Messaging and Collaboration version 3.5