HostedActiveDirectory::GetTenantRoot

  • Article

This procedure returns the DN of the Tenant object when supplied a path to an Active Directory object. In the case of a Business User, root would be the DN of the Business Tenant or Organization. In the case of a IIW Tenant user, root would be the DN of the IIW Tenant OU.

This procedure allows for easy abstraction of the Tenant OU from the IIW user. In that a UI or higher level namespace can easily identify and act against the IIW Tenant supplied only the path of an IIW user object.

This call is a pass through to Managed Active Directory::GetThisOrganizationRoot procedure wrapped in a Try/Catch

Arguments

Input Schema

Input Arguments Required Description

<path>

Yes

The Lightweight Directory Access Protocol (LDAP) path for the object being queried

<preferredDomainController>

Yes

The name of the preferred Domain Controller

Output Schema

Output Arguments Description

<root>

The DN of the owning organization or tenant.

Remarks

Security

Delegation is handled through Active Directory ACL'ing no explicit tests required.

Error Handling

Error Condition Error Text

Managed Active Directory::GetThisOrganizationRoot failed

Unable to find users tenant (owning) organization.

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="GetTenantRoot"  
        impersonate="1"> 
      <executeData> 
        <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
        <path>LDAP://CN=jackhome@jackhome.com,OU=jackhome@jackhome.com,OU=MyIIWReseller,OU=Hosting,DC=Fabrikam,DC=Com</path> 
      </executeData> 
      <after source="executeData" destination="data" mode="merge"/> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
    <path> 
      LDAP://CN=jackhome@jackhome.com,OU=jackhome@jackhome.com,OU=MyIIWReseller,OU=Hosting,DC=Fabrikam,DC=Com 
    </path> 
    <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
    <path> 
      LDAP://CN=jackhome@jackhome.com,OU=jackhome@jackhome.com,OU=MyIIWReseller,OU=Hosting,DC=Fabrikam,DC=Com 
    </path> 
    <root> 
      LDAP://OU=jackhome@jackhome.com,OU=MyIIWReseller,OU=Hosting,DC=fabrikam,DC=com 
    </root> 
  </data> 
</response>

Applies To

Hosted Active Directory Namespace API for:

  • Hosted Messaging and Collaboration version 4.5