Windows-based Hosting::RemoveUserFromSharePointSiteRole

  • Article

The RemoveUserFromSharePointSiteRole procedure deletes a user from a Windows SharePoint site role.

Arguments

The RemoveUserFromSharePointSiteRole procedure requires the following input parameters.

Input Argument Description

<org>

The Lightweight Directory Access Protocol (LDAP) path of the organization that will own the Web site.

<siteName>

The site name which is unique within the organization and stored in the pointer. You can also use the <target> node described below.

<target>

The SharePoint site containing the role that the group is to be removed from.

<roleName>

A string that contains the name of the site group.

<users>/<user>

The data for each user, which contains:

  • <userPrincipalName> - Gets the user name (DOMAIN\User_Alias) of the user.

  • <preferredDomainController> - The name of the preferred domain controller.

Output Arguments

The RemoveUserFromSharePointSiteRole procedure has no return values.

Remarks

Security

The RemoveUserFromSharePointSiteRole procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

Process Steps

The following step occurs when removing a user from a Windows SharePoint site role with the RemoveUserFromSharePointSiteRole procedure of the Managed Windows-based Hosting Namespace:

  • Remove the user from the site group by calling Managed Windows SharePoint::RemoveUsersFromRole.

Sample Code

Example XML Request

The following is an example of an XML request for the RemoveUserFromSharePointSiteRole procedure of the Managed Windows-based Hosting Namespace:

<request> 
        <procedure> 
                <execute namespace="Windows-based Hosting"  
                procedure="RemoveUsersFromSharepointSiteRole" impersonate="1"> 
                        <executeData> 
                        <org>LDAP://ou=alpineskihouse,ou=consolidatedmessenger, 
                        ou=hosting,dc=fabrikam,dc=com</org> 
                        <preferredDomainController>AD01-wh.fabrikam.com 
                        </preferredDomainController> 
                        <target>https://www.example6.com</target> 
                        <roleName>Reader</roleName> 
                        <users> 
                                <user> 
                                <userPrincipalName>WSS12@alpineskihouse.com 
                                </userPrincipalName> 
                                </user> 
                        </users> 
                        <SiteName>example6</SiteName> 
                        </executeData> 
                </execute> 
        </procedure> 
</request>

Applies To

Managed Windows-based Hosting Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Windows-based Hosting::CreateCustomerSharePointSite
Windows-based Hosting::DeleteCustomerSharePointSite
Windows-based Hosting::AddUserToSharePointSiteRole