Hosted Office Communications Server::DisableSipUser
This procedure disables a user to access to Office Communications Server serivce.
Use this procedure to temporarily disable a user's access to the Office Communications Server service. This should not however stop the user from interacting with other service systems. This is effectively a wrapper on the SetSipUserProperties function, setting the "enabled" property to false.
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 Office Communications Server::SetUserSipProperties, which performs a check for Customer Administrator (UserCreators).
Preconditions
The user is subscribed to the Hosted Office Communications Server service user plan.
Business Rules
None.
Post-conditions
The user will be disabled for Office Communications Server services.
Sequence Narrative
Actor submits DisableSipUser request to the Hosted Office Communications Server namespace.
DisableSipUser calls GetUserPlanAssignment. This validates that the user is enabled for the service.
DisableSipUser calls Managed Office Communications Server::SetSipUserProperties to set property "enabled" to false.
Sample Code
Example XML Request
<request>
<data>
<!--LDAP path of the user-->
<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="DisableSipUser" 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