This document provides the details of the Application Programming Interface (API) for the Hosted Active Directory Namespace included with the Microsoft® Provisioning System (MPS) in the Microsoft Hosted Messaging and Collaboration version 4.5. 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 typical XML responses 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 Hosted active directory services or as a basis for review of the Hosted Active Directory named procedures that are implemented in the Web Service.
Public Method | Description |
---|---|
Hosted Active Directory::ADSearch | Performs a directory search in Microsoft Active Directory. |
Hosted Active Directory::ChangeOrganizationPlanAssignment | Changes a service plan from one plan to another for a customer. |
Hosted Active Directory::ChangeUserPassword | Changes the password of a customer Active Directory user object. |
Hosted Active Directory::CreateContact | Creates an Active Directory Contact object. |
Hosted Active Directory::CreateGroup | Creates an Active Directory Group object. |
Hosteded Active Directory::CreateIIWResellerOrganization | Creates an IIW (Individual Information Worker) Reseller Organization. |
Hosteded Active Directory::CreateIIWTenant | Creates an IIW Tenant Organization and Admin user. |
Hosted Active Directory::CreateOrganization | Creates an organization. |
Hosted Active Directory::CreateOrganizationPlan | Creates a plan for the service that can be applied to an organizational unit. |
Hosted Active Directory::CreateResellerOrganization | Creates a reseller organization in the specified container. |
Hosted Active Directory::CreateUser | Ceates a user based on the provided plan type. |
Hosted Active Directory::DeleteContact | Deletes a contact. |
Hosted Active Directory::DeleteGroup | Deletes a group. |
Hosted Active Directory::DeleteOrganization | Deletes an organization, marks the organization deleted in the plan database, and records a billing event. |
Hosted Active Directory::DeleteUser | Deletes a user, marks the user deleted in the plan database, and records a billing event. |
Hosted Active Directory::DisableUser | Disables a User object in Active Directory and records a billing event. |
Hosted Active Directory::EnableUser | Enables a User object in Active Directory and records a billing event. |
Hosted Active Directory::GetCallerUiRoles | Gets the UI roles for the caller. |
Hosted Active Directory::GetOrganizationPlan | Retrieve the details of an existing service plan. |
Hosted Active Directory::GetOrganizationPlanAssignment | Retrieves the plans assigned to a given customer. |
Hosted Active Directory::GetProperties | Gets properties for a specified object using a Lightweight Directory Access Protocol (LDAP) path. |
Hosted Active Directory::GetServiceInformation | Returns the information used to register the Hosted Active Directory service. |
HostedActiveDirectory::GetTenantRoot | Returns the DN of the Tenant object when supplied a path to an Active Directory object. |
Hosted Active Directory::GroupAdd | Adds a member to a group. |
Hosted Active Directory::GroupRemove | Removes an item as a member to a group. |
Hosted Active Directory::Initialize | Initializes the Hosted Active Directory namespace with the Plans Manager database. This should be run before any of these procedures are called. |
Hosted Active Directory::MakeUserAdmin | Adds or removes a customer user from the Administrators group in the user's organization. |
Hosted Active Directory::ModifyContact | Modifies the attributes of a contact's Active Directory object. |
Hosted Active Directory::ModifyGroup | Modifies the attributes of a group's Active Directory object. |
Hosted Active Directory::ModifyOrganizationPlan | Modifies attributes of an existing organization plan. |
Hosted Active Directory::ModifyUser | Modifies the attributes of a user's Active Directory object. |
Hosted Active Directory::RenameUser | Renames a user account. |
Hosted Active Directory::SetProperties | Sets one or more properties for an object. |
Hosted Active Directory::SetUserPassword | Sets the password of a customer Active Directory user object. |
Hosted Active Directory::Subscribe | Adds the Active Directory plan to the specified organization. |
Hosted Active Directory::Unsubscribe | Removes the Active Directory plan from the specified organization. |
Hosted Active Directory::UserIsSelf | If it is supplied a user object path, this procedure returns an isSelf value of 0 or 1 indicating whether the user summiting the request == the supplied user object. |
Applies To |