API Reference
- Switchboard API
- POSTPreview the output of a transformer.
- boards
- hubs
- GETGet organisations hubs
- POSTPost organisations hubs
- PUTPut organisations hubs
- DELDelete organisations hubs
- GETGet organisations hubs boards
- POSTPost organisations hubs boards
- GETGet organisations hubs boards integration info
- GETGet organisations hubs users
- GETGet organisations hubs boards users
- POSTPost organisations hubs boards users
- DELDelete organisations hubs boards users
- GET
- data-mappings
- apps
- operations
- schemas
- GETGet organisations schema utils signed url
- POSTPost organisations schema utils source url
- POSTPost organisations schema utils info
- connections
- credentials
- GETGet organisations signed url
- POST
Get organisations hubs boards integration info
Retrieves all the information needed that a user needs to fill out to use a Hub integration.
curl --request GET \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/hubs/{hubId}/boards/{boardId}/integration-info \
--header 'Authorization: <api-key>'
{
"connections": [
{
"id": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"requiresUserAuth": true,
"authConfig": {
"authType": "oidc",
"connectionId": "<string>",
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
}
],
"listeners": [
{
"url": "<string>",
"appName": "<string>",
"appId": "<string>",
"nodeId": "<string>"
}
],
"variables": {}
}
Authorizations
Query Parameters
The showPrivate query parameter will make the endpoint show all dynamic connections, event if they are private dynamic connections.
Response
RequiresUserAuth is true if the app requires the user of the integration to authenticate with the app before it can be used. Apps that have this set to true, should be the only ones shown in the client's UI. The other apps are only really returned due to the possibility of them having a listener URL which the user may need to configure webhooks with.
oidc
, oauth2
, apikey
, httpBasicAuth
, jwtbearer
, httprefresh
AppAuthConfigData should JSON-marshal to one of the types specified in the jsonschema oneOf:
- AppAuthConfigOIDC
- AppAuthConfigOAuth2
- AppAuthConfigApiKey
- AppAuthConfigHTTPRefresh
- AppAuthConfigHTTPBasicAuth
- AppAuthConfigJWTBearer
- AppAuthConfigCustomFunction
Takes precedent over the endpoint properties. If this property is set, it will be queried and override any defined endpoint properties.
ClientSecret is the OAuth2.0 client's secret. This should be write-only, and not be viewable after creation.
Scopes is a map of scopes this API supports, with the scope name as keys and a description as the value. It may not be required to specify them all to connect the App.
curl --request GET \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/hubs/{hubId}/boards/{boardId}/integration-info \
--header 'Authorization: <api-key>'
{
"connections": [
{
"id": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"requiresUserAuth": true,
"authConfig": {
"authType": "oidc",
"connectionId": "<string>",
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
}
],
"listeners": [
{
"url": "<string>",
"appName": "<string>",
"appId": "<string>",
"nodeId": "<string>"
}
],
"variables": {}
}