ROI iAM

Appearance

Setup ​

Prerequisites ​

Before using the Dynamic Mapping Engine in an iFlow, ensure the following are in place.

Partner Directory — Bulk Structure Templates ​

Upload a Binary Parameter within:

  • Partner ID – ROIAM_SCIM_BULK_STRUCTURES

Examples:

  • Parameter ID User — a JSON object representing the SCIM User structure with default values
  • Parameter ID Link — a JSON object representing the SCIM Link structure with default values

If other SCIM objects are needed, the respective SCIM structure should be present as a binary file as well (e.g., Account).

Partner Directory — Mapping Rules ​

Upload a Binary Parameter within:

  • Partner ID – ROIAM_SCIM_DYNAMIC_MAPPING

Example:

  • Parameter ID – Repository name from ROI iAM

This JSON file contains a set of rules, all starting with rules_ and ending with the name of the SCIM objects in lowercase. For example: rules_users, rules_link, etc.

Required Headers ​

The header containing the repository name is mandatory for the iFlow that uses dynamic mapping:

HeaderDescription
roiam_customer_system_nameIdentifies which mapping rules to load from PD (matches the Binary Parameter ID)

Input Body Format ​

The script expects a JSON array of user objects. Each object contains key-value pairs representing the source system's fields. Example:

json
[
  {
    "MSKEYVALUE": "JDOE001",
    "MSKEY": "12345",
    "DISPLAYNAME": "John Doe",
    "MX_FIRSTNAME": "John",
    "MX_LASTNAME": "Doe",
    "MX_MAIL_PRIMARY": "john.doe@company.com",
    "MX_MANAGER": "67890",
    "MX_FS_IDENTITY_TYPE": "Employee"
  }
]

iFlow Script Step Configuration ​

A dedicated script that serves as the engine of the dynamic mapping should be inserted at the proper place in the iFlow to handle the incoming data and convert it to the expected SCIM bulk structure. Contact ROIABLE for a copy of the script.

Onboarding a New Customer System ​

Onboarding configures the Dynamic Mapping Engine to process data from a new source system by uploading mapping rules to the Partner Directory and referencing them from the iFlow.

Procedure ​

  1. Identify the customer system name (e.g., MYSYSTEM-ABC-001). This value is used as the Partner Directory Binary Parameter ID and set in the header roiam_customer_system_name.

  2. Create the mapping rules JSON file with the necessary rule arrays (e.g., rules_users, rules_link, etc.). Use the Examples as reference, or request template mapping structures from ROIABLE.

  3. Upload the mapping rules to the Partner Directory:

    • Partner ID – ROIAM_SCIM_DYNAMIC_MAPPING
    • Parameter ID – The customer system name (e.g., MYSYSTEM-ABC-001)
    • Type – Binary
    • Value – The JSON mapping file
    • Content Type – json
    • Encoding – UTF-8

  4. Ensure the bulk structure templates exist in the Partner Directory under Partner ID ROIAM_SCIM_BULK_STRUCTURES with respective Parameter IDs (e.g., User, Link, etc.).

  5. Configure the iFlow:

    • Set the header roiam_customer_system_name to the repository name
    • Add a script step with the provided dynamic mapping script

  6. Test with a small payload to verify mappings produce the expected output.

See also ​