Import users

Use the Import Users bulk operation to import a large amount of users into your Identity as a Service account. Before you begin, review the information on Perform bulk operations and the attribute information on this page.

There are two types of attributes:

System attributes

Custom user attributes

CSV file format

The following is a sample CSV file to help you get started:

userId,firstName,lastName,email,mobile,
jdoe, john, doe, john@mycompany.com, +155555555555

Download a sample file: User_Import_Sample.csv

System attributes

System attributes are set by Identity as a Service. See Create and manage user attributes for more information on mandatory and optional system attributes.

The following table summarizes the supported Identity as a Service system user attributes.

Table: User system attributes

Attribute	Header Value	Required
User IDUser ID The User ID of the user. This value must be unique. If the User ID already exists, then the user record will fail.	userId	Yes
First NameFirst Name The first name of the user.	firstName	Yes*
Last NameLast Name The last name of the user.	lastName	Yes*
EmailEmail The email address of the user. This is the address that will receive emails from Identity as a Service. If an invalid email addresses is provided, the user record will fail.	email	Yes*
MobileMobile The mobile phone number of the user. This number will receive SMS OTPs when authenticating to Identity as a Service. Note: This value must be in the E.164 phone number format. If an invalid phone number is provided then the user record will fail.	mobile	Yes*
PhonePhone The phone number of the user. This number will receive Voice OTPs when authenticating to Identity as a Service. Note: This value must be in the E.164 phone number format. If an invalid phone number is provided then the user record will fail.	phone	No*
User Principal NameUser Principal Name The User Principal Name of the user. This value is used with Active Directory synchronization.	userPrincipalName	No*
Security IDSecurity ID value uniquely identifies users in a Microsoft Windows environment.	securityID	No*
StateState The state of the user. The default value is `ACTIVE`. Allowed Values `ACTIVE` `INACTIVE`	state	No
LocaleLocaleThe locale of the user, for example, jp for Japan.	locale	No
LockedLocked When this is set to `TRUE`, all of the user's authenticators will be locked when the user is created. The default value is `FALSE`. Allowed Values `TRUE` `FALSE`	locked	No
GroupGroup Assign the user to a group when the user is created. Note: The group must already exist in Identity as a Service, if not then the user record will fail. This Bulk Operation only supports assigning the user to a single group. See the Assign Groups bulk operation if you wish to assign users to multiple groups.	group	No

Note: * An attribute may or may not be required depending on the User Attribute settings of your Identity as a Service account. If any mandatory user attributes are missing from the data file or user record the user records will fail.

Custom user attributes

This bulk operation also allows setting custom user attributes to a user profile. For example, if your Identity as a Service account contains a custom user attribute called Birthday, then you would add that column to your data file:

userId,firstName,lastName,email,mobile,Birthday, jdoe, john, doe, john@mycompany.com, +15555555555, Jan 01 1980,

Bulk import users

How to bulk import usersHow to bulk import users

Click > Bulk Operations. The Bulk Operations page appears.

Click . The Add Bulk Operation page appears.

From the Actions drop-down list, select Import.

From the Operations drop-down list, select Users.

From the Operations Type drop-down, select one of the following:

Create Users to add new users in bulk. This operation ignores existing users.

Create or Update Users update existing users in bulk.

Select the File Delimiter Pipe (|) or Comma (,). The File Delimiter type identifies the character in your CSV file used to specify the boundary between each user or group name.

Note: If a data field requires a delimiter value or white space, put quotation marks around that field. If you do not, the information will not import. For example, you have a custom user attribute called, workplace with data values City, State, the information in the file must be enclosed in double-quotes: "City, State".

Set the Maximum Number of Retries to set the number of bulk import attempts if it is not immediately successful. The default value is 5. This setting prevents an endless number of retry attempt if the operation fails.

Enter a unique Name that identifies the operation in the Bulk Operations List page.

Enter a Description that describes the purpose of the operation.

Click Initiate. The File to upload dialog box appears.

Click the checkered box and browse to select your bulk import file and click Open.

Click Upload. The Start/Stop dialog box appears.

Click Start. When the upload completes, a Finished prompt appears.

Click Finished. You are returned to the Bulk Operations List page. Your bulk operation appears in the list.

To see a summary of the upload, click to view the details of the bulk operation, including any error information.

Click in the Refresh column to refresh the status of a bulk operation. This option appears only when a refresh is available.