Hosteded Active Directory::CreateIIWTenant

  • Article

This procedure creates an IIW (Individual Information Worker) Tenant Organization and Admin user.

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="city1"> 
<value>Some City</value> 
</property> 
<property name="city2"> 
<value>Washington</value> 
</property> 
</properties>

Remarks

Security

OrgCreators effective permissions.

Error Handling

Schema Definition

Input

<executeData> 
        <preferredDomainController>1..1</preferredDomainController> 
        <container>1..1</container> 
        <userPrincipalName>1..1</userPrincipalName> 
        <displayName>1..1</displayName> 
        <tenantOrgName>0..1</tenantOrgName> 
        <givenName>0..1</givenName> 
        <middleName>0..1</middleName> 
        <sn>0..1</sn> 
        <initials>0..1</initials> 
        <password>1..1</password> 
        <description>0..1</description> 
        <properties>0..1 
                <property name="1..1">0..unbound 
                        <value>1..1</value> 
                </property> 
        </properties> 
</executeData>

Output

A successful response will mirror the input data.

Sample Code

Example XML Request

<request xmlns:xsl="https://www.w3.org/1999/XSL/Transform"> 
  <procedure xmlns:xsl='https://www.w3.org/1999/XSL/Transform'> 
    <execute namespace="Hosted Active Directory" procedure="CreateIIWTenant"  
        impersonate="1"> 
      <executeData> 
        <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
        <container>LDAP://OU=MyIIWReseller,OU=Hosting,DC=Fabrikam,DC=Com</container> 
        <userPrincipalName>jackhome@jackhome.com</userPrincipalName> 
        <displayName>Jack Patten</displayName> 
        <givenName>Jack</givenName> 
        <middleName>J</middleName> 
        <sn>Patten</sn> 
        <initials>JP</initials> 
        <password>Pass1Word</password> 
        <properties> 
          <property name="street"> 
            <value>1703 NE 91st</value> 
          </property> 
          <property name="telephoneNumber"> 
            <value>111-222-333</value> 
          </property> 
        </properties> 
      </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>jackhome@jackhome.com</userPrincipalName> 
    <displayName>Jack Patten</displayName> 
    <givenName>Jack</givenName> 
    <middleName>J</middleName> 
    <sn>Patten</sn> 
    <initials>JP</initials> 
    <password>Pass1Word</password> 
    <properties> 
      <property name="street"> 
        <value>1703 NE 91st</value> 
      </property> 
      <property name="telephoneNumber"> 
        <value>111-222-333</value> 
      </property> 
    </properties> 
  </data> 
</response>

Applies To

Managed Active Directory Namespace APIManaged Active Directory Namespace API for:

  • Hosted Messaging and Collaboration version 4.5