List Hub Connectors

GET

integrations

{integration_id}

connection-templates

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/integrations/{integration_id}/connection-templates

{
  "totalCount": 123,
  "next": "<string>",
  "prev": "<string>",
  "connectionTemplates": [
    {
      "id": "<string>",
      "connectorId": "<string>",
      "imageUrl": "<string>",
      "name": "<string>",
      "isUsed": true,
      "isPrimary": true,
      "authSchemeConfig": {
        "id": "<string>",
        "description": "<string>",
        "validationMessages": [
          {
            "text": "<string>",
            "severity": "info",
            "detail": [
              "<string>"
            ]
          }
        ],
        "schemeType": "<string>"
      }
    }
  ]
}

Path Parameters

integration_id

string

required

Query Parameters

first

integer

default:20

after

string

before

string

Response

200

application/json

HubConnectionTemplatePage is a paginated list of Hub Connection Templates.

totalCount

integer

required

connectionTemplates

object[]

required

A Hub Connection Template is a lightweight wrapper around a Connector from Connect API, but includes additional information to make embedding the integration simpler.

Versori-users do not need to establish connections in an integration. These are connected to by end-users when they activate the integration from the embedded integration hub.

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.

string

Delete an integration.Create a Hub Connector

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/integrations/{integration_id}/connection-templates

{
  "totalCount": 123,
  "next": "<string>",
  "prev": "<string>",
  "connectionTemplates": [
    {
      "id": "<string>",
      "connectorId": "<string>",
      "imageUrl": "<string>",
      "name": "<string>",
      "isUsed": true,
      "isPrimary": true,
      "authSchemeConfig": {
        "id": "<string>",
        "description": "<string>",
        "validationMessages": [
          {
            "text": "<string>",
            "severity": "info",
            "detail": [
              "<string>"
            ]
          }
        ],
        "schemeType": "<string>"
      }
    }
  ]
}

API Reference

Connect API

Embedded API

Organisations API

Proxy API

Path Parameters

Query Parameters

Response