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

CreateUser

Creates an infoRouter user.

Syntax

Visual Basic (declaration) 
Public 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 bool, _ 
	ByVal AuthenticationSource as String) as XmlNode

C# (declaration) 
public XmlNode CreateUser( 
	string AuthenticationTicket,
	string DomainName,
	string UserName,
	string FirstName,
	string LastName,
	string EmailAddress,
	string Password,
	bool ReadOnlyUser,
	string AuthenticationSource)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainName
    string if the parameter specified, the user will be created as a local user of this domain.
UserName
    string The User name of the new user. Altough the user is local the Username must be system wide unique.
FirstName
    string The First name of the User
LastName
    string The Last name of the User
EmailAddress
    string The emailaddress name of the User. Email can be an empty string.
Password
    string The password of the User. This can be an empty string if the user will be Authenticated by other than infoRouter
ReadOnlyUser
    bool Set this parameter true if the user is should be an autheticated user but s/he is a reader.
AuthenticationSource
    string if the user is autheticated by infoRouter the value must be 'INFOROUTER'. Elseif the value must be the authentication sources specified in web.config

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 NON-InfoRouter authenticated users

minus gif Example

Visual Basic 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 AuthenticationSource As String="INFOROUTER"
 
        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, _
                                            AuthenticationSource)
 
            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

See Also