This document provides the details of the application programming interface (API) for the Managed CDI Namespace included with the Microsoft Provisioning System (MPS) in the . Contained herein are descriptions of the procedures of this namespace along with method input parameters and return values. In addition, example Extensible Markup Language (XML) requests are provided along with a typical 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 Customer Directory Integration (CDI) Service provisioning tasks or as a basis for review of the CDI named procedures that are exposed in the MPS Web Service.
The intended use of this API is for client applications that will perform CDI-specific provisioning tasks.
The Managed CDI Namespace is a new namespace for , that provides a set of Microsoft Provisioning Framework (MPF) public named procedures for provisioning the CDI Service. The namespace enables Service Providers to provision the CDI Service to customer organizations and users through the managed provisioning environment of MPS, using the MPF Engine, version 2.1.
The CDI Service enables you to provide automated password synchronization and unification facilities to customer users. This enables customer users to update and synchronize their domain account password with the Service Provider Hosted Messaging and Collaboration sign-on password, so they can use a single username and password set for both logons.
Microsoft Identity Integration Server (MIIS) 2003, Enterprise Edition, forms the basis of the CDI functionality in the . To enable MIIS to map users in the customer Active Directory directory services to corresponding users in the Service Provider shared Active Directory and subsequently to perform the password synchronization function, anchor attribute values must be created and stored in the user accounts and the Customer Plans database. These attributes consist of the user account adminDescription property, which is stamped with the user principal name (UPN) of the customer user, and a Service Pointer object that contains customer domain information.
When a customer organization is enabled for the CDI Service by calling the EnableOrganization procedure described herein, the Service Pointer object is created. When a customer user is enabled for the CDI Service by calling the EnableUser procedure, the adminDescription attribute of that user account is stamped with the UPN of the customer user. These attributes enable MIIS to link customer and Service Provider user objects in the MIIS connector space, synchronize password changes, and push them out to the customer's domain.
The Managed CDI Namespace interacts with the Active Directory Provider to manage CDI settings for users and organizations. Provisioning tasks that you can accomplish with this namespace include:
You install the Managed CDI Namespace with the MPS Deployment Tool. Because the functionality of this namespace depends on interaction with other components, you must ensure that you queue the following components for installation with the tool at deployment design time:
These components install with MPS core components.
|Managed CDI::EnableOrganization||Enables a customer organization for the CDI Service.|
|Managed CDI::DisableOrganization||Disables a customer organization for the CDI Service.|
|Managed CDI::GetOrganizationSettings||Retrieves the CDI settings for a specified organization.|
|Managed CDI::ModifyOrganization||Modifies the CDI settings for a customer organization.|
|Managed CDI::EnableUser||Enables a customer user for the CDI Service.|
|Managed CDI::DisableUser||Disables a customer user for the CDI Service.|
|Managed CDI::GetUserSettings||Dets the current CDI settings for a specified customer user.|
|Managed CDI::ModifyUser||Modifies the CDI settings for a specified customer user.|