GET
/
embed
/
{hub_id}
/
users
/
{user_id}
/
integrations
/
{integration_id}

Path Parameters

​
hub_id
string
required
​
user_id
string
required

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.

​
integration_id
string
required

Query Parameters

​
identifier_type
enum<string>
default: external

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.

Available options:
internal,
external

Response

200 - application/json

EmbeddedIntegration represents an integration that is available to an end user and contains all the necessary information for the UI to determine how the user should activate the integration.

​
id
string
required

ID is the unique identifier for the Integration

​
name
string
required

Name is a short name for the integration, this is typically the name of the Connector being integrated to.

​
imageUrl
string
required

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
string
required

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.

​
isDeployed
boolean
required

IsDeployed indicates whether the integration is deployed and available to end users. If not deployed, the integration cannot be activated.

​
isActivated
boolean
required

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.

​
connectionTemplates
object[]
required

ConnectionTemplates is a list of connections that the end user can authenticate to when activating the integration.

​
connectionTemplates.id
string
required

ID is the unique identifier of the Hub Connection Template.

​
connectionTemplates.connectorId
string
required

ConnectorID is the unique identifier of the Connector.

​
connectionTemplates.imageUrl
string
required

ImageURL is a URL to an image/icon that represents the connector. This image is used within the integration tile displayed in the embedded UI.

​
connectionTemplates.name
string
required

name denotes the name of the Connector that the template is wrapping.

​
connectionTemplates.isUsed
boolean
required

IsUsed indicates that this connection template is in use by the hub.

​
connectionTemplates.isPrimary
boolean
required

IsPrimary indicates that this is the primary connections on the hub.

​
connectionTemplates.authSchemeConfig
object
required

AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.

​
variablesSchema
object

VariablesSchema is the JSON schema for the variables defined for this integration.

List End User IntegrationsList End User Activations