...

Image Removed

...

On This Page

Overview

An account or group map exclusion provides the ability to explicitly exclude an account or group from owner or permissions preservation.  Account or group map exclusions can be defined during the creation of the map or can be imported from a comma-separated values (CSV) file.  

Image Added

Importing an Exclusion 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 source exclusions.

4. The Import source user exclusions 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. 
   

   Image Added

   
   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.
   

   Image Added

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

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

Creating an Exclusion Through the UI

1. Click More Options and select Create source exclusion or Create destination exclusion depending on the location of the user/group you want to exclude.

2. A field displays under the connection you selected.
   

   Image Added

3. Select Choose.

4. Select the user and click Use this user.

5. Click Done to save the exclusion. The user/group is added to the list on the screen. 

6. Repeat these steps for each exclusion you need to add. 

...

Creating an Account Map with Exclusions Through the API

Exclusions can be specified while creating an account map or can be added after the account map has been created.

Create an Account Map with Exclusions Specified Within the JSON

{
    "name": "{{account_map_name}}",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        },
        "exclusions": [
            {
                "sid": {
                    "name": "Joe Smith",
                    "email": "jsmith@company.com",
                    "type": "account"
                }
            },
            {
                "sid": {
                    "name": "Mary Smith",
                    "email": "msmith@company.com",
                    "type": "account"
                }
            }
        ]
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "type": "account_map"
}

Create an Account Map With Exclusions Imported From a CSV File Located on a Connection

To create an account map with exceptions imported from a CSV file located on the source platform,

• 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}}"
        },
        "exclusions": {
            "text": {
                "connection": {
                    "id": "{{connection_id}}"
                },
                "target": {
                    "path": "/Path to Exclusions/Exclusions.csv"
                }
            }
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    }
    "type": "account_map"
}

View Account Map Exclusions

View all the exclusions within the account map.

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

View only the source exclusions.

GET {{url}}v1/account_maps/{{account_map_id}}/exclusions/source

View only the destination exclusions.

GET {{url}}v1/account_maps/{{account_map_id}}/exclusions/destination

Use the offset and limit to view different sections of a large number of exclusions.

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

Import Exclusions Into an Existing Account Map

Exclusions can be added to an existing account map by either appending to the current list of exclusions or overwriting all exclusions with a new list of exclusions.  Also, they can be added by specifying the exclusion 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 Exclusions/Exclusions.csv"
        }
    }
}

Append

{
    "append": true,
    "items": [
        {
          "sid": {
          	"name": "Joe Smith",
            "email": "jsmith@company.com",
            "type": "account"
          }
        },
        {
          "sid": {
          	"name": "Mary Smith",
            "email": "msmith@company.com",
            "type": "account"
          }
        }
      ]
}

Delete an Exclusion From an Account Map

DELETE {{url}}v1/account_maps/{{account_map_id}}/exclusions/{{exclusion_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/exclusions

{
    "name": "{{group_map_name}}",
    "type": "group_map",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        },
        "exclusions": [
            {
                "sid": {
                    "name": "group1",
                    "type": "group"
                }
            },
            {
                "sid": {
                    "name": "group2",
                    "type": "group"
                }
            }
        ]
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "type": "group_map"
}