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 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	Description	Header value	Required
User ID	The User ID of the user. This value must be unique. If the User ID already exists, the user record fails.	userId	Yes
First Name	The first name of the user.	firstName	Yes*
Last Name	The last name of the user.	lastName	Yes*
Email	The email address of the user. This is the address that receives Identity as a Service notifications. If an invalid address is provided, the record fails.	email	Yes*
Mobile	The mobile phone number of the user. This number receives SMS OTPs. Note: Use the E.164 phone number format; otherwise, the record fails.	mobile	Yes*
Phone	The phone number of the user. This number receives Voice OTPs. Note: Use the E.164 phone number format; otherwise, the record fails.	phone	No*
User Principal Name	The User Principal Name of the user. Used with Active Directory synchronization.	userPrincipalName	No*
Security ID	Security ID value that uniquely identifies users in a Microsoft Windows environment.	securityID	No*
External ID	External ID value that uniquely identifies users in a customer's environment.	externalID	No*
State	The state of the user. Default is ACTIVE. Allowed values: ACTIVE, INACTIVE.	state	No
Locale	The locale of the user (for example, jp for Japan).	locale	No
Locked	When TRUE, all authenticators are locked when the user is created. Default is FALSE. Allowed values: TRUE, FALSE.	locked	No
Group	Assigns the user to a group when created. Note: The group must already exist or the record fails. This bulk operation supports only a single group. See the Assign Groups bulk operation to assign additional groups.	group	No

info

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 users

1. Click > Bulk Operations. The Bulk Operations page appears.

2. Click . The Add Bulk Operation page appears.

3. From the Operations drop-down list, select Users.

4. From the Actions drop-down list, select Import.

5. 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".

6. 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.

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

8. Enter a Description that describes the purpose of the operation.

9. Click Upload your CSV file and browse to select the bulk operations file.

10. Click Initiate and Upload.

11. The Start/Stop dialog box appears.

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

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

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

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