Create User

Support for SOAP is deprecated starting with Unifier 23.10.

Description

This public method will allow users to create one or more company users.

Support

Installation: ASP and Self host

Level Yes or No
Company Level Yes
Project/Shell Level No

Prototype

public XMLObject createUser(String shortname, String authcode, String copyFromUserPreferenceTemplate, String userXML);

Parameters

Parameter Description
Shortname Identifier of the company, company's short name
Authcode Authentication key for the company, in text string
copyFromUserPreferenceTemplate Name of the template from which user preference should be copied over when new user is created
userXML
  • If the User Attributes form is defined, it should be based on the integration interface definition of the User Attributes form in uDesigner.
  • If the User Attributes form is not defined, the element of userXML will be from the table in the following "userXML Elements" section, below.

userXML Elements (When User Attributes Form is not Defined)

Tag Name Required Description Valid values
<username> Yes User name that is going to be used by user to sign in to Unifier.  
<password> Yes User's password  
<firstname> No First name of the user  
<lastname> No Last name of the user  
<title> No Title information  
<email> No Email of the user  
<workphone> No Work phone number of the user  
<homephone> No Home phone number of the user  
<fax> No Fax number of the user  
<cellphone> No Cell phone number of the user  
<pager> No Pager number of the user  
<status> No

Status of the newly created user

(Active, Inactive, On-Hold)

Active: 1

Inactive: 0

On-Hold: 2
<timezone> No Time zone of the user See Time Zone. You must send the data from value column, for example, for time zone GMT -11:00, Samoa Standard Time (Samoa) send 10.
<dateformat> No User preference date format See Date Format. You must send the data from value column, for example for MM/DD/YYYY AM send 0 (zero).HH:mm
<usertype> No Defines the user type, based on license terms.

0 for Standard User

1 for Portal User

Return Value

See Appendix B: Return Values.

Sample Method

createUser("acme", "acme_authcode", "User Pref Temp 1", "<user information>")

Additional Information

If the user preference template is provided, the user preference will be set based on the user preference template on the newly created company user.

'_user' will be the base tag which can be repeated with the data to create multiple company users.

The Web Services call for user administration includes an XML tag to support the Proxy login setup. The Data Element (DE) for the XML tag is: " uuu_user_proxy_config."

This is not a required field, so the default value remains unchecked.

Users can be created using the CreateObject WS method, and the XML tag is: " allowproxy."

To map the values for checkbox:

  • If uuu_user_proxy_config or allowproxy is set to Yes, the “Do not allow Proxies” checkbox in the Proxy tab should be deselected.
  • If uuu_user_proxy_config or allowproxy is set to No, the “Do not allow Proxies” checkbox in the Proxy tab should be selected.