SQL Admin Provider::RemoveUserFromRole
The RemoveUserFromRole method allows you to remove a user from a SQL role.
Arguments
| Input argument | Required | Description |
|---|---|---|
Name |
Yes |
The security account being removed from the role. The value of security_account is SYSNAME, with no default. The security_account can be any valid SQL Server user, SQL Server role, or any Windows NT user or group granted access to the current database. When removing Windows NT users or groups, specify the name that the Windows NT user or group is known by in the database (added using GrantLogin). |
Role |
Yes |
The role from which the user should be removed. This role must exist prior to executing this method. |
Database |
Yes |
The database containing the role for the user to be removed from. |
ServerName |
Yes |
A string representing the name of the server. This can be a NetBIOS name, a FQDN, or an IP address. It is vital that the server upon which MPS is running be able to resolve server names using whichever naming convention you employ. |
[sqlUserName] |
No |
The user name for connecting to the SQL server via SQL Authentication. If this node is present the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the <sqlUserPass/> node exist. |
[sqlUserPass] |
No |
The password for connecting to the SQL server via SQL Authentication using the username indicated by <sqlUserName/>. If the <sqlUserName/> node is not present, this node is ignored. |
Remarks
Rollback Calls
The RemoveUserFromRole method has no transaction rollback support.
Sample Code
Example XML Request
The following is an example of an XML request for the RemoveUserFromRole method:
<?xml version="1.0" encoding="iso-8859-1" ?>
<request>
<data>
<name>SampleSQL01_User</name>
<role>db_Owner</role>
<database>SampleSQL01</ database >
<serverName>SQL01</serverName>
<sqlUserName>sampleUser</sqlUserName>
<sqlUserPass>Pass1Word</sqlUserPass>
</data>
<procedure>
<execute namespace="SQL Admin Provider"
procedure="RemoveUserFromRole">
<before source="data" destination="executeData" mode="merge"/>
</execute>
</procedure>
</request>
Example XML Response
The following is an example of the structure of an XML response for the RemoveUserFromRole method. The actual returned data will be filled in within the <data> nodes:
<?xml version="1.0" encoding="iso-8859-1" ?>
<response>
<data></data>
</response>
Applies To
for:
Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0
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