Organization Setup>Determining Registration Method
There are several data requirements to import new user data or update existing user data using Knowledge Anywhere's CSV template or the Knowledge Anywhere Public API. For example:
- All users require the following three fields:
- First Name
- Last Name
- Any column headers of customized fields that were previously created will be overwritten by the column headers of the imported CSV template.
Note: You can download the CSV template from Users>Import Users in the Administrative Dashboard, as shown below: - Users imported via our Knowledge Anywhere Public API have similar data validation requirements, as summarized in the table below:
| 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. |
| Active |
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. Read Can I translate the LMS into other languages? to learn more about the languages supported in Knowledge Anywhere's LMS. 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. |
| State | Example: WA
The 2 or 3 letter state/province abbreviation for the user. |
| Country | example: US
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. |
| Custom Fields |
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. |
| Site Name |
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: piper@knowledgeanywhere.com
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. |
| External ID |
example: piper@knowledgeanywhere.com 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. |
Comments
0 comments
Please sign in to leave a comment.