Managing JavaScript mapping rules

Create, edit, or delete JavaScript mapping rules.

About this task

When you activate the Federation offering, the following mapping rule types are available:

OAUTH
OAuth mapping rule.
OIDC
OpenID Connect mapping rule.
SAML2_0
SAML 2.0 mapping rule.
SAML2_0_AUTHN_REQ
SAML 2.0 Authentication Request mapping rule

Procedure

  1. Click Federation.
  2. Under Global Settings, click Mapping Rules.
    All existing mapping rules are displayed.
  3. You can create, edit, or delete a mapping rule.
    Create a mapping rule
    1. Click Add.
    2. In the Content field, enter the JavaScript mapping rule content.
    3. In the Name field, enter a name for the rule.
    4. In the Category field, select the type of the mapping rule from the list.
      Note: Only the mapping rule types that apply to your current activated offering are displayed in the list.
    5. Click Save.
    Modify a mapping rule
    1. Select the mapping rule to modify.
    2. Click Edit.
    3. Modify the mapping rule in the Content field as needed.
      Note: The Name and Category fields are not editable.
    4. Click Save.
    Delete a mapping rule
    1. Select the mapping rule to delete.
    2. Click Delete.
    3. Click Delete to confirm.
    Replace a mapping rule
    1. Select the mapping rule to replace.
    2. Click Replace.
    3. Click the Browse button and select the local file that contains the new contents.
    4. Click OK.
    Import a mapping rule
    1. Click Import.
    2. In the Name field, enter a name for the rule.
    3. In the Category field, select the type of the mapping rule from the list.
      Note: Only the mapping rule types that apply to your current activated offering are displayed in the list.
    4. Click the Browse button and select the local file that contains the new contents.
    5. Click OK.
    Export a mapping rule
    1. Select the mapping rule to export.
    2. Click Export.
    Import multiple mapping rules
    1. Click Manage and select Import Zip from the drop-down menu.
    2. Click the Browse button and select the local zip file that contains the mapping rules to import.

      The mapping rules must exist in the root directory of the zip file alongside a manifest.json file that describes each new mapping rule.

      The manifest.json file is an array of entries where each entry must contain each of:
      name
      The name of the mapping rule.
      category
      The category of the mapping rule.
      fileName
      The name of the file in the zip that contains the mapping rule contents.
      For example:
      [
          {“name”:”ruleA”, “category”:”InfoMap”, “fileName”:”ruleA.js”},
          {“name”:”ruleB”, “category”:”AuthSvc”, “fileName”:”ruleB.js”}
      ]
      An error will be returned if:
      • A file exists without a manifest entry.
      • A manifest entry exists for a non existent file.
      • A manifest entry does not contain name, category, and fileName.
    3. Click OK.
    Exporting multiple mapping rules
    1. Click Manage and select Export Zip from the drop-down menu.