CSV Import File Guidelines

You can automate adding users by creating a comma-separated values (CSV) file with user information and then importing the file. You can include attributes in the CSV file, such as licence level and the publishing access, to apply to the users at the same time you import them.

To import users, you can use the site administration page or the tabcmd utility. Using tabcmd provides an option for assigning a site role to all users in the CSV file. For information, see Import Users or createsiteusers filename.csv.

CSV file format requirements

When you create the CSV file for importing users, make sure that the file meets the following formatting requirements:

The file does not include column headings. Tableau Cloud assumes that every line in the file represents a user.
The file is in UTF-8 format, and includes the byte-order mark (BOM).
Character encodings such as BIG-5 have been converted to UTF-8. You can do this by opening the file in a text editor and using the Save As command.
If a username includes an @ character that represents anything other than a domain separator, you need to refer to the symbol using the hexadecimal format: \0x40
For example, user@fremont@mycompany.com should be user\0x40fremont@mycompany.com

Required columns in the CSV file

The following fields are required for each user:

Username: The user’s email address.
Password. Tableau Cloud does not use this field, but you need to delimit it in each row to position the subsequent fields correctly.

Additional CSV column options

For each user, the CSV file can contain the following fields in addition to the required columns. Where indicated, Tableau Cloud does not use the field, but it must be accounted for in the file.

Site URI (Tableau Cloud Manager only): The uniform resource identifier for the site. To import a user as a cloud administrator, include the Site URI column but leave it blank.
Display name. Tableau Cloud does not use this field, but you need to delimit it in each row to position the subsequent fields correctly.
Licence level. This can be Creator, Explorer, Viewer or Unlicensed.
Administrator level: The value can be Cloud, Site or None. Cloud = Cloud administrator, Site = Site administrator and None = Not an administrator.
Note: The cloud administrator value is only available when importing users to Tableau Cloud Manager. It isn’t intended for use with Tableau Cloud sites. For more information, see Manage Users With Tableau Cloud Manager.
Publishing capability. Acceptable values are Yes/True/1 or No/False/0. If the licence level is Creator, the publishing capability must be Yes/True/1.
Authentication type (Tableau Cloud Manager only): The user authentication type for accessing a site or Tableau Cloud Manager.

CSV file sample entries

Tableau Cloud site

The following example shows a user who will be granted the Explorer site role, will not be a site administrator, and will be able to publish to projects on which they have the appropriate content permissions.

user1@domain.com,,,Explorer,None,true

By changing the administrator-level column, you can import the following user as a site administrator with the Site Administrator Explorer site role.

adminuser@domain.com,,,Explorer,Site,true

Tableau Cloud Manager

The following example shows a user who is granted the cloud administrator role in Tableau Cloud Manager, and authenticates using Tableau with MFA.

,cloudadminuser@domain.com,,,,Cloud,,Tableau with MFA

By changing the authentication column, you can import the following user with an alternative authentication type if configured in the Tableau Cloud Manager settings.

,cloudadminuser@domain.com,,,,Cloud,,Salesforce

Notes

If the CSV file contains only username values (email addresses), the users will receive an email invitation to the site. Users can join the site to create their accounts, but the accounts remain unlicensed until an administrator configures the accounts (display name, licence level, and so on).
The password (second value) and display name (third value) fields are not used by Tableau Cloud. Values you do specify for those fields are ignored.
However, if you want to set the licence and publish access for the users, your file still needs to include delimiters for these fields, as shown in the example earlier.
New users must select a password and a display name when they first sign in to Tableau Cloud. If users already have a Tableau account, such as for the Tableau Community forums, they already have passwords.
The CSV file does not include a field for setting authentication type (Tableau, Google, or SAML). You specify this inTableau Cloud when you import the file. The setting applies to all imported users, and you can change authentication type for individual users afterward.
Note: Alternatively, you can use tabcmd to import users and set the authentication type and site role that applies to all users in the CSV file. For information, see createsiteusers filename.csv.

CSV settings and site roles

The licence level, administrator, and publishing settings for a user determine how the user's site role is set during the import process. The following table shows how the settings are converted to site roles.

CSV settings	Site role
Licence level=Unlicensed Administrator=Cloud Publisher=false	Cloud Administrator. This setting is valid only if you are importing users while signed in to Tableau Cloud Manager (that is, not signed in to a specific site).
Licence level=Creator or Explorer Administrator=Site Publisher=true	Site Administrator Creator or Site Administrator Explorer. This setting is valid only if you are importing users while signed in to a specific site.
Licence level=Creator Administrator=None Publisher=true	Creator
Licence level=Explorer Administrator=None Publisher=true	Explorer (Can Publish)
Licence level=Explorer Administrator=None Publisher=false	Explorer
Licence level=Viewer Administrator=None Publisher=false	Viewer
Licence level=Unlicensed Administrator=None Publisher=false	Unlicensed

Thanks for your feedback!

Your feedback has been successfully submitted. Thank you!

Tableau Cloud Help