Role-Based Adapter Listing

The Role Based Adapter Listing feature provides the ability for users to control listing adapters at organizational level; that is, the ability to control what adapters at organization level can be viewed by all the accounts and users under an organization.

To list adapters of your preference, you need to enable the Manage Adapter Org Lists privilege. You require this privilege to add, update and delete adapters for listing adapters as per your requirements. 

  • On Sugar Integrate UI, click the Security option on the navigational panel to your left.
  • Switch to the Roles tab on the console that opens.
  • Ensure that the Manage Adapter Org Lists privilege is enabled.

This privilege is enabled for Organization Administrators by default. Organization administrators can use the listing APIs without having to explicitly enable this privilege as mentioned above. 

This feature makes use of the following APIs:

  1. Get Adapter Safelists - GET/url/organisations/{organisationId}/adapters-safelist - Gets the list of safelisted adapters for the provided organization id.
  2. Update Adapter Safelists - PUT/url/organisations/{organisationId}/adapters-safelist - Adds adapters to be safelisted for the provided organization id.
  3. Patch Adapter Safelists - PATCH/url/organisations/{organisationId}/adapters-safelist - Adds adapters to adapters saflisted in an organization.
  4. Delete Adapter Safelists - DELETE/url/organisations/{organisationId}/adapters-safelist - Deletes adapters from the list of safelisted adapters in an organization.
  5. Delete Adapter Safelists by Adapter Id - DELETE/url/organisations/{organisationId}/adapters-safelist/{ adapter Id} - Deletes the adapter corresponding to the adapter Id, from the list of safelisted adapters in an organization.

Points to note:

  • Sugar Integrate also has a feature to add {{snippet.termElementlcPlural} to a Denylist at the super-organization level. This feature is implemented only for white-label partners, using which they can make sure an adapter is not visible to any of the organizations under the super-organization.
  • If a white-label super-organization which contains multiple organizations has added an adapter to it denylist at the super-organization level, that adapter cannot be safelisted for any of its organizations. Both the safelist and denylist are mutually exclusive to each other for a given organization. An error message appears when you try adding an adapter to a denylist when it is already added to a safelist and vice versa.
  • When adapters are added to safelist by an organization, all the accounts and users under the organization will only be able to see the safelisted adapters. Any user who has private adapters in an organization, will not see them.
  • This privilege is enabled by default for an organization administrator and can be enabled for other roles by enabling the configure_roles privilege. Hence this feature is not tied to any particular role and is at the discretion of the organization administrator.
  • To remove adapters from the safelist of an organization, you will need to use the DELETE API and delete the adapters from the safelist. The privilege does not directly impact the behaviour of this functionality, so enabling or disabling the privilege would not change what is on the list.