Exclusions

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.  

Important CSV Template Information

If you receive an error when importing a CSV file, the file does not meet the expected format. You will need to edit the file before attempting to import it again. Please see Account Map / Group Map | CSV File Guidelines for map templates and sample downloads. 

User & Group Map Exclusions

A user or group map exclusion provides the ability to explicitly exclude an account or group from owner or permissions preservation.  User 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.  

Create an account map with exclusions

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

POST {{url}}v1/account_maps

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

Create an account map with exclusions 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


POST {{url}}v1/account_maps

{
    "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.  

After modifying an existing account map list of exclusions, DataHub will not go back and remap content already transferred. However, the updated account map will be used for future operations.

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

POST url/v1/account_maps/account_map_id/exclusions/source

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

Append

POST url/v1/account_maps/account_map_id/exceptions

{
    "append": true,
    "items": [
        {
          "sid": {
            "name": "Joe Smith",
            "email": "jsmith@DataHub.com",
            "type": "account"
          }
        },
        {
          "sid": {
            "name": "Mary Smith",
            "email": "msmith@DataHub.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


POST {{url}}v1/group_maps

{
    "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"
}

Related Links