Transferring Data

Import and export users, groups, and Oracle application roles into an identity domain.

Learn how to import and export large amounts of data into an identity domain using the user interface. Import data to help you bulk load users, groups, and Oracle application roles. Export data, make changes, and then import those changes back into an identity domain.

Required Policy or Role

To transfer data, you must have one of the following access grants:
  • Be a member of the Administrators group
  • Be granted the Identity Domain Administrator role or the User Administrator role
  • Be a member of a group granted manage domains

To understand more about policies and roles, see The Administrators Group, Policy, and Administrator Roles, Understanding Administrator Roles, and Understanding Policies.

Import File Specifications

Learn about import file specifications to reduce the possibility of errors.

Whether you're importing users, groups, or Oracle application roles, the import file itself must meet the following specifications:
  • Use a comma as the delimiter between the values

  • Save the file in a CSV format (*.csv)

  • Limit file size to 52 MB

Tip

Import just one user to familiarize yourself with the process. You can then import a larger set of users, for example, 100 users. If you don't experience any import errors, increase the import file size according to your comfort level.

The import file is a simple text file in a tabular format (rows and columns). The first row in the file defines the columns (fields) in your table. At a minimum, the import file must have these exact column headings.
Import File Required Column Headings
Users

User ID

Last Name

First Name

Work Email

Groups

Display Name

Description

User Members

Requestable

Application Role Membership

Entitlement Value

Grantee Name

Grantee Type

App Name

For each account, create a row (line) and enter data into each column (field). Each row equals one record.

To create an import file, you can use a standard spreadsheet application, such as Microsoft Excel or Google Sheets, or you can use a text editor, such as Notepad or TextPad.
Important

Whichever application you use to create the file, ensure that you save the file in a valid CSV format.

Spreadsheet applications make it easy to create, edit, and save import files. You can use standard features to add and delete rows of data, edit individual fields, search for records, or sort the list. The following illustration shows an example of group account data defined in a Microsoft Excel file. The layout lets you easily review the data.

CSV file displayed using Microsoft Excel.

When you save your spreadsheet as type CSV (*.csv), a comma separates the values in each row. For example, the following illustration shows the group data from the Microsoft Excel spreadsheet, saved as CSV file, and opened in Notepad.

CSV file displayed using Notepad.

Column Header User Attributes

Use these user attributes as column headers while importing or exporting user accounts using a comma-separated values (CSV) file.

The following list of user attributes is supported:

User Name

Active

Work Address Street

Work Address Locality

Work Address Region

Work Address Postal Code

Work Address Country

Work Address Formatted

Home Address Street

Home Address Locality

Home Address Region

Home Address Country

Home Address Postal Code

Home Address Formatted

Other Address Street

Other Address Locality

Other Address Region

Other Address Country

Other Address Postal Code

Other Address Formatted

Primary Address Type

Display Name

Work Email

Home Email

Primary Email Type

Other Email

Recovery Email

Work Email Verified

Home Email Verified

Other Email Verified

Recovery Email Verified

External Id

Locale

Created Date

Formatted Name

Honorific Prefix

First Name

Middle Name

Last Name

Honorific Suffix

Nick Name

Work Phone

Mobile No

Home Phone

Fax

Pager

Other Phone

Recovery Phone

Primary Phone Type

Preferred Language

Profile Url

Time Zone

Title

User Type

Cost Center

Department

Division

Employee Number

Manager

Organization Name

ByPass Notification

Federated

Locked

Locked Reason

Locked Date

Password

Sample Import Files

To assist you when importing data, Oracle provides sample import files for you to use. You can download the compressed sample files in the identity domain console or from a link provided by Oracle. Whether you download the sample files from the identity domain console or from a link provided by Oracle, the sample files are the same.

To create an import file, you can use a standard spreadsheet application, such as Microsoft Excel or Google Sheets, or you can use a text editor, such as Notepad or TextPad. To download the sample files, click the Download sample file link.
Important

If you’re using the sample file to import application role memberships, then ensure that the column headings are Entitlement Value, Grantee Name, and Grantee Type (instead of Display Name, Member, and Member Type). If the column headers aren’t correct, then change them accordingly.

Tip

First import the appropriate sample file with the sample data to familiarize yourself with the process. When you are comfortable with the process, delete the sample data, and then import live data.

Using the Console

Importing Users

Import users using a comma-separated values (CSV) file.

Before you can import users, first create a CSV file that is properly formatted for the import process. To create and prepare a file for import, follow these steps.
  1. Download these sample files as a starting point.

  2. Extract the compressed file and then open the Users.csv file.

  3. Optional. To familiarize yourself with the import process, consider importing just the demo data. You can then delete the unwanted demo data before you begin importing live data.
  4. Review and then delete any demo data in the Users.csv file.

  5. Create an import file using the Users.csv file. The Users.csv file is a simple text file in a tabular format (rows and columns). The first row in the file defines the columns (fields) in your table.

    Note

    • The maximum number of rows in the user import file must not exceed 100,000 and the import file size must not exceed 52 MB.

    • At a minimum, the file must have these exact column headings and the fields in these columns must be unique.
      • User ID

      • Last Name

      • First Name

      • Work Email

      • Primary Email

      • Primary Email Type

    • For each account, you create a new row (line) and enter data into each column (field). Each row equals one record.

    • The telephone numbers of the users that you want to import must meet the requirements of the RFC 3966 specification.

    • When importing users, the attribute Recovery cannot be specified as one of valid values for Primary Email Type. The valid values for Primary Email Type are home, work, or other.

    • If you want users to use their federated accounts to sign in, then you must set the Federated column to TRUE for those users. When the federated flag is set to TRUE, IAM no longer manages the federated user’s password. This prevents IAM from forcing a password change for these imported user accounts.

    • If you don't want users to be notified that accounts were created for them, then you must set the ByPass Notification column to TRUE for those users. The ByPass Notification option determines whether an email notification is sent after creating or updating a user.

    • To create a CSV file, you can use a standard spreadsheet application, such as Microsoft Excel or Google Sheets, or you can use a text editor, such as Notepad or TextPad.

  6. Save your file in UTF-8 format. Saving the file in UTF-8 format ensures that non-English characters display properly.
    1. Open the CSV file with a text editor, such as Notepad.
    2. Save the file with UTF-8 for encoding.
    Note

    If you do not save the file in a CSV format with UTF-8 encoding, the import fails.
To import users, follow these steps.
  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Select the identity domain you want to work in and click Users.
  3. From the More actions menu, click Import users.
  4. In the Import users window, drag and drop the file or click Select one to browse for the file.
  5. Click Import.
    If a user account is missing a required value, such as the user's first name, last name, or username, then that account won't be imported and the next user account in the CSV file is evaluated.
  6. After the job completes, review the job results.
    • If the job can be processed immediately, then a dialog box appears with the Job ID and a link for your import job. Click the link and review the details that appear on the Jobs page.
    • If the job cannot be processed immediately, then a message appears with a Schedule ID in it. Copy that Schedule ID, and use it to search for the job on the Jobs page. The job appears when processing completes.
    Tip

    A job ID is assigned to each file that's imported or exported, for auditing purposes.
  7. If needed, go to the Jobs page, locate and open the job that you want to view.
    A table displays the first names, last names, email addresses, user names, and statuses of the users that you imported.
    Note

    If a user account can be imported, then a Creation Succeeded or Update Succeeded link appears for the status, depending on whether you imported a new account or modification to an existing account. To see granular details about the account, click the link.

    If a user account can’t be imported, then a Creation Failed or Update Failed link appears for the status. To see information about why the account or modification can’t be imported, click the link.

  8. Review the details that appear on the Jobs page.
See Export Job Errors to download a CSV file of any errors to your local machine.
Importing Groups

Import groups using a comma-separated values (CSV) file.

Before you can import groups, create a CSV file that is properly formatted for the import process. To create and prepare a file for import, follow these steps.
  1. Use these sample files as a starting point.

  2. Extract the compressed file and then open the Groups.csv file.

  3. Optional. To familiarize yourself with the import process, consider importing just the demo data. You can then delete the unwanted demo data before you begin importing live data.
  4. Review and then delete any demo data in the Groups.csv file.

  5. Create an import file using the Groups.csv file. The Groups.csv file is a simple text file in a tabular format (rows and columns). The first row in the file defines the columns (fields) in your table. At a minimum, the file must have these exact column headings:
    • Display Name

    • Description

    • User Members

    Tip

    Ensure that the fields in these columns are unique. Also, verify that the user names that appear in the User Members column already exist in the identity domain.
    For each account, you create a new row (line) and enter data into each column (field). Each row equals one record.
    Important

    The data provided in the CSV file must meet the following requirements:
    • The IDs of the users in the file must contain at least three characters. The names of the groups must contain at least five characters.
    • The telephone numbers of the users that you want to import must meet the requirements of the RFC 3966 specification.
    • The maximum number of rows in group import file must not exceed 100,000 and the import file size must not exceed 52 MB.

    To create a CSV file, you can use a standard spreadsheet application, such as Microsoft Excel or Google Sheets, or you can use a text editor, such as Notepad or TextPad.

  6. Save your file in UTF-8 format. Saving the file in UTF-8 format ensures that non-English characters display properly.
    1. Open the CSV file with a text editor, such as Notepad.
    2. Save the file with UTF-8 for encoding.
    Note

    If you do not save the file in a CSV format with UTF-8 encoding, the import fails.
To import groups, follow these steps.
  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Select the identity domain you want to work in and click Groups.
  3. From the More actions menu, select Import groups.
  4. In the Import groups window, drag and drop the file or click Select one to browse for the file.
  5. Click Import.
    If a group fails to import, ensure that the group does not already exist and that the required values are given. If the identity domain can't import a group, then it evaluates the next group in the CSV file.
  6. After the job completes, review the job results.
    • If the job can be processed immediately, then a dialog box appears with the Job ID and a link for your import job. Click the link and review the details that appear on the Jobs page.
    • If the job cannot be processed immediately, then a message appears with a Schedule ID in it. Copy that Schedule ID, and use it to search for the job on the Jobs page. The job appears when processing completes.
    Tip

    A job ID is assigned to each file that's imported or exported, for auditing purposes.
  7. If needed, go to the Jobs page, locate and open the job that you want to view.
    The Job Details page shows how many groups you imported, how many groups imported successfully, and how many groups can't be imported because of a system error. For each group that you imported successfully, this page also shows how many users are assigned to the group.
See Export Job Errors to download a CSV file of any errors to your local machine.
Importing Users and Groups for Oracle Application Roles

You can import users and groups using a comma-separated value (CSV) file and assign them to Oracle application roles.

Note

To import or export users and groups for application roles, you must be assigned to either the identity domain administrator role or the application administrator role.
To import users and groups for Oracle application roles, follow these steps.
  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Select the identity domain you want to work in and click Applications.
  3. In the Applications page, click the Oracle application that has roles to which you want to assign users and groups.
    Note

    Importing application roles imports application roles memberships only. The application roles must already exist in the identity domain. If the application roles don’t exist you will receive an error for the membership import for that application role.
  4. Click Application roles.
  5. In the Import application roles window, drag and drop the file or click Select one to browse for the file.
    Note

    Click Download sample file in the dialog box to download a sample file.
  6. Click Import.
    If a user or a group is missing a required value, such as the user name or the group name, then that user or group can't be imported. If the user or group can't be imported, then the next user or group is evaluated in the CSV file.
  7. After the job completes, review the job results.
    • If the job can be processed immediately, then a dialog box appears with the Job ID and a link for your import job. Click the link and review the details that appear on the Jobs page.
    • If the job cannot be processed immediately, then a message appears with a Schedule ID in it. Copy that Schedule ID, and use it to search for the job on the Jobs page. The job appears when processing completes.
    Tip

    A job ID is assigned to each file that's imported or exported, for auditing purposes.
  8. If needed, go to the Jobs page, locate and open the job that you want to view.
    A table appears that displays the user names or group names, classification types (User or Group), and status of the users and groups that you imported and assigned to Oracle application roles in the identity domain.
See Export Job Errors to download a CSV file of any errors to your local machine.
Exporting Users

Export users to a comma-separated values (CSV) file.

You can export the users for the following attributes only: User Name, Work Email, Home Email, Primary Email Type, Honorific Prefix, First Name, Middle Name, Last Name, Honorific Suffix, and Password.
  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Select the identity domain you want to work in and click Users.
  3. Select the check box for each user that you want to export.
  4. From the More actions menu, select Export users.
  5. In the Export users window, click Export.
  6. After the job completes, review the job results.
    • If the job can be processed immediately, then a dialog box appears with the Job ID and a link for your import job. Click the link and review the details that appear on the Jobs page.
    • If the job cannot be processed immediately, then a message appears with a Schedule ID in it. Copy that Schedule ID, and use it to search for the job on the Jobs page. The job appears when processing completes.
  7. If needed, go to the Jobs page, locate and open the job that you want to view.
    A page shows how many users you exported, how many accounts exported successfully, and how many accounts can't be exported because of a system error.
  8. Click Download exported file.
  9. Save your file in a UTF-8 format. Saving the file in UTF-8 format ensures that non-English characters display properly.
    1. Open the CSV file with a text editor, such as Notepad.
    2. Save the file with UTF-8 for encoding.
  10. (Optional) In addition to saving the file in UTF-8 format, if you are using Microsoft Excel to open and save the file, perform the additional steps to ensure that non-English characters display properly.
    1. In Microsoft Excel, open a new workbook, click the Data tab, and then choose From Text/CSV.
    2. On the Import Data window, choose your CSV file, and then click Import.
    3. For File Origin, select 65001: Unicode (UTF-8).
    4. For Delimiters, select Comma.
    5. For Data Type Detection, select Based on first 200 rows, and then click Transform Data.
    6. Click Close and Load.
    7. Save the file.
Exporting Groups

Export groups to a comma-separated values (CSV) file.

  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Select the identity domain you want to work in and click Groups.
  3. Select the check box for each group that you want to export.
  4. From the More actions menu, select Export groups.
  5. In the Export groups window, click Export.
  6. After the job completes, review the job results.
    • If the job can be processed immediately, then a dialog box appears with the Job ID and a link for your import job. Click the link and review the details that appear on the Jobs page.
    • If the job cannot be processed immediately, then a message appears with a Schedule ID in it. Copy that Schedule ID, and use it to search for the job on the Jobs page. The job appears when processing completes.
  7. If needed, go to the Jobs page, locate and open the job that you want to view.
    A page shows how many groups you exported, how many groups exported successfully, and how many groups can't be exported because of a system error.
  8. Click Download exported file.
  9. Save your file in a UTF-8 format. Saving the file in UTF-8 format ensures that non-English characters display properly.
    1. Open the CSV file with a text editor, such as Notepad.
    2. Save the file with UTF-8 for encoding.
  10. (Optional) In addition to saving the file in UTF-8 format, if you are using Microsoft Excel to open and save the file, perform the additional steps to ensure that non-English characters display properly.
    1. In Microsoft Excel, open a new workbook, click the Data tab, and then choose From Text/CSV.
    2. On the Import Data window, choose your CSV file, and then click Import.
    3. For File Origin, select 65001: Unicode (UTF-8).
    4. For Delimiters, select Comma.
    5. For Data Type Detection, select Based on first 200 rows, and then click Transform Data.
    6. Click Close and Load.
    7. Save the file.
Exporting Users and Groups for Oracle Application Roles

Export users and groups assigned to Oracle application roles of Oracle applications to a comma-separated values (CSV) file.

  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Open the navigation menu and click Identity & Security. Under Identity, click Domains.Select the identity domain you want to work in and click Applications.
  3. In the Applications page, click the Oracle application that has application roles with users and groups assigned to them.
  4. Click Application roles.
  5. Select the check box for application role that you want to export and click Export.
  6. Click Confirm.
  7. After the job completes, review the job results.
    • If the job can be processed immediately, then a dialog box appears with the Job ID and a link for your import job. Click the link and review the details that appear on the Jobs page.
    • If the job cannot be processed immediately, then a message appears with a Schedule ID in it. Copy that Schedule ID, and use it to search for the job on the Jobs page. The job appears when processing completes.
  8. If needed, go to the Jobs page, locate and open the job that you want to view.
    This page shows how many application roles that you attempted to export, how many application roles exported successfully, and how many application roles can't be exported because of a system error.
  9. Click Download exported file.
See Export Job Errors to download a CSV file of any errors to your local machine.
Downloading Exported Files

After you export files from an identity domain, you must download the files, for example, if you want to import them to another identity domain.

  1. Open the navigation menu and click Identity & Security. Under Identity, click Domains.
  2. Select the identity domain you want to work in and click Jobs.
  3. Locate and select the specific job for which you want to export the file.
  4. Click Download exported file.
    A comma-separated value (CSV) file downloads to your local machine. The CSV file contains a record for each error that includes the error type and the error description.