Hosted Signup::ConsumerSignup

This procedure will create a new consumer user and send a welcome email.

Input Arguments	Required	Description
<preferredDomainController>	Yes	The domain controller to use for Active Directory actions.
<Container>	Yes	A valid Lightweight Directory Access Protocol (LDAP) path of the OU where the new user will be created. For example LDAP://OU=Reseller1,OU=Hosting,DC= fabrikam ,DC=Com
userPrincipalName>	Yes	The UPN of the user
<password>	No	If password is not specified, it will be auto generated.
<description>	No	The description of the user
<displayName>	No	The users display name
<givenName>	No	The users display name
<middleName>	No	The users middle name
<sn>	No	The users surname
<externalMailAddress>	No	The users external mail address. If this node is present, an email will be sent otherwise this procedure will be skipped.
<senderAddress>	Yes	Required if externalMailAddress is specified. The "from" mail address
<mailSubject>	Yes	Required if externalMailAddress is Specified. The email subject line
<mailMessage>	Yes	Required if externalMailAddress is specified and template is NOT present. The body of the email. This node is required if <template> is not present. If template node is used mailMessage will be ignored.
<mailFormat>	No	Values are either "text" or "html". Default is text
<messagePriority>	No	Values are either "Low", "normal" or "high". Default is normal
<template>	No	If present, mailMessage is ignored. If template is specified, all messages will be sent as HTML.
<mailSubject>	Yes	Required (if template node is specified) The top level node holding the collection of properties.
<propertyList>	Yes	Required if externalMailAddress is Specified. The email subject line
<property>	Yes	Required (if template node is specified). The property to be set in the template
<smtpServer>	No	The sending mail server. Default is localhost unless otherwise specified
<smtpUser>	No	The user authentication credentials. Default is anonymous unless otherwise specified.
<smtpPass>	No	The password authentication credentials. Default is anonymous unless otherwise specified.

Output Arguments	Description
<userLdap>	The LDAP path of the user.
<password>	The password assigned to the user.
<mailStatus>	Confirmation of successful mailing.

Remarks

Sample Code

Example XML Request

<request>
  <procedure>
	<execute namespace="Hosted Signup" procedure="ConsumerSignup" impersonate="1">
	<executeData>
		<preferredDomainController>ad01.fabrikam.com</preferredDomainController> 	<container>LDAP://OU=LitwareInc,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</container>
		<userPrincipalName>admin@AlpineSkiHouse.com</userPrincipalName>
		<password>Pass1w0rd</password>
		<description>user</description>
		<displayName></displayName>
		<givenName>Bob</givenName>
		<middleName>John</middleName>
		<sn>Smith</sn>
		<externalMailAddress>bobsmith@hotmail.com</externalMailAddress>
		<senderAddress>welcome@fabrikam.com</senderAddress>
		<mailSubject>Welcome to Fabrikam Hosting</mailSubject>
		<mailMessage>This message is to inform you of your new hosting account.</mailMessage>
		<mailFormat>HTML</mailFormat>
		<messagePriority>HIGH</messagePriority>
		<smtpServer>mail.fabrikam.com</smtpServer>
		<smtpUser>fabrikam\welcome</smtpUser>
		<smtpPass>Pass1Word</smtpPass>
	</executeData>
	<after source="executeData" destination="data" />
	</execute>
  </procedure>
</request>

Example XML Response

<request>
  <procedure>
	<execute namespace="Hosted Signup" procedure=" ConsumerSignup" impersonate="1">
	<executeData> <userLdap>LDAP://CN=admin@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,
OU=Hosting,DC=Fabrikam,DC=Com</userLdap>
		<mailStatus>Message Sent Sucessfully</mailStatus>
	</executeData>
	<after source="executeData" destination="data" />
	</execute>
  </procedure>
</request>

Applies To