SAP Open Connectors

Role-Based Connector Listing

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

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

  • On SAP Open Connectors 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 Connector 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 Connector Safelists - GET/url/organisations/{organisationId}/connectors-safelist - Gets the list of safelisted connectors for the provided organization id.
  2. Update Connector Safelists - PUT/url/organisations/{organisationId}/connectors-safelist - Adds connectors to be safelisted for the provided organization id.
  3. Patch Connector Safelists - PATCH/url/organisations/{organisationId}/connectors-safelist - Adds connectors to connectors saflisted in an organization.
  4. Delete Connector Safelists - DELETE/url/organisations/{organisationId}/connectors-safelist - Deletes connectors from the list of safelisted connectors in an organization.
  5. Delete Connector Safelists by Connector Id - DELETE/url/organisations/{organisationId}/connectors-safelist/{ connector Id} - Deletes the connector corresponding to the connector Id, from the list of safelisted connectors in an organization.

Points to note:

  • SAP Open Connectors also has a feature to add {{snippet.termElementlcPlural} to a Denylist at the super-organization level. This feature is implemented only for whitelabel partners, using which they can make sure an connector is not visible to any of the organizations under the super-organization.
  • If a whitelabel super-organization which contains multiple organizations has added an connector to it denylist at the super-organization level, that connector 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 connector to a denylist when it is already added to a safelist and vice versa.
  • When connectors are added to safelist by an organization, all the accounts and users under the organization will only be able to see the safelisted connectors. Any user who has private connectors 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 connectors from the safelist of an organization, you will need to use the DELETE API and delete the connectors 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.