All Collections
Features
Common Model and Field Scopes
Common Model and Field Scopes

Control which Common Models and fields you sync in your Merge app

Abe Chen avatar
Written by Abe Chen
Updated over a week ago

This feature is available to customers on our Professional, and Enterprise plans.

Introduction

Data security is a top priority at Merge, and we know it is for you too! Scopes allows for precise control over data permissions, ensuring that only relevant Common Models and fields are synced through Merge.


Below, you’ll find features and endpoints related to two levels of Scopes.

  • Default Scopes apply to all new Linked Accounts for a given category

  • Linked Account Scopes apply only to a specific end user (Linked Account). Disabling a Common Model Scope will also disable all of its associated fields.

The Scopes applied to a Linked Account are first determined by the Linked Account Scopes, and fall back to Default Scopes for any that haven’t been set.

How do I check what data is passed through Merge?

You can check the Scopes tab in your Merge Dashboard to see the various access levels per Common Model and field. Optional models and fields are enabled by default but are able to be disabled by your users in the initial linking flow.

How can I control what data is passed through Merge?

[COMING SOON] If you want to adjust the Scopes for a model or field, first switch the blue toggle on the top right from "Viewing" to "Editing". Disabling a Common Model or field means that Merge will no longer store that data to our database.

You will also be given the choice to either redact historical data that has already been stored in Merge or only apply the disabled toggle to future data syncs.

What if my users require different levels of access?

You can also enable Scopes functionality with our prebuilt Dashboard and Link UI. To allow your users to choose their set of scopes in the Merge Linking flow, you can mark a Common Model or field as "Optional" in your Dashboard. You can retroactively adjust your users' Scopes setting under their Linked Account -> Data Tab.

New Linked Accounts will follow the default Scopes set per category unless you explicitly override those preferences on a per Linked Account basis. Once you override a Linked Account Scopes it will be fixed unless you "reset to org default".

New Linked Accounts will follow the default Scopes set per category unless you explicitly override those preferences on a per Linked Account basis. Once you override a Linked Account Scopes it will be fixed unless you "reset to org default".

Enterprise Plan Scopes Features

The following Scopes features - Scopes via API and User Configurable Scopes are only available on an Enterprise plan.

User Configurable Scopes

[COMING SOON] To give your users control over their Scopes during the linking flow simply mark the model or field as optional in Dashboard. Models and fields that are marked as optional will be enabled by default but able to be disabled by your users prior to connecting.

Can I control data access programatically?

Yes! You can configure Scopes programatically with our API. You can configure Scopes programmatically for a specific user before or after they link. See our API documentation to learn more.

  1. Before Linking: POST /link-token

Did this answer your question?