When importing new users or updating existing users via CSV file, there are several data requirements you should be aware of when importing user data into your LMS.
First, all users require these three fields to be present:
- First Name
- Last Name
Any custom user fields which have been previously created will auto-populate in the column headers of the downloaded CSV template, which can be found under the Users tab on the admin site.
Users are imported via our Knowledge Anywhere Public API and therefor has similar data validation requirements. Below is a summary of important data requirements:
|Password||Plain text password (optional). There is a minimum length requirement of 6 characters. If you create a user without a password, then they will be required to set a password upon login.|
TRUE / FALSE
If no value is present, defaults to TRUE and makes/keeps the user active.
|Send Initial Email||
TRUE / FALSE
Sends email to user upon account creation and provides more information for logging into the system. You can find and customize the email template under Site > Notifications > API User Registration No Password / With Password.
If no value is present, defaults to TRUE and will send an email to all users listed on the import.
|Force Password Change||
TRUE / FALSE
Requires user to change their password after initial login. This can be helpful if a default password is set upon creation.
If no value is present, defaults to TRUE, and will force the learner to set a unique password upon their first login.
|Locale||example: en-us, es-es, fr-fr
The 4-6 letter language code, see supported language codes.
Defaults to en-us. If a invalid locale is passed in, the user will be created/updated, but will return a warning.
|Registration Code||Example: wewillrockyou
If your system uses registration codes for users to self register, use this field to assign that code to the user. The value passed in must match a value in Users > Registration Codes. If no match is found the request will result in a 400 bad request and the user will not be created/updated.
The 2 or 3 letter state/province abbreviation for the user.
The 2 or 3 letter ISO country code country for the user. See https://www.iso.org/iso-3166-country-codes.html for the list of valid country codes. Defaults to US. If a invalid country is specified, the operation will continue, but a warning will be thrown.
Name: If you have custom fields enabled, you will need to update the name of the field exactly as it is in the system.
Values: The value can be a single value or a comma separated string. If the property is not matched to an existing value, it will be created.
Only for available for Professional and Enterprise customers who have Extended Enterprise enabled. Allows you to select which site user belongs to and must match site name exactly as listed under Site > Personalization.
If no value is present, defaults to Main Site.
|SSO ID||example: firstname.lastname@example.org
Unique identifier utilized by the Single Sign-On system integration used to uniquely identify this user for sign-on. If you would like your users to be able to SSO, include this value.
Unique identifier for the user and can be used in Public API calls.
Defaults to user's email address. Once the external id is changed to something other than email, the external id cannot be changed at a later date.