curl --request GET \
--url https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"description": "<string>",
"isDeployed": true,
"isActivated": true,
"connectionTemplates": [
{
"id": "<string>",
"connectorId": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"isUsed": true,
"isPrimary": true,
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
}
],
"variablesSchema": {}
}Retrieve an Embedded Integration
GetEmbeddedIntegration returns the Integration for the given ID to be displayed to the user in the embedded UI.
curl --request GET \
--url https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"description": "<string>",
"isDeployed": true,
"isActivated": true,
"connectionTemplates": [
{
"id": "<string>",
"connectorId": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"isUsed": true,
"isPrimary": true,
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
}
],
"variablesSchema": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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 Response
OK
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 is the unique identifier for the Integration
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.
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.
ConnectionTemplates is a list of connections that the end user can authenticate to when activating the integration.
Show child attributes
Show child attributes
ID is the unique identifier of the Hub Connection Template.
ConnectorID is the unique identifier of the Connector.
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.
name denotes the name of the Connector that the template is wrapping.
IsUsed indicates that this connection template is in use by the hub.
IsPrimary indicates that this is the primary connections on the hub.
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.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.
Description enables users to distinguish multiple configurations which use the same schemeType.
"none"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.
This field will be ignored if sent to the API.
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.
VariablesSchema is the JSON schema for the variables defined for this integration.