Importing users

User lists may be imported into Apporto to create, update, or deprovision users.

Use the information in this guide to learn how to:

• Import users from a file
  • Prepare the import file
  • Manually import users
  • Set up automated imports
• Import users via single sign-on (SSO) integration

Import users from a file

Prepare the import file

Import files must be in a comma-separated values (CSV) format.

The table below shows the values that are available for import.

Field	Datatype	Required?	Notes
Email	String	Yes	User’s email must be unique in the system or an error will result during the import for that user.
First name	String	No
Last name	String	No
Password	String	No	User’s initial password in plain text format
Status	Boolean	No	Active Inactive (default value if not specified)
Role	Lookup value	No	Admin User (default value if not specified)
Groups	Lookup value(s)	No	Each group must first be created in Apporto before it can be imported. See the articles on creating and managing groups for more information. If a user is a member of more than one group, include all relevant groups in the same column with commas but no spaces between each value. Multi-word group names are acceptable. Examples: Group1,Group2,Group3 Math 101,Computer Science,Java Group Finance,Marketing,IT

Manually import users

The manual user import feature is available for use at any time.

Follow the steps below to manually import users.

1. Log in to the system using your credentials.
2. Click users or the  icon in the navigation panel to view the Users list screen.
3. Click import users to trigger the import wizard.
   
4. Select a CSV file by dragging it onto the import box or clicking to trigger the file manager. The name of the selected file will display on the screen.
5. Click next to move on to step 2 of the import process.
   
6. The values in the first row of your file will appear in the “CSV column” section of the field match table. For each row, select the corresponding Apporto field from the “user fields” dropdown. If there is no matching value for the row, leave the dropdown blank.
7. Click on the options header to expand the next section.
   
   1. Check “ignore first line” if the first row of your CSV file contains header names.
   2. Check “send welcome email” if you wish to send a welcome email with a single-use login link to all users in the CSV file.
8. Click on the attribute handling header to expand the next section.
   
9. Select what should happen to existing users who are present in the CSV file:
   1. No update – The user will be skipped in the import process.
   2. Replace data – The user will have any values other than email address updated. This includes roles (other than Apporto admins) and groups.
   3. Add data – The user’s existing data will remain unchanged, but the system will fill any null/blank values with CSV data. It will also append any new group assignments.
10. Click on the assign groups header to expand the last section.
    
    1. Any group that is selected at this step will be applied to all users in the CSV file.
11. Click upload to complete the import.
12. The system will provide the status of the import via the notifications tray.
    

Set up automated imports

Users may be automatically imported by placing the CSV file on an SFTP site. Contact [email protected] if you would like to set up an automated import.

Import users via single sign-on (SSO) integration

The CSV import feature is typically used to create or update a small batch of users (up to 500). Single sign-on (SSO) integration is preferred for larger numbers of users. With an SSO integration, user accounts are automatically created when users log in and launch Apporto. Contact [email protected] if you would like to set up an SSO integration.