Office Communications Server Provider API

This section provides the details of the application programming interface (API) for the Office Communications Server Provider 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 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

Office Communications Server Provider is a core component of Office Communications Server 2007 hosting. To enable Office Communications Server 2007 provisioning, this provider will work with Hosted Office Communications Server and Managed Office Communications Server namespaces in MPF (Microsoft Provisioning Platform). The procedures of this provider offer the ability of managing Office Communications Server 2007 components to upper namespaces. Inside the provider, Office Communications Server 2007 Management API will be invoked through a set of WMI (Windows Management Instrumentation) classes.

Public Method Description
Office Communications Server Provider::CreateFederationDomain Creates a SIP Domain to which the Edge server will route messages.
Office Communications Server Provider::CreateGlobalSipDomain Creates a new SIP Domain in the list of domains served by the running Office Communications Server.
Office Communications Server Provider::CreateSipUser Creates SIP user configuration for an existing Active Directory user.
Office Communications Server Provider::DeleteFederationDomain Deletes a SIP Domain from the Edge server.
Office Communications Server Provider::DeleteGlobalSipDomain Deletes a SIP Domain from the list of domains served by the running Office Communications Server.
Office Communications Server Provider::DeleteSipUser Deletes the Communications Server SIP user configuration from an Active Directory user.
Office Communications Server Provider::GetEdgeServers Retrieves a listing of Edge servers.
Office Communications Server Provider::GetFederationDomains Retrieves a listing of federation domains on a given Edge server.
Office Communications Server Provider::GetMeetingPolicyDNByName Retrieves the distinguished name of a Communications Server meeting policy by the policy's Name.
Office Communications Server Provider::GetMeetingPolicyNameByDN Retrieves the name of a Communications Server meeting policy by the policy's distinguished name.
Office Communications Server Provider::GetPoolFQDNByDN Retrieves the fully-qualified domain name of a Communications Server pool by its distinguished name.
Office Communications Server Provider::GetPoolProperties Retrieves a listing of properties for an Office Communications Server pool.
Office Communications Server Provider::GetPools Retrieves a listing of all Office Communications Server pools.
Office Communications Server Provider::GetSipDomains Retrieves a listing of all domains registered with the Office Communications Server.
Office Communications Server Provider::GetSipUserProperties Retrieves a listing of SIP User properties from an Active Directory account enabled for Office Communications Server.
Office Communications Server Provider::GetUCPolicyDNByName Retrieves the distinguished name of a Unified Communications (UC) meeting policy by the policy's name.
Office Communications Server Provider::GetUCPolicyNameByDN Retrieves the name of a UC policy by the policy's distinguished name.
Office Communications Server Provider::SetSipUserProperties Sets SIP user properties on an Active Directory user account enabled for Office Communications Server.
Privileged Account Considerations

In order to perform certain actions within the Office Communications Server namespaces, additional privileges are required. Office Communications Server provider uses a generic account that is a memeber of the RTCUniversalServerAdmins group when calling WMI. These operations occur at the provider 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 Provider Namespace. For more infromation about privilaged accounts, see Privilaged Accounts and the MPS Delegation Model.

 Applies To