How it works
- Regular mode (single-folder)
- Enabled by default. No setup needed.
- A connection is linked to one folder (selected during connector activation).
- The
folder_idquery parameter is ignored. - All API calls operate on this single folder.
- Multi-folder mode
- Allows a consumer to manage multiple legal entities.
- Each API request MUST include a
folder_idquery parameter to specify the target folder (except for the GET folders endpoint). - This ensures full data segregation and prevents cross-entity issues.
Activation & configuration
To enable multi-folder mode in a connector (if supported):
-
Uncheck the first checkbox, usually labeled “Let the user specify the folder during activation”.
Once unchecked:
- Chift automatically grants the connection access to all folders the end-user has permission to access.
- You fully control folder switching from your interface, rather than relying on Chift to enforce folder restrictions.
-
The second checkbox (if present) is optional and used only by certain connectors (e.g., MyUnisoft) to allow end-users to select folders during activation.
- This selection is purely UI-level; it does not actually restrict access if multi-folder is enabled.
- However, Chift automatically blocks API calls to folders that were not selected.
Important notes
- Not all connectors support multi-folder. Check the connector’s documentation page to confirm compatibility.
- Your implementation must support both modes (single and multi-folder) for full compatibility.
- Additional dev work is required to integrate multi-folder support.