Create a new Hub

POST

hubs

curl --request POST \
  --url https://platform.versori.com/api/embedded/v1/hubs \
  --header 'Content-Type: application/json' \
  --data '{
  "organisationId": "<string>",
  "name": "<string>",
  "primaryConnectorId": "<string>",
  "authSchemeConfig": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "schemeType": "<string>"
  }
}'

{
  "id": "<string>",
  "name": "<string>",
  "primaryConnector": {
    "connectorId": "<string>",
    "name": "<string>",
    "authSchemeConfig": {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ],
      "schemeType": "<string>"
    },
    "imageUrl": "<string>",
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "isDefault": true
}

Body

application/json

CreateHubRequest is the payload to create a new Hub.

organisationId

string

required

The ID of the organisation that the Hub belongs to

name

string

required

The name of the Hub

primaryConnectorId

string

required

PrimaryConnectorID references the Connector that the Hub will be built around.

authSchemeConfig

object

required

AuthSchemeConfig defines how your End Users should authenticate to the primary connector.

This is used to drive the front-end experience for the end user, however any authentication scheme config can be used when connecting to a connector over the API.

Response

201

application/json

Created

A Hub description

string

required

The ID of the Hub

name

string

required

The name of the Hub

primaryConnector

object

required

PrimaryConnector is the connector that the Hub is built around.

primaryConnector.connectorId

string

required

ID is the unique identifier of the Hub Connector.

primaryConnector.name

string

required

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

primaryConnector.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.

primaryConnector.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.

primaryConnector.variables

object[]

required

Variables is a list of Name and Value pairs that are scoped to each connection. These variables can be used to mutate the URL of the connector. For example if End Users connect to a service and each user has their own instance of that service which is hosted at a different URL, the user can provide the URL as a variable.

isDefault

boolean

required

IsDefault indicates whether this Hub is the default Hub for the organisation. Only one Hub can be the default Hub for an organisation.

List Hubs Retrieve a Hub

curl --request POST \
  --url https://platform.versori.com/api/embedded/v1/hubs \
  --header 'Content-Type: application/json' \
  --data '{
  "organisationId": "<string>",
  "name": "<string>",
  "primaryConnectorId": "<string>",
  "authSchemeConfig": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "schemeType": "<string>"
  }
}'

{
  "id": "<string>",
  "name": "<string>",
  "primaryConnector": {
    "connectorId": "<string>",
    "name": "<string>",
    "authSchemeConfig": {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ],
      "schemeType": "<string>"
    },
    "imageUrl": "<string>",
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "isDefault": true
}

API Reference

Connect API

Embedded API

Organisations API

Proxy API

Body

Response