1. Home / Web Services API Version 8.x / RemoveUserGroupFromDomainMembership

RemoveUserGroupFromDomainMembership

Removes the specified user group from the specified domain/library.

Syntax

Visual Basic (declaration) 
Public Function RemoveUserGroupFromDomainMembership( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DomainName as String, _ 
	ByVal GroupName as String) as XmlNode

C# (declaration) 
public XmlNode RemoveUserGroupFromDomainMembership( 
	string AuthenticationTicket,
	string DomainName,
	string GroupName)

Parameters

AuthenticationTicket
    string inforouter ticket
DomainName
    string The Name of the domain that the usergroup to be removed
GroupName
    string The Name of the usergroup be removed

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the usergroup has been removed from domain membership.
if success = "false", the error attribute returns the error description.

Remarks

The caller must be the system administrator or the domain manager of the specified domain.

minus gif Example

Visual Basic Example 
Public Sub RemoveUserGroupFromDomainMembership()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxx"
        Const IR_DomainName As String = "Accounting"
        Const IR_UserGroupName As String = "Employees"

        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try

            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.RemoveUserGroupFromDomainMembership( _
                                                           IRAuthenticationTicket, _
                                                           IR_DomainName, _
                                                           IR_UserGroupName)
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The user group removed from the domain memberships")
            Else
                Console.WriteLine("The User group cannot be removed from the domain memberships.")
                Console.WriteLine("server response:" & xmlResponse.GetAttribute("error"))
            End If
            xmlResponse = Nothing

        Catch ex As Exception
            Console.WriteLine("error:" & ex.Message)
        Finally
            IR_Obj = Nothing
        End Try
    End Sub

See Also