On This Page

Overview

An account or group map provides the ability to explicitly map a specific user from one platform to another.  These are exceptions to the automatic account or group mapping policies specified.  Account or group map exceptions can be defined during the creation of the map or can be imported from a comma-separated values (CSV) file.  

Importing a Mapping File

1. Select Connections and select either User maps or Group maps depending on the map type.

2. Find the map and select Manage mappings.

3. Select Import mappings.
   

   

4. The Import user mappings modal appears. You have the option of uploading a file from your computer or from the source connection.
   To upload a file from your computer, verify you are on the Upload tab and select Browse. Navigate to the file and select Open. 
   

   

   
   To select a file from the source connection, click Select from the source connection. Navigate to the file or use the Manually enter path option to enter the path for the mapping file you want to use.
   

   

5. Once you select the file, click Use this file.

6. The screen will read the import file and display the mappings on the screen.

Creating Mappings

1. Click More Options and select Create user mapping.

2. On the source side, select Choose.
   

   

3. Select the user and click Use this user.

4. On the destination side, select Choose. 

5. Select the user and click Use this user. 

6. Click Done to save the mapping. The user map is added to the list on the screen. 

7. Repeat these steps for each exception map you need to create. 

Create an Account Map With Exceptions Specified Within the JSON

{
    "name": "{{account_map_name}}",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "exceptions": [
        {
            "source": {
                "email": "{{source_account_email}}",
                "type": "account"
            },
            "destination": {
                "email": "{{destination_account_email}}",
                "type": "account"
            }
        }
    ],
    "type": "account_map"
}

Create an Account Map With Exceptions Imported From a CSV File

To create an account map with exceptions imported from a CSV file

• Create the CSV file following Account Map / Group Map | CSV File Guidelines

• Upload the CSV file to an existing connection or create a new connection to the location of the CSV file

• Be sure to specify the full path of the CSV file, including the extension

{
    "name": "{{account_map_name}}",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "exceptions": {
        "text": {
            "connection": {
                "id": "{{connection_id}}"
            },
            "target": {
                "path": "/Path to Exceptions/Exceptions.csv"
            }
        }
    },
    "type": "account_map"
}

View Account Map Exceptions

View the exceptions within the account map.

GET {{url}}v1/account_maps/{{account_map_id}}/exceptions

Use the offset and limit to view different sections of a large account map.

GET {{url}}v1/account_maps/{{account_map_id}}/exceptions?offset=40000&limit=1000

Import Exceptions Into an Existing Account Map

Exceptions can be added to an existing account map by either appending to the current list of exceptions or overwriting all exceptions with a new list of exceptions.  Also, they can be added by specifying the exceptions in the JSON or importing them from a CSV.  

If importing from a CSV file,

• Create the CSV file following Account Map / Group Map | CSV File Guidelines.

• Upload the CSV file to an existing connection or create a new connection to the location of the CSV file.

• Be sure to specify the full path of the CSV file, including the extension.

Overwrite

{
    "append": false,
    "text": {
        "connection": {
            "id": "{{connection_id}}"
        },
        "target": {
            "path": "/Path to Exceptions/Exceptions.csv"
        }
    }
}

Append

{
  "append": true,
  "items": [
        {
          "source": {
          	"name": "Joe Smith",
            "email": "jsmith@company.com",
            "type": "account"
          },
          "destination": {
          	"name": "suser02",
            "email": "suser02@test.com",
            "type": "account"
          }
        },
        {
          "source": {
          	"name": "Mary Smith",
            "email": "msmith@company.com",
            "type": "account"
          },
          "destination": {
          	"name": "suser03",
            "email": "suser03@test.com",
            "type": "account"
          }
        }
      ]
}

Delete an Exception From an Account Map

DELETE {{url}}v1/account_maps/{{account_map_id}}/exceptions/{{exception_id}}

Group Map

A group map is managed in much the same way as account maps, but must be managed separately.  All above documentation applies to group maps as well, just substitute "group_maps" in the URL for "account_maps" and "group_map" as the type, if the type is required in the JSON.

GET {{url}}v1/group_maps/exceptions

{
    "name": "{{group_map_name}}",
    "type": "group_map",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "exceptions": [
        {
            "source": {
                "name": "{{group_account_email}}",
                "type": "group"
            },
            "destination": {
                "name": "{{group_account_email}}",
                "type": "group"
            }
        }
    ],
    "type": "group_map"
}