Oracle Identity Cloud Service: Bulk Loading Users and Groups Using CSV Files


Options



Before You Begin

Purpose

In this tutorial you learn to bulk load users and groups in Oracle Identity Cloud Service using comma-separated value (CSV) files.

Time to Complete

30 minutes.

Background

Oracle Identity Cloud Service provides four different methods for managing entities (users, groups, and applications) and configurations in bulk:

Methods supported for managing users, groups, and applications in Identity Cloud Service
Method CSV files
(this tutorial)
Identity Bridge REST API OIM connector
Description

Identity Domain Administrators or User Administrators manually download, edit, and upload a CSV file containing users or groups for bulk-loading in Oracle Identity Cloud Service.

An Oracle Identity Cloud Service agent installed in your environment automatically and continuously synchronizes users and groups from your Microsoft Active Directory to Oracle Identity Cloud Service

The Oracle Identity Cloud Service REST APIs are used by your custom application for managing users and groups

An Oracle Identity Manager (OIM) connector is used to automatically and continuously provision and reconcile users and groups from Oracle Identity Cloud Service

Characteristics
  • Is the best way to manually bulkload users and groups
  • Is quick and convenient
  • Does not require coding and integration skills
  • Supports only user and group creation and modification (does not support deletion)
  • Requires human interaction (cannot be automated)
  • Is the best way to automatically and continuously synchronize your company users and groups from your Microsoft Active Directory to Oracle Identity Cloud Service, when you don't have an identity management solution
  • Leverages a windows installer for setup and configuration
  • Does not require coding skills
  • Supports only unidirectional integration (from Active Directory to Oracle Identity Cloud Service)
  • Is the best way to integrate a custom application with Oracle Identity Cloud Service
  • Can be integrated with any code language that supports cloud standards (REST, JSON, OAuth, and SCIM)
  • Requires coding skills
  • Is the best way to automatically and continuously synchronize your OIM on-premises with Oracle Identity Cloud Service in a hybrid cloud solution
  • Leverages an out-of-the-box connector for integration
  • Does not require coding skills
  • Can leverage OIM enterprise governance features, such as Certification and Segregation of Duties with closed loop remediation for a complete identity governance

In this tutorial, you learn to bulk load users using CSV files.

What Do You Need?

  • Access to Oracle Identity Cloud Service with authorization to manage users and groups (Identity Domain Administrator or User Administrator).
  • A spreadsheet editor, such as Microsoft Excel or Google Sheets.
  • A file extractor utility, such as WinZip, WinRAR, or 7-Zip.

Downloading the CSV Templates

In this task, you download the templates available for importing users and groups to Oracle Identity Cloud Service.

  1. In the Identity Cloud Service console, expand the Navigation Drawer , and then click Users.
  2. Click Import.
  3. Click Download sample file.
    Note: The sample files can be used as a template (or boilerplate) for creating your own user's CSV file for import.
    Download sample file link
    Description of this image
  4. Save the bulkImportSampleFilesCSV.zip file to your local disk and minimize your browser.
  5. Extract the bulkImportSampleFilesCSV.zip file contents.
    Note: The bulkImportSampleFilesCSV.zip file contains CSV templates for importing users (Users.csv) and groups (Groups.csv) to Oracle Identity Cloud Service.

Bulk Loading Users

In this task, you learn to import users to Oracle Identity Cloud Service using CSV files.

Modifying the User CSV File

  1. Open the bulkImportSampleFilesCSV/Users.csv file in a spreadsheet editor. (In this tutorial, we are using Microsoft Excel).
    Opening Users.csv in Excel
    Description of this image
  2. Review the users file.
    • The Users.csv file contains several columns where you provide information about the user(s) you may want to load in Oracle Identity Cloud Service.
    • The file also contains a few user entries you can use as an example to better understand how the user information can be provided.
    • For loading your users, you are not required to fulfill all columns. The only columns required are User ID, First Name, Last Name, and Work Email.
    • To understand more about what each column represents in Oracle Identity Cloud Service, check the Oracle Identity Cloud Service User Details page.
      User Details page in Oracle Identity Cloud Service
      Description of this image
  3. Replace the sample entries with your own users.
    Tip: You can use the following data as sample.
    Sample table containing users for bulk load in Identity Cloud Service
    User ID Last Name First Name Work Email Password
    ajefferson@example.com Jefferson Anika ajefferson@example.com Awelcome123
    qterrell@example.com Terrell Quincy qterrell@example.com Qwelcome123
    mhoover@example.com Hoover Maxwell mhoover@example.com Mwelcome123
    gmaddox@example.com Maddox Gregory gmaddox@example.com Gwelcome123
    hleon@example.com Leon Holmes hleon@example.com Hwelcome123
    dmorin@example.com Morin Dahlia dmorin@example.com Dmorin123
    CSV file with custom users loaded
    Description of this image
  4. Save and close your file.
    Tip: When you save a CSV file using Microsoft Excel, a few warning messages will appear suggesting you to save the file in a different format (XLS or XLSX). Ignore these messages.
    Saving a CSV file in Microsoft Excel
    Description of this image

Importing Users

  1. Back in the Import Users dialog box, click Browse.
    Browsing CSV files for import
    Description of this image
  2. Select the CSV file containing your users for import.
  3. Click Import.
  4. Review the job results.
    If the job can be processed immediately, a dialog box appears with the Job ID link for your import job, click the link.
    If the job cannot be processed immediately, a message appears with a Schedule ID in it. Copy that Schedule ID, click Jobs, and search for the respective job id.
  5. Verify the Job ID report for your user import.
    Import Users - Job report
    Description of this image
  6. If you used the sample data provided with this tutorial, you will see that the job was able to import all users except Dahlia Morin. Because of this, the job result is completed with error.
    Tip: We did this on purpose to show you how Oracle Identity Cloud Service handles user errors individually during the import.
  7. In the Dahlia Morin row, click Creation Failed.
  8. Observe that the import error message describes that Dahlia's password does not meet the Oracle Identity Cloud Service password policy.
    Import Users - Creation Error summary
    Description of this image
  9. Click Close.

Bulk Loading Groups

In this task, you learn how to import groups to Oracle Identity Cloud Service using CSV files.
During the tasks, you will notice that the procedure for manipulating and importing groups is similar to the user import.

Modifying the Groups CSV File

  1. Open the bulkImportSampleFilesCSV/Groups.csv file in a spreadsheet editor.
  2. Review the groups file.
    • The Groups.csv file contains the following columns (the only column required is Display Name):
      • Display Name: Contains the name of the group.
      • Description: Provides descriptive information about the group.
      • User Members: List users who are assigned to the group, separated by semicolons (;).
    • The file also contains a few group entries that you can use as an example to understand how the group information can be provided.
  3. Replace the sample entries with your own groups.
    Tip: You can use the following data as sample.
    Sample table containing groups for bulk load in Identity Cloud Service
    Display Name Description User Members
    Reviewer Group This group has all the reviewers ajefferson@example.com;qterrell@example.com
    Approver Group This group has all the approvers mhoover@example.com;gmaddox@example.com
    Audit Group This group has all the auditors hleon@example.com;dmorin@example.com
    CSV file with custom groups loaded
    Description of this image
  4. Save and close your file.

Importing Groups

  1. In the Oracle Identity Cloud Service console, expand the Navigation Drawer , and then click Groups.
  2. Click Import.
  3. Click Browse.
  4. Select the CSV file with your groups for import.
  5. Click Import.
    After uploading the file, Oracle Identity Cloud Service displays a Job ID for import processing
  6. Review the job results.
    If the job can be processed immediately, a dialog box appears with the Job ID link for your import job, click the link.
    If the job cannot be processed immediately, a message appears with a Schedule ID in it. Copy that Schedule ID, click Jobs, and search for the respective job id.
  7. Oracle Identity Cloud Service displays the report for your group import.
    Import Groups - Job report
    Description of this image
  8. If you used the sample data provided with this tutorial, you will see that the job was able to import all groups except the Audit Group. Because of this, the job result is completed with error.
    Tip: We did this on purpose to show you how Oracle Identity Cloud Service handles group import errors individually.
  9. In the Audit Group row, click View Details.
  10. Click Creation Failed.
  11. The import error message identifies that dmorin@example.com user does not exist in Oracle Identity Cloud Service.
    Import Groups - Creation Error summary
    Description of this image
  12. Click Close.

Want to Learn More?

Credits

  • Developer(s): Frederico Hakamine.