Overview

The CSV Import feature provides pre-made templates for the most commonly used import options. This topic provides a sample of a CSV file for importing users, and information on each entity in the corresponding template.

Sample CSV file format for importing users:

user_username,user_name,user_password,user_email,user_language,user_active,user_role,user_organizationId,user_externalId,user_metadata_<KEY>
user1,User Name,Password1!,test@email.com,en-US,TRUE,CONTENT_CREATOR|GROUP_CREATOR,root,{"google": "user-id"},{metadata_value}
user2,User Name 2,Password1!,test2@email.com,en-US,TRUE,ADMIN,root,{"google": "user-id"},{metadata_value}

The top line or row designates the entities for which you will enter values according to each user.

Entities

Mandatory

• user_username

  • The username used to identify the user on TAO Portal.

  • Entering a value for this field is mandatory when creating or updating a user, but cannot be changed after creation.

• user_password

  • The username’s password used to identify on TAO Portal. A password needs to be 8 characters long with at least one upper case, one lower case, and a special character.

  • This field is mandatory when creating a user.

• user_organizationId

  • The organizational unit (inside the hierarchy) where the user is assigned.

  • The value in this field must refer to the ID of an existing organization unit in the hierarchy (or the root).

  • This field is only valid if Organization (hierarchies) is enabled.

  • If enabled, this field is mandatory.

Available 

• user_email

  • An email assigned to a user.

• user_name

  • A name assigned to a user.

• user_active

  • To create an enabled (active), disabled (inactive) user. Inactive users cannot login.

  • If left empty, the default value is Active (TRUE). Add FALSE to flag the group as inactive.

  • If the numeric values 1 and 0 are used, they are automatically converted to true and false and will send a warning to the logfile.

• user_role

  • List each role you want to assign to a user in the selection field, with each role separated by a pipe | with no spaces (see sample CSV file):

    • ADMIN

    • GROUP_CREATOR

    • CONTENT_CREATOR

    • OFFLINE_UPLOADER

    • ONLINE_UPLOADER

    • DASHBOARD_VIEWER

  • No default value. If empty then the user is imported without role.

• user_language

  • From the list of available locales:

    • en-US – English (USA)

    • no-NO – Norwegian

    • de-DE – German

    • pt-BR – Portuguese (Brasil)

    • es-ES – Spanish

    • lt-LT – Lithuanian

    • it-IT – Italian

    • nl-NL – Dutch

    • pt-PT – Portuguese (Portugal)

    • ro-RO – Romanian

    • he-IL – Hebrew

    • fr-FR – French

    • ja-JP – Japanese

  • No default value.

• user_externalId

  • This ID is used for single sign-on (SSO) with an external ID provider.

  • When you enter a value for this entity, the changes are applied to any TAO environment but have no impact on the environment without SSO configured.

• user_metadata_<KEY>

  • This is an experimental feature that allows admins to flag users and groups with metadata tags. <KEY> represents the metadata key. In the selection field, use enter the metadata value. For information on enabling additional features, see Customizing an account in the TAO Portal.

Updating a user

1. To update a user, you need to enter the mandatory entity values (username and password). All other values can be updated. If you want to keep the existing password, you can provide the username only and remove the column for password.
2. If a value in a column is left blank, the corresponding value is removed (if it is not mandatory, otherwise it will trigger an error).
3. If a value in a column has a new value, it will replace the previous value.
4. If the column is removed, the existing value will be kept.