Share via

Managed Office Communications Server::ValidateSipDomainOwnership

  • Article

This procedure validates that a SIP domain is own by an organization or its parent.

Arguments

Input argument Required Type Description

<organization>

Yes

xs:string

The Lightweight Directory Access Protocol (LDAP) path of the user.

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions.

<address>

Yes

xs:string

The fully qualified domain name (FQDN) of a domain handled by the Office Communications Server. The value must be the FQDN. An IP address is not allowed.
Output argument Type Description

<owner>

xs:string

The actual owner of the domain as:

  • Tenant - The organization has direct ownership of the domain.

  • Parent - The parent of the organization owns the domain.

If neither is true, an error will be thrown.

Remarks

Security

The caller must be at least a member of role: Customer Administrator

Permission Check

This procedure will perform a test for Customer Administrator (UserCreators).

Preconditions

The specified domain was owned by the organization or its parent.

Business Rules

The domain must be owned by the organization or its parent. If either is true, an error will be thrown.

Sequence Narrative

  1. Actor submits ValidateSipDomainOwnership request to the Managed Office Communications Server namespace.

  2. The Managed Office Communications Server namespace calls private procedure IsSipDomainOwnedBy_ to check whether the SIP domain is owned by the organization. If that is true, set "owner" to "Tenant".

  3. If the domain is not owned by the organization, the Managed Office Communications Server namespace calls GetOwningOrg_ to retrieve the organization's parent.

  4. The Managed Office Communications Server namespace calls private procedure IsSipDomainOwnedBy_ to check whether the SIP domain is owned by the organization's parent. If that is true, set "owner" to "Parent".

  5. If either is true, throw an InvalidOperationException (0x80131509) using Error Provider::SetError.

Exceptions

HResult Message Conditions

0x80131509

The specified SIP domain '%1' does not belong to either '%2' or its parent '%3'.

Note: %1 should be the domain value.

Note: %2 should be the LDAP path of the organization.

Note: %3 should be the LDAP path of the organization's parent.

SIP Domain does not belong to either the organization or its parent.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The preferred domain controller for Active Directory operations.--> 
    <preferredDomainController>AD01.Fabrikam.com</preferredDomainController> 
    <!--The LDAP path of the organization--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--The fully qualified domain name (FQDN) of a domain handled by the Office Communications Server. The value must be the FQDN. An IP address is not allowed.--> 
    <address>AlpineSkiHouse.com</address> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="ValidateSipDomainOwnership" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="address" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--The actual owner of the domain. It could be 'Tenant' if the organization has direct ownership of the domain, or 'Parent' if the parent of the organization owns the domain. If neither is true, an error will be thrown.--> 
    <owner>Tenant</owner> 
  </data> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5