Bulk Import Identities

Overview

You can use a CSV file to bulk import identities. This is useful when you want to add a large number of identities to a role or assignment at one time.

Import identities in bulk

Before you begin:
You’ll need a CSV file containing the identity profiles you want to import. The file must comply with this CSV template example:

CSV template example
{
  "_id": "template",
  "header": "\"userName\",\"givenName\",\"sn\",\"mail\",\"description\",\"accountStatus\",\"telephoneNumber\",
 \"postalAddress\",\"address2\",\"city\",\"postalCode\",\"country\",\"stateProvince\",\"preferences/updates\",
 \"preferences/marketing\""
}

Be sure to use commas as separators. Any other separator may cause errors.

For information about generating this file, see the "Import Bulk Data" section of the ForgeRock IDM 7.0 Object Modeling Guide .  

  1. In the Identity Cloud Admin UI, go to Identities > Import.

  2. On the Import Identities page, click + New Import.

  3. On the New Import dialog box, select the realm-target you want to import to.

    Tell me more

    The target can be any managed object such as a user, role, or assignment defined within a realm. For example, you could import ten user profiles to the Bravo-realm Roles target. The imported user profiles are added to the bravo-role managed object in Identity Cloud.

  4. Click Next.

  5. (Optional) If you haven’t already generated a CSV file, click the CSV Template link to download an example file.

    If you use this file:

    • Replace the attributes in this file with attributes in your identity resource server.

    • Delete all unused attributes.

  6. Enter the name of the CSV file to upload.

  7. Choose a property Identity Cloud can use to match an entry in the CSV file to an identity profile in your realm-target.

    Tell me more

    For example, you could choose the username property. If username bjensen exists in your CSV file, Identity Cloud tries to verify that a user profile with the username bjensen also exists in your tenant. If verified, then Identity Cloud updates the entire bjensen user profile. If no match is found, then Identity Cloud creates a user profile for bjensen.

  8. Click Next.

    The Import Complete dialog box indicates real-time import progress. When the import is complete, Identity Cloud displays the number of new, updated, unchanged, and failed imports.

  9. (Optional) To download a CSV file containing a list of identity profiles that failed to import, click Download CSV.

  10. Click Done.

For a deep dive into bulk import information, see the "Import Bulk Data" section of the ForgeRock IDM 7.0 Object Modeling Guide .  

View or delete a CSV file

  1. In the Identity Cloud Admin UI, go to Identities > Import.

  2. On the Import Identities list, find the filename.
    In the same row, click More ().

  3. Choose View Details or Delete.