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

AddUserAsDomainMember

Adds a user to the specified domain/library

Syntax

Visual Basic (declaration) 
Public Function AddUserAsDomainMember( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DomainName as String, _ 
	ByVal UserName as String) as XmlNode

C# (declaration) 
public XmlNode AddUserAsDomainMember( 
	string AuthenticationTicket,
	string DomainName,
	string UserName)

Parameters

AuthenticationTicket
    string inforouter ticket
DomainName
    string The name of the domain you wish to add the user
UserName
    string The user name of the user to be added

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the user has successfully been added to the domain.
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.

- Only Global Users can be added as members to domains.
- Local Users remain local to their original domains. They cannot be made members of other domains.

minus gif Example

Visual Basic Example 
Public Sub AddUserAsDomainMember()
        Const IRAuthenticationTicket As String = "sid-XXXXXXXXXXXX"
        Const IR_DomainName As String = "Accounting"
        Const IR_UserName As String = "JoeD"
 
        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try
 
            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.AddUserAsDomainMember(IRAuthenticationTicket, _
                                                       IR_DomainName, _
                                                       IR_UserName)
 
           If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The user successfully added to the domain members")
            Else
                Console.WriteLine("The User cannot be added to the domain members.")
                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