Users Import

Two options are available, to import new users and to update existing user's roles.

Users may be imported by uploading a CSV containing appropriate details. The following columns are available:

• Email - the user's identity that will be used to check if they already exists
• UserId - will be made unique if there is a clash - will be ignored if the user already exists in another account
• Role - optional list of roles for the user - defaults to “User”
• Name - optional, if metadata is being held
• Telephone - optional, if metadata is being held
• Login - optional, if metadata is being held - if appropriate to the Authentication Method
• SendInvitation - if appropriate to the Authentication Method, set to “true” to have an invitation email sent when the user is created
• fSeriesAPIUser - optional, set to true if user has external access to APIs (password may not be imported)

The format of the downloaded user CSV is the same as the format for imports.

To make mass changes to users' roles, upload a CSV with the following columns:

• UserId - the user's id in the database (use the download user CSV to confirm user ids)
• Role - a comma separated list of roles
• Action
  • '=' to set the user's roles to those in the list
  • '+' to add the list of roles to the users' existing roles
  • '-' to remove the list of roles from the users' existing roles

Different actions may be mixed in the same upload file. A user may appear more than once in the file, for example to add roles and remove roles in the same run.

For both operations, if there are errors the import/update is completed for u=items with no errors, but a CSV is downloaded to your browser that is a copy of the uploaded file but with a column added called 'Errors' which identifies line not executed and why. You can edit this file and reload directly.