Hosted Signup::IIWSignup

This procedure creates an IIW (Individual Information Worker) Tenant Organization and Admin user; as well as optionally generates a password and sends an email to a users alternate email address with the password. These actions are performed under the context of a privileged account created by Hosted Signup::Initialize.

This procedure is modeled very closely on Hosted Signup::BusinessSignup.

This procedure will be used by Web Portals that allow for anonymous or unauthenticated sign up, where a user that does not have any affiliation with a Service Provider or Reseller, browses.

Arguments

Input Arguments

Name	Required	Description
<container>	Yes	The LDAP path of the IIW Reseller organization under which this tenant should be created.
<userPrincipalName>	Yes	The UPN value for the new IIW Tenant user.
<preferredDomainController>	Yes	The name of the preferred Domain Controller.
<tenantOrgName>	No	This parameter is an override to specify the name of the Tenant organization. If it is not supplied, the name of the organization will be generated from the userPrincipalName of the user object.
<password>	Yes	The valid password for the new IIW Tenant user.
<description>	No	The description of the user object.
<displayName>	No	The user's display name.
<givenName>	No	The user's given name.
<middleName>	No	The user's middle name.
<sn>	No	The user's last name.
<Initials>	No	The user's initials.
<properties>	No	The valid Active Directory attributes for a user object. This property is passed in as an XML fragment string in the following format: `<properties> <property name="l">Some City</property> <property name="st">Washington</property> </properties>`
<externalMailAddress>	No	The user's external mail address. If this node is present, an email will be sent. Otherwise, this procedure will be skipped.
<senderAddress>	No	The "from" mail address. This parameter is required if parameter externalMailAddress is specified.
<mailSubject>	No	The email subject line. This parameter is required if parameter externalMailAddress is specified.
<mailMessage>	No	The body of the email. This node is required if template is not present. If template node is present, it will be ignored. This parameter is required if parameter externalMailAddress is specified and the template is NOT present.
<mailFormat>	No	Either "text" or "html". The default value is "text".
<messagePriority>	No	Its values are either "low", "normal" or "high". The default value is "normal".
<Template>	No	The mailMessage Template. If it is present, mailMessage is ignored. If the template is specified, all messages will be sent as HTML.
<mailSubject>	No	The email subject line.This parameter is required if template node is specified,
<propertyList>	No	The top level node holding the collection of properties. This parameter is required if template node is specified.
<propertyList\property>	No	The Property to be set in the template (template accepts name/value pair properties).This parameter is required if template node is specified.
<smtpServer>	No	The sending mail server. The default value is "localhost".
<smtpUser>	No	The user that will be authenticated on the smtpServer in order to relay the smtp message. Its default value is "anonymous".
<smtpPass>	No	The smtpUser's password by which to authenticate on the smtpServer in order to relay the smtp message.

Output Arguments

Name	Description
<userLDAP>	The LDAP Path of the IIW user object.
<password>	This is the generated password only. This node should only be present if the input does not include a password node.
<mailStatus>	The confirmation of successful mailing. It is only present if externalMailAddress was specified.

Remarks

Schema Definition

Input

<executeData>
  <preferredDomainController>1..1</preferredDomainController>
  <container>1..1</container>
  <tenantOrgName>0..1</tenantOrgName>
  <description>0..1</description>
  <userPrincipalName>1..1</userPrincipalName>
  <password>0..1</password>
  <displayName>0..1</displayName>
  <givenName>0..1</givenName>
  <middleName>0..1</middleName>
  <sn>0..1</sn>
  <initials>0..1</initials>
  <externalMailAddress>0..1</externalMailAddress>
  <senderAddress>0..1</senderAddress>
  <mailSubject>0..1</mailSubject>
  <mailMessage>0..1</mailMessage>
  <mailFormat>0..1</mailFormat>
  <messagePriority>0..1</messagePriority>
  <template>0..1</template>
  <propertyList>0..1
	<property name="1..1">0..unbound
	<value>1..1</value>
	</property>
  </propertyList>
  <properties>0..1
	<property name="1..1">0..unbound
	<value>1..1</value>
	</property>
  </properties>
  <smtpServer>0..1</smtpServer>
  <smtpUser>0..1</smtpUser>
  <smtpPass>0..1</smtpPass>
</executeData>

Output

<data>
  <userLDAP>1..1</userLDAP>
  <password>0..1</password>
  <mailStatus>0..1</mailStatus>
</data>

Sample Code

Example XML Request

<request xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <procedure xmlns:xsl='http://www.w3.org/1999/XSL/Transform'>
	<execute namespace="Hosted Signup" procedure="IIWSignup" 
		impersonate="1">
	<executeData>
		<preferredDomainController>ad01.fabrikam.com</preferredDomainController>
		<container>LDAP://OU=MyIIWReseller,OU=Hosting,DC=Fabrikam,DC=Com</container>
		<userPrincipalName>jackhomeha@jackhome.com</userPrincipalName>
		<displayName>Jack Patten</displayName>
		<givenName>Jack</givenName>
		<middleName>J</middleName>
		<sn>Patten</sn>
		<initials>JP</initials>
		<description>IIWTenant</description>
		<properties>
		<property name="street">1703 NE 91st</property>
		</properties>
		<propertyList>
		<property name="##PASSWORD##" value="1" />
		</propertyList>
		<externalMailAddress>testmail@hello.com</externalMailAddress>
		<senderAddress>testmail@hello.com</senderAddress>
		<mailSubject>hello</mailSubject>
		<mailMessage>Hello new body</mailMessage>
		<mailFormat>text</mailFormat>
		<template>\\mpssql\c$\test\template.txt</template>
	</executeData>
	<after source="executeData" destination="data" mode="merge"/>
	</execute>
  </procedure>
</request>

Example XML Response

<response>
  <data>
	<preferredDomainController>ad01.fabrikam.com</preferredDomainController>
	<container>LDAP://OU=MyIIWReseller,OU=Hosting,DC=Fabrikam,DC=Com</container>
	<userPrincipalName>jackhomeha@jackhome.com</userPrincipalName>
	<displayName>Jack Patten</displayName>
	<givenName>Jack</givenName>
	<middleName>J</middleName>
	<sn>Patten</sn>
	<initials>JP</initials>
	<description>IIWTenant</description>
	<properties>
	<property name="street">1703 NE 91st</property>
	</properties>
	<propertyList>
	<property name="##PASSWORD##" value="1"/>
	</propertyList>
	<externalMailAddress>testmail@hello.com</externalMailAddress>
	<senderAddress>testmail@hello.com</senderAddress>
	<mailSubject>hello</mailSubject>
	<mailMessage>Hello new body</mailMessage>
	<mailFormat>text</mailFormat>
	<template>\\mpssql\c$\test\template.txt</template>
	<mailStatus>Your message was sent successfully</mailStatus>
	<userLdap>
	LDAP://CN=jackhomeha@jackhome.com,OU=jackhomeha@jackhome.com,OU=MyIIWReseller,OU=Hosting,DC=fabrikam,DC=com
	</userLdap>
	<password>v0Eb706qr2</password>
  </data>
</response>

Applies To