API Reference
Connect API
- Introduction
- Endpoints
Embedded API
- Introduction
- Endpoints
- Hubs
- End Users
- Connections
- Integrations
- Connectors
- Embed
- Activations
- Miscellaneous
Organisations API
- Overview
- Signing Keys
Retrieve a Hub
GetHub returns the Hub for the given ID.
curl --request GET \
--url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}{
"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
}Path Parameters
Response
A Hub description
The ID of the Hub
The name of the Hub
PrimaryConnector is the connector that the Hub is built around.
ID is the unique identifier of the Hub Connector.
name denotes the name of the Connector that the template is wrapping.
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.
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.
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.
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.
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 indicates whether this Hub is the default Hub for the organisation. Only one Hub can be the default Hub for an organisation.
curl --request GET \
--url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}{
"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
}