Import VERA users
VERA Users can be imported via a csv file.
Prerequisites
- Folder location is defined for importing the users
- The csv file contains required information for all users (see below)
The following information is required for each user in order to import them successfully.
- User Name
- Full Name
- IdP
- IdP User Name
The following information is optional and may be omitted from the import file:
| Column Name | Field Format | Warnings |
|---|---|---|
| System Roles | Comma separated list of system roles. | Invalid roles will not be imported. |
| Domain Membership | Domain name, followed by a colon, followed by a comma-separated list of approval roles. Multiple domains should be separated using a semi-colon. *If a user is added to a domain without specifying a valid role, they will be added to the domain as a Domain Viewer. | Invalid domains will not be imported, nor will associated roles. In the case of an invalid role assignment within a valid domain, a role of Domain Viewer will be assigned. |
The groups column has been deprecated in version 2022.3 and will be removed in future versions. During the transition, if a user attempts import with a file that contains a groups column and if a valid System Role assignment is indicated in this column, VERA will import the role(s) and they will be shown in the Current System Roles column in the results file. However, if an approval role is specified in the groups column, the role assignment will fail and the administrative user will be presented with a warning in the import results file.
VERA will also produce a warning in the import results file indicating the groups columns has been deprecated and will instruct the user to use the System Role and Domain Membership columns instead. An example file format is provided below. It is recommended that administrative users revise the import file format as soon as practicable to avoid potential issues.
Example csv format
| User Name | Full Name | System Roles | Domain Membership | IdP | IdP User Name | |
| vera_admin | Default VERA Administrator | vera_admin@tx3services.com | System Administrator | Production: Technical, Reviewer; Quality: Business, Reviewer | Tx3IDP | vera_admin |
| demo_tech | Ada Lovelace | demo_tech@tx3services.com | Production: Domain Administrator; Quality: Reviewer, Technical | Tx3IDP | demo_tech | |
| demo_qa | Quincy Adams | demo_qa@tx3services.com | Tx3IDP | demo_qa | ||
| svc_jira | JIRA Service | svc_jira@tx3services.com | System Service Account | vera | svc_jira:35FDL@flfdgh5 |
Click here to download a sample CSV file
Service Account
The Service Account in VERA (used to connect Jira and VERA) will need to be a local VERA user. All others users can use a configured Identity Provider to authenticate.
Step-by-step guide
Prepare the csv file for the users you would like to import (ensure all required information exists in the file)
- In the VERA Web Portal User Management section, click the Import Users button
- Click the Choose File button and then browse to the prepared csv file.
- Click the Import button.
- If a username does not already exist in VERA, the user and associated attributes will be imported into the database.
- If a username already exists in VERA, the user's attributes will be updated with the new information (i.e. the full name "Steve Jobs" could be updated to "Steven Jobs").
- Updates will not overwrite existing system or domain roles. New roles may be added, but they can not be removed via the import file. For information on how to remove users from roles, see Updating User role membership.
- If there are errors in individual columns during user addition or update, warnings will be displayed to describe the issue(s) and allow the admin to correct the information and update the user information, if needed
- When the user import file is submitted, a message will display that the import has occurred.
- This message does not indicate whether or not the import had errors. To view results, click the View Latest Import Results button.
- NOTE: only csv files can be imported. An error message will display if other file types are attempted.
- Upon successful import, the csv file will be moved to an archive folder so it can be retrieved later (if needed).
- To view results of user import, click the View Latest Import Results button. It will show the users that were imported, the users that were updated, warnings, as well as any import errors.
- If an error occurs due to missing information
- Users will be imported unless otherwise indicated in the results file. Any errors will be displayed and invalid data will not be imported.
- The results file will show a summary of the users added or updated, as well as detailed information regarding any errors or warnings for which the admin may wish to take corrective action.
- if correction are required, the csv file can then be modified to correct the missing information and can be reimported.
Once the users are imported, their assigned System Roles and Domain Memberships can be updated within the VERA Administration portal (see Updating User role membership). For updates to an existing user's attributes such as a name change, email address, etc, a new csv file should be used to correct the information.
Related articles
Table of Contents