infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

CreateUser

Creates an infoRouter user.

Syntax

[Visual Basic]
Public Shared Function CreateUser(ByVal AuthenticationTicket As String, _
                                  ByVal DomainName As String, _
                                  ByVal UserName As String, _
                                  ByVal FirstName As String, _
                                  ByVal LastName As String, _
                                  ByVal EmailAddress As String, _
                                  ByVal Password As String, _
                                  ByVal ReadOnlyUser As Boolean, _
                                  ByVal AuthenticateFromNTLM As Boolean _
                                  ) As System.Xml.XmlDocument

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
DomainName: if the parameter specified, the user will be created as a local user of this domain.
UserName: The User name of the new user. Altough the user is local the Username must be system wide unique.
FirstName: The First name of the User
LastName: The Last name of the User
EmailAddress: The emailaddress name of the User. Email can be an empty string.
Password: The password of the User. This can be an empty string if the user will be Authenticated by NTLM
ReadOnlyUser: Set this parameter true if the user is should be an autheticated user but s/he is a reader infoRouter the interface.
AuthenticateFromNTLM: Set this parameter true if the user will be authenticated by NTLM.

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the user has been created successfully.
if success = "false", the error attribute returns the error description.

Remarks

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

- To create a "Global User", set the DomainName attribute to an empty string.
- Do not specify a password parameter for NTLM authenticated users

Example

Public Sub CreateUser()
 
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxx"
        'Set empty string if the user will be a global user.
 
        Const IR_DomainName As String = "Public"         
        Const IR_UserName As String = "JaneC"
        Const IR_FirstName As String = "Jane"
        Const IR_LastName As String = "Crane"
        Const IR_EmailAddress As String = "JaneC@acme.com"
        Const IR_Password As String = "jane123"
        Const IR_ReadOnlyUser As Boolean = False
        Const NTLMAuthentication As Boolean = False
 
        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
  
        Try
 
            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.CreateUser(IRAuthenticationTicket, _
                                            IR_DomainName, _
                                            IR_UserName, _
                                            IR_FirstName, _
                                            IR_LastName, _
                                            IR_EmailAddress, _
                                            IR_Password, _
                                            IR_ReadOnlyUser, _
                                            NTLMAuthentication)
 
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The user '" & IR_UserName & "' has been successfully created.")
            Else
                Console.WriteLine("'" & IR_UserName & "' cannot be created.")
                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