Skip to main content

Bulk operations

What are bulk operations?

Bulk Operations allow you to automate large-scale tasks on your Identity as a Service account. You upload a file containing the details of the bulk operation to be performed and Identity as a Service processes the file in the background.

Identity as a Service supports the following bulk operations:

User Management

Authenticator Management

How do they work?

In order to run a bulk operation, you must upload a file containing the details of the bulk operation you want to run. The majority of bulk operations accept a CSV (Comma-separated values) file. Once initiated, Identity as a Service reads the file and processes each record (row). This operation runs in the background allowing you to continue using Identity as a Service while your bulk operation is being processed.

note

Bulk operation data files that are uploaded to Identity as a Service are encrypted in transit and at rest.

Before uploading your CSV file, ensure the following:

  • The file must have one header row and one or more data rows.

  • The file can use either the comma delimiter "," or the pipe delimiter "|". A CSV file cannot contain a mixture of both delimiters in the same file.

  • Each record must be on a separate line.

  • The file must be UTF-8 encoded.

  • The header row must not contain any white space between columns.

    Good: userId,firstName,lastName,
    Bad: userId, firstName, lastName
  • If there is white space in an attribute name, wrap the header column in quotes.

    userId,"My attribute",group
  • White space is permitted for content rows.

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

By default, Microsoft Excel does not use UTF-8 encoding. If you are using Microsoft Excel to edit your bulk file, ensure that you export the file as UTF-8.

Restrictions and limitations

The following are restrictions and limitations of bulk operations:

  • Only one type of bulk operation can be performed at a time.
  • For each type of bulk operation, a previous one must no longer be in a PROCESSING state before another operation of the same type is initiated. The previous operation must be in the COMPLETED, CANCELED, or FAILED state.
  • A user's role determine the bulk operations that are allowed to be performed by that user.