Hosted Office Communications Server::DeleteSipUser

  • Article

This procedure deletes a SIP account from an Active Directory User.

Use this procedure to remove SIP settings from an existing Active Directory user.

Arguments

Input argument Required Type Description

<user>

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.

Remarks

Security

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

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::RemovePlanFromCustomer which performs a check for Customer Administrator (UserCreators).

Preconditions

The user was previously created with Hosted Office Communications Server::CreateSipUser.

Business Rules

None.

Post-conditions

  • The user will be deleted from Office Communications Server.

  • The OCSUserPlan will no longer be assigned to the user.

Sequence Narrative

  1. Actor submits DeleteSipUser request to the Hosted Office Communications Server namespace.

  2. DeleteSipUser calls GetUserPlanAssignment. This will retrieve the plan name and validated that the user was previously enabled by this namespace.

  3. DeleteSipUser calls Managed Plans::RemovePlanFromCustomer.

  4. DeleteSipUser calls Managed Office Communications Server::DeleteSipUser.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The LDAP path of the customer organization in the Service Provider domain.--> 
    <user>LDAP://CN=JohnC@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</user> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="DeleteSipUser" impersonate="1"> 
      <before source="data" sourcePath="user" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
        <data /> 
</response>

Applies To

Hosted Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Hosted Office Communications Server::CreateSipUser