User data CSV file upload requirements
You can use a downloadable SecureAuth CSV template that includes all of the available fields as shown next.
The CSV file will not overwrite any existing user identities in the identity store. If there is a duplicate user identity in the CSV file, it treats this an invalid row, and continues to accept valid rows. It shows an error dialog for invalid data.
At minimum, the CSV file of user identities must have a userName, password, and one email like the following:
- userName
Unique identifier for the user identity. For example,
jsmith
.- password
Password for the user identity in plain text.
Note
During the CSV file upload, the
password
field in plain text will be encrypted in the Identity Store. As a security measure, thepassword
field is not exportable from the Identity Store in the CSV file export.- emails[0].value, emails[0].type, emails[0].primary
Email address associated with the user identity. For example,
jsmith@acme.com,work,TRUE
If the user has more than one email address, indicate which email address is the primary one by giving it the value
TRUE
.
Example CSV file format with minimum fields
userName,password,emails[0].value,emails[0].type,emails[0].primary minUser,Test123!,UniqueUserID@work.com,work,TRUE
Other fields you can include in CSV upload
In the CSV file upload, you can include other values like user status, groups, and user type like the following:
- status
Use valid status value like
active
. If the user identity does not have a status value, the user status will be instaged
mode.For more information about valid user status values, see SecureAuth Identity Store definitions.
- groups
Use valid group names like
Default;Admin;IT
- userType
Define user type identifiers like
Contractor
Example CSV file format with full list of fields
userName,status,userType,title,password,preferredLanguage,ExpirationDate,timezone,locale,name.honorificPrefix,name.givenName,name.middleName,name.familyName,name.honorificSuffix,nickName,groups,emails[0].value,emails[0].type,emails[0].primary,emails[1].value,emails[1].type,emails[1].primary,emails[2].value,emails[2].type,emails[2].primary,emails[3].value,emails[3].type,emails[3].primary,phoneNumbers[0].value,phoneNumbers[0].type,phoneNumbers[0].primary,phoneNumbers[1].value,phoneNumbers[1].type,phoneNumbers[1].primary,phoneNumbers[2].value,phoneNumbers[2].type,phoneNumbers[2].primary,phoneNumbers[3].value,phoneNumbers[3].type,phoneNumbers[3].primary,addresses[0].streetAddress,addresses[0].locality,addresses[0].region,addresses[0].postalCode,addresses[0].country,addresses[0].type,addresses[0].primary,addresses[1].country,addresses[1].streetAddress,addresses[1].locality,addresses[1].region,addresses[1].postalCode,addresses[1].type,addresses[1].primary