List End User Integrations
ListEndUserIntegrations returns all integrations which are available to the given End User.
This API should be used to populate the embedded UI with the integrations that the end user can activate.
If the user_id is referencing the external ID of the user, then the hub query parameter is required in order
to identify the correct Hub to retrieve the integrations from.
Path Parameters
UserID references an End User in the Hub.
Most APIs support setting this value to either the internal Versori identifier or their external ID as
determined by the organisation. The identifier_type query parameter is used to indicate which type of ID is
being used.
Query Parameters
IdentifierType indicates whether the user_id path parameter is a internal identifier created by Versori, or an
external identifier. If the value is external, some endpoints also require the hub query parameter to
identify the correct Hub.
internal, external Deployed allowing filtering integrations to only return either deployed (true) or not deployed (false)
integrations.
If not set, all integrations are returned.
Response
EndUserIntegrationPage is a paginated list of integrations to be displayed to the user when embedding the integration hub.
Name is a short name for the integration, this is typically the name of the Connector being integrated to.
ImageURL is a URL to an image/icon that represents the integration. This image is used within the integration tile displayed in the embedded UI.
Description can be used to provide a longer description of the integration. This can be shown to end users in the embedded integration hub UI.
VariablesSchema is the JSON schema for the variables defined for this integration.
IsDeployed indicates whether the integration is deployed and available to end users. If not deployed, the integration cannot be activated.
IsActivated indicates whether the integration is activated for the end user. If the integration is not activated, the user can activate it from the embedded integration hub.
TotalConnected is the total number of integrations that are connected for the end user. This can be used to display a badge on the embedded integration hub to show the user how many integrations they have connected.