Managed Office Communications Server Namespace API

This document provides the details of the application programming interface (API) for the Managed Office Communications Server namespace included with the Microsoft® Provisioning System (MPS) in Hosted Messaging and Collaboration version 4.5.

Contained herein are descriptions of the procedures of this namespace along with 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 Office Communications Server 2007 services or as a basis for review of the Office Communications Server 2007 named procedures that are implemented in the Web Service.

Overview

The Managed Office Communications Server namespace is a new namespace for Microsoft Office Communications Server 2007 Hosting that exposes a set of Microsoft Provisioning Framework (MPF) public named procedures for the provisioning of Office Communications Server 2007 services. The namespace enables service providers to provision Office Communications Server 2007-enabled users in the managed provisioning environment of MPS.

The Managed Office Communications Server namespace provides public access to the Office Communications Server Provider procedures and implements role-based security for these calls. Additionally it implements association between Office Communications Server SIP Domains and organizational units.

Public Method	Description
Managed Office Communications Server::AddSharedPool	Adds an Office Communications pool to the shared pools list.
Managed Office Communications Server::CreateSipDomain	Creates a new SIP domain in the Office Communications Server for the specified organization.
Managed Office Communications Server::CreateSipUser	Adds an existing Active Directory user to the Office Communications Server.
Managed Office Communications Server::DeletePoolAssignment	Removes the Office Communication Server pool assignment from the specified organization.
Managed Office Communications Server::DeleteSharedPool	Deletes a pool from the list of shared pools.
Managed Office Communications Server::DeleteSipDomain	Removes an existing SIP domain from the Office Communications Server for the specified organization.
Managed Office Communications Server::DeleteSipUser	Removes a user from the Office Communications Server.
Managed Office Communications Server::GetPoolAssignment	Retrieves the assigned Office Communication Server pool of the specified organization.
Managed Office Communications Server::GetPoolProperties	Retrieves a pool's properties from the Office Communications Server.
Managed Office Communications Server::GetPools	Retrieves a list of Office Communications Server pools.
Managed Office Communications Server::GetSharedPools	Retrieves pools from the shared pools list.
Managed Office Communications Server::GetSipDomainsByOrganization	Retrieves an organization's SIP domains from the Office Communications Server.
Managed Office Communications Server::GetSipUserProperties	Retrieves the properties of an Office Communications Server user.
Managed Office Communications Server::Initialize	Initializes the Managed Office Communications Server namespace.
Managed Office Communications Server::RemoveSharedPool	Removes an Office Communications Server pool from the shared pools list.
Managed Office Communications Server::SetPoolAssignment	Assigns an Office Communications Server pool to the specified organization. The pool will be used as the preferred pool assignment when SIP enabling users.
Managed Office Communications Server::SetSharedPoolProperties	Sets properties for a shared Office Communications Server pool.
Managed Office Communications Server::SetSipUserProperties	Modifies the properties of an Office Communications Server user.
Managed Office Communications Server::ValidateSipDomainOwnership	Validates that a SIP domain is own by an organization or its parent.

Privileged Account Considerations

In order to perform certain actions within the Office Communications Server namespaces, additional privileges are required. These operations occur at the managed layer to allow users to perform actions that they would not normally be able to perform. These actions are performed under the context of the MPFServiceAcct. You need to understand the risk and the means that MPS uses to mitigate it within the Office Communications Server Managed Namespace. For more infromation about privilaged accounts, see Privilaged Accounts and the MPS Delegation Model.

Applies To