Parameter

Required

Description

customerId

Enter the company sname.

userName

X

Enter a name for the user.

The following conditions apply:

• Valid characters include: abcdefghijklmnopqrstuvwxyz0123456789@$_.~'-
• Login names cannot start with apostrophe (') or dash (-)
• Non-breaking white spaces (space, tab, new line) are invalid
• All user-entered usernames are converted to lower case before the validation
• Multi-byte characters are invalid (Multi-byte characters include letters of the alphabet in Asian languages such as Chinese, Japanese, and Korean)
• The following characters are invalid: <> [ ] ( ) ; : \ /

The following is a list of reserved words that are invalid:

     add, all, block, count, down, force, link, mount, off, simple, tag, up

password

Enter a password for the user. The following conditions apply:

• If left blank, the password defaults to username.
• Passwords are case-sensitive.
• All single-byte characters are allowed except backslash (\).
• Non-breaking white spaces (space, tab, new line) are invalid.

Multi-byte characters are invalid (Multi-byte characters include letters of the alphabet in Asian languages such as Chinese, Japanese, and Korean).

manager

Enter an Approval Manager for the user.

The value must match the username of an existing user.

userRole

Optional field.

Specify a user role for the user. Valid values are:

• END_USER
• MANAGER
• ADMIN
• COMPANY_ADMIN

The following conditions apply:

• If a value is not specified, the userRole defaults to END_USER.
• Only one role is allowed for a given user.

groupCode

X

Specify group memberships for the user. To add the user to more than one group, use a comma delimited list. For example:

groupCode1,groupCode2,groupCode3

language

The specified value must be a valid language code.

Currently supported language codes include:

• de - German (All)
• en-gb - English (UK)
• en-us - English (US)
• es - Spanish (All)
• fr - French
• it - Italian (All)
• ja - Japanese
• pl - Polish
• pt-br - Brazilian Portuguese
• ru - Russian
• th - Thai
• zh - Chinese (Mandarin)
• zh-tw - Traditional Chinese

Language codes are case-insensitive.

Note: If this feature is not enabled, entering a value in this field produces an error.

profileFieldValues

Enter values for both core and custom user profile fields.

Core User Profile Fields:

• _sys_firstname
• _sys_lastname
• _sys_emailaddress
• _sys_display_first_name
• _sys_display_last_name
• _sys_location
• _sys_image_url

Note: If First Name or Last Name values are not provided, the value in the username field is used.

Custom User Profile Fields

Custom user profile fields are either defined by administrators or upgraded from an earlier Skillport version.

Custom fields can have the following data types:

• Text - cannot exceed 255 characters
• Integer - 32 bit or less
• Date - format is YYYY-MM-DD
• Boolean - accepts values 0/1, no/yes, true/false
• Single Selection - if validation is On, the field will only accept existing values; if validation is Off, a new field is added to the list
• Multi-Selection - if validation is On, the field will only accept existing values; if validation is Off, new fields are added to the list

Custom fields use XML, and should be formatted as follows:

<profileFieldValues>

     <fieldValue id="{FieldId1}">

         <value>{FieldValue1}</value>

     </fieldValue>

     <fieldValue id="{FieldId2}">

          <value>{FieldValue21}</value>

          <value>{FieldValue22}</value>

     </fieldValue>

</profileFieldValues>

Note: If {fieldValue..} contains special characters, wrap it with "CDATA", such as:

     <value><![CDATA[{FieldValue21}]]></value>.

Example

<profileFieldValues>

     <fieldValue id="_sys_firstname">

          <value>Jeff</value>

     </fieldValue>

     <fieldValue id="address1">

          <value>><![CDATA[500 Canal View Blvd]]></value>

     </fieldValue>

     <fieldValue id="dept_code">

          <value>12345</value>

     </fieldValue>

     <fieldValue id="state">

          <value>NY</value>

          <value>NH</value>

     </fieldValue>

</profileFieldValues>

Fault

Condition (response <faultstring>)

Possible Cause

GeneralFault

Group Code must be specified

The groupCode parameter is missing.

Error: The language selection is not available. Please check your database settings.

The language parameter value is invalid, or the canchangelanguageui SKP parameter is disabled.

Error: Approval Manager selection is not available. Please check your database settings.

The manager parameter is a valid user, but the enableUserManger SKP parameter is disabled.

Error: User Name field is too long. Max 255 characters.

The value in the userName field is too long.

Error: password - The value of the field cannot exceed 255 characters.

The value in the password field is too long.

Error: You must enter a username

The username is missing.

Error: User Role must be 'COMPANY_ADMIN', 'ADMIN', 'MANAGER', or 'END_USER'.

The userRole value is not a valid entry.

Error: testField1 does not exist.

The testField1 value ID was not found, or the value entered is invalid.

Error: Approval manager name is not valid.

The value in the manager field is invalid.

Error: Field1 - The value of the field cannot exceed 255 characters.

The value entered is too long.