API Reference
- Switchboard API
- POSTPreview the output of a transformer.
- boards
- hubs
- 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
Put organisations connections
Updates an existing Connection by ID in the current organisation.
curl --request PUT \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections/{connectionId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"data": {
"apiKey": "<string>"
}
}'{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"app": {
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"public": true,
"server": {
"name": "<string>",
"url": "<string>"
},
"schemaMetadata": {
"type": "<string>",
"version": "<string>",
"url": "<string>"
},
"supportedAuthConfigs": [
{
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
],
"imageUrl": "<string>",
"schema": {
"id": "<string>",
"type": "<string>",
"version": "<string>",
"sourceUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"authConfig": {
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
},
"credentialId": "<string>",
"usedByBoards": [
{
"id": "<string>",
"name": "<string>"
}
]
}Authorizations
Body
UpdateConnectionRequestBody is the request body to update an existing connection. This will replace the existing connection details.
Response
Type denotes the type of schema the corresponding App is backed by. Currently the only supported value is "openapi", but other types such as "soap", "graphql" and "grpc" are on the roadmap.
Version denotes the version of the schema specification. This property is contextual based on the schema
type, for example openapi schemas will contain the OpenAPI specification version (currently only 3.0.x is
supported), but grpc APIs could be "proto2" or "proto3".
URL is the private address for accessing the schema. This is not guaranteed to be publicly accessible and could be a non-HTTP protocol (i.e. gs:// or s3://)
Type denotes the type of schema the corresponding App is backed by. Currently the only supported value is "openapi", but other types such as "soap", "graphql" and "grpc" are on the roadmap.
Version denotes the version of the schema specification. This property is contextual based on the schema
type, for example openapi schemas will contain the OpenAPI specification version (currently only 3.0.x is
supported), but grpc APIs could be "proto2" or "proto3".
URL is the private address for accessing the schema. This is not guaranteed to be publicly accessible and could be a non-HTTP protocol (i.e. gs:// or s3://)
SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.
Type denotes the method of authentication. Valid values are: "oidc", "oauth2", "apikey", `"httpBasicAuth"
IsValid is true if and only if the data field is populated with all the required information to enable
an organisation to connect to the App via this auth type. It is allowed for an App to have invalid auth
configs providing there is at least one valid.
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.
AppAuthConfig describes how an organisation can authenticate with an app.
Type denotes the method of authentication. Valid values are: "oidc", "oauth2", "apikey", `"httpBasicAuth"
IsValid is true if and only if the data field is populated with all the required information to enable
an organisation to connect to the App via this auth type. It is allowed for an App to have invalid auth
configs providing there is at least one valid.
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 PUT \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections/{connectionId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"data": {
"apiKey": "<string>"
}
}'{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"app": {
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"public": true,
"server": {
"name": "<string>",
"url": "<string>"
},
"schemaMetadata": {
"type": "<string>",
"version": "<string>",
"url": "<string>"
},
"supportedAuthConfigs": [
{
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
],
"imageUrl": "<string>",
"schema": {
"id": "<string>",
"type": "<string>",
"version": "<string>",
"sourceUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"authConfig": {
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
},
"credentialId": "<string>",
"usedByBoards": [
{
"id": "<string>",
"name": "<string>"
}
]
}