Set users in bulk

The Set users options allows you to Update users in bulk and create users in bulk.

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	Description
User ID	userId	Yes	The User ID of the user. This value must be unique. If the User ID already exists, then the user record will fail.
First Name	firstName	Yes*	The first name of the user.
Last Name	lastName	Yes*	The last name of the user.
Email	email	Yes*	The email address of the user. This is the address that will receive emails from Identity as a Service. If an invalid email address is provided, the user record will fail.
Mobile	mobile	Yes*	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.
Phone	phone	No*	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.
User Principal Name	userPrincipalName	No*	The User Principal Name of the user. This value is used with Active Directory synchronization.
Security ID	securityID	No*	Security ID value uniquely identifies users in a Microsoft Windows environment.
External ID	externalID	No*	External ID value uniquely identifies users in a customer's environment.
State	state	No	The state of the user. The default value is ACTIVE. Allowed values: ACTIVE, INACTIVE.
Locked	locked	No	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.
Group	group	No	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.

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

Set users in bulk

How to set users in bulk

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

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. Optional. Copy or download the same bulk file and modify it as required.

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.