Hosted Exchange::CreateConsumerUser2

This procedure creates a consumer user with attributes based on a specified service plan.

Input Arguments	Required	Description
container	Yes	A valid LDAP path of the OU where the new user will be created. For example LDAP://OU=alpineskihouse,OU=Reseller1,OU=Hosting,DC=fabrikam,DC=Com.
userPrincipalName	Yes	The User principal name of the user. Typically this would be <user>@<SMTPDomain> to enable UPN login to e-mail account with the user's e-mail address.
sAMAccountName	Yes	The sAMAccountName. Note: sAMAccountName cannot be longer than 20 characters. See SAM-Account-Name Attribute for more information.
preferredDomainController	Yes
planName	No	Defines which Exchange Mailbox service plan to apply to the user.
newPassword	No	If present the procedure will set the new user's password with the value of this element. All domain password policy restrictions apply.
displayName	No
givenName	No
middleName	No
sn	No	Surname of the user
initials	No
description	No
mailStoreXmlString	No	An XML string containing <mailStore> node: <mailStore>/<serverName>: The name of a server to allocate a user's mailbox to. If this optional parameter is present then <mailStoreName> must also be present. The mail store must be defined as a consumer mail store in resource management. <mailStore>/<mailStoreName>: The name of a mailstore to allocate a user's mailbox to. If this optional parameter is present then <serverName> must also be present. The mail store must be defined as a consumer mail store in resource management. `<mailStore> <serverName>EXBE02</serverName> <mailStoreName>ConsumerMailStore1</mailStoreName> </mailStore>`
propertiesXmlString	No	An XML string containing any valid AD properties for object class user, for example: `<properties> <property name="otherHomePhone"> <value>2065551212</value> <value>2065551213</value> </property> <property name="street">1703 NE 91st</property> </properties>`
proxyAddressesXmlString	No	An XML string containing any additional proxy addresses for the user. Ignored if planName is not provided. `<proxyAddresses> <value>bob2@litwareinc2</value> </proxyAddresses>`
alias	No	The procedure will accept this as an optional parameter. Other wise an alias will be generated from the UPN prefix (e.g. user from user@litwareinc.com)

Remarks

Method Syntax

public string CreateConsumerUser(
string container, 
string userPrincipalName, 
string samAccountName, 
string displayName,
string givenName, 
string middleName,
string sn, 
string alias, 
string description,
string newPassword,
string planName,
string mailStoreXmlString,
string propertiesXmlString, 
string proxyAddressesXmlString,
string preferredDomainController,
bool sendCredentials)

Sample Code

Example XML Response

MPS XML Response in string format.

<response>
  <data>
	<preferredDomainController>AD01.fabrikam.com</preferredDomainController>
	<container>LDAP://OU=litwareinc2,OU=WH,OU=Hosting,DC=fabrikam,DC=Com</container>
	<userPrincipalName>bob2@litwareinc2.com</userPrincipalName>
	<sAMAccountName>bob2</sAMAccountName>
	<displayName>Bob Smith</displayName>
	<givenName>Bob</givenName>
	<middleName>John</middleName>
	<sn>Smith</sn>
	<initials>bjs</initials>
	<newPassword do-not-log="1">Pass1Word</newPassword>
	<description>user</description>
	<planName>BaseMail</planName>
	<properties>
	<property name="otherHomePhone">
		<value>2065551212</value>
		<value>2065551213</value>
	</property>
	<property name="street">1703 NE 91st</property>
	<property name="msExchQueryBaseDN">CN=bob2@litwareinc2.com,OU=litwareinc2,OU=WH,OU=Hosting,DC=fabrikam,DC=com</property>
	<property name="mail">bob2@litwareinc2</property>
	<property name="msExchMailboxFolderSet">
		<value>98821</value>
	</property>
	<property name="showInAddressBook"
		mode="append">

		<value>CN=Default Global Address List,CN=All Global Address Lists,CN=Address Lists Container,CN=fabrikam,CN=Microsoft Exch
ange,CN=Services,CN=Configuration,DC=fabrikam,DC=com</value>
	</property>
	<property name="msExchUserAccountControl">0</property>
	</properties>
	<mail>
	<disablePOP>0</disablePOP>
	<size>10000</size>
	<disableIMAP>0</disableIMAP>
	<disableHTTP>0</disableHTTP>
	</mail>
	<proxyAddresses>
	<value>bob2@litwareinc2</value>
	</proxyAddresses>
	<user path="LDAP://AD01.fabrikam.COM/cn=bob2@litwareinc2.com,OU=litwareinc2,OU=WH,OU=Hosting,DC=fabrikam,DC=Com" name=""/>
  </data>
</response>

Typical C# Usage

//Get user name and password.   
		string userName = this.Request.ServerVariables.Get("AUTH_USER");
		string pass = this.Request.ServerVariables.Get("AUTH_PASSWORD");
		//Set credentials.
		hostedExch.PreAuthenticate = true;
		hostedExch.Credentials = new NetworkCredential(userName,pass);

		lblMsg.InnerHtml = mpsResponseHeaderLabel;
		//Display response.
		this.mpsResponse.DocumentSource = "";
		response = hostedExch.CreateConsumerUser(container, 
						 userPrincipalName, 
						 samAccountName, 
						 displayName,
						 givenName, 
						 middleName,
						 sn, 
						 alias, 
						 description,
						 newPassword,
						 planName,
						 mailStoreXmlString,
						 propertiesXmlString, 
						 proxyAddressesXmlString,
						 preferredDomainController,sendCredentials);
					
		// set the response XML to match the return from MPF
		responseXml.LoadXml(response);
		this.mpsResponse.Document = responseXml;
lblDone.InnerText = successMsg;

Applies To