API Reference

Switchboard API

POST
Preview the output of a transformer.
boards
hubs
data-mappings
apps
operations
schemas
GET
Get organisations schema utils signed url
POST
Post organisations schema utils source url
POST
Post organisations schema utils info
connections
credentials
GET
Get organisations signed url

Connect API

apps

Post organisations apps

Create a new App for the provided organisation

POST

organisations

{organisationId}

apps

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

organisationId

string

organisationId

Required

string

object

name

string

name

Required

string

public

boolean

public

Required

boolean

server

object

server

Required

object

name

string

name

Required

string

Description is a human-friendly name for this server address. If a friendly name isn't available then this defaults to the URL.

url

string

url

Required

string

URL is the server address listening for requests.

authConfigs

array

authConfigs

Required

array

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

imageUrl

string

imageUrl

string

schemaId

string

schemaId

Required

string

The ID of the Schema instance.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organisationId

string

required

Body

application/json

name

string

required

public

boolean

required

server

object

required

server.name

string

required

Description is a human-friendly name for this server address. If a friendly name isn't available then this defaults to the URL.

server.url

string

required

URL is the server address listening for requests.

authConfigs

object[]

required

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

authConfigs.type

string

required

Type denotes the method of authentication. Valid values are: "oidc", "oauth2" or "apikey".

authConfigs.data

object

required

AppAuthConfigData should JSON-marshal to one of the types specified in the jsonschema oneOf:

AppAuthConfigOIDC
AppAuthConfigOAuth2
AppAuthConfigApiKey
AppAuthConfigHTTPRefresh
AppAuthConfigHTTPBasicAuth

authConfigs.data.discoveryUrl

string

Takes precedent over the endpoint properties. If this property is set, it will be queried and override any defined endpoint properties.

authConfigs.data.clientId

string

authConfigs.data.clientSecret

string

ClientSecret is the OAuth2.0 client's secret. This should be write-only, and not be viewable after creation.

authConfigs.data.scopes

object

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.

imageUrl

string

schemaId

string

required

The ID of the Schema instance.

Response

200 - application/json

string

required

orgId

string

required

name

string

required

public

boolean

required

server

object

required

server.name

string

required

Description is a human-friendly name for this server address. If a friendly name isn't available then this defaults to the URL.

server.url

string

required

URL is the server address listening for requests.

schemaMetadata

object

required

schemaMetadata.type

string

required

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.

schemaMetadata.version

string

required

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

schemaMetadata.url

string

required

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

object[]

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.

supportedAuthConfigs.type

string

required

Type denotes the method of authentication. Valid values are: "oidc", "oauth2", "apikey", `"httpBasicAuth"

supportedAuthConfigs.isValid

boolean

required

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.

supportedAuthConfigs.data

object

required

AppAuthConfigData should JSON-marshal to one of the types specified in the jsonschema oneOf:

AppAuthConfigOIDC
AppAuthConfigOAuth2
AppAuthConfigApiKey
AppAuthConfigHTTPRefresh
AppAuthConfigHTTPBasicAuth

supportedAuthConfigs.data.discoveryUrl

string

Takes precedent over the endpoint properties. If this property is set, it will be queried and override any defined endpoint properties.

supportedAuthConfigs.data.clientId

string

supportedAuthConfigs.data.clientSecret

string

ClientSecret is the OAuth2.0 client's secret. This should be write-only, and not be viewable after creation.

supportedAuthConfigs.data.scopes

object

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.

imageUrl

string

schema

object

required

schema.id

string

required

schema.type

string

required

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.

schema.version

string

required

schema.sourceUrl

string

required

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://)

schema.createdAt

string

required

schema.updatedAt

string

required

schema.deletedAt

string

schemaId

string

createdAt

string

required

updatedAt

string

required

deletedAt

string

Get organisations apps Put organisations apps