POST
/
organisations
/
{organisationId}
/
connections

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required

Body

application/json

CreateConnectionRequestBody is the request body to create a new connection. The ID is automatically generated and the organisation ID is defined by the request's path parameter.

​
appId
string
required
​
authType
string
required
​
data
object
required

ConnectionDataAPIKey is the data element of a connection which is using an apikey authentication type.

​
data.apiKey
string
required
​
name
string
required

Response

201 - application/json
​
app
object
required
​
app.createdAt
string
required
​
app.id
string
required
​
app.name
string
required
​
app.orgId
string
required
​
app.public
boolean
required
​
app.schema
object
required
​
app.schemaMetadata
object
required
​
app.server
object
required
​
app.updatedAt
string
required
​
app.deletedAt
string
​
app.imageUrl
string
​
app.schemaId
string
​
app.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.

​
credentialId
string
required
​
id
string
required
​
name
string
required
​
orgId
string
required
​
authConfig
object

AppAuthConfig describes how an organisation can authenticate with an app.

​
authConfig.data
object
required

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

  • AppAuthConfigOIDC
  • AppAuthConfigOAuth2
  • AppAuthConfigApiKey
  • AppAuthConfigHTTPRefresh
  • AppAuthConfigHTTPBasicAuth
  • AppAuthConfigJWTBearer
  • AppAuthConfigCustomFunction
​
authConfig.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.

​
authConfig.type
string
required

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

​
usedByBoards
object[]
​
usedByBoards.id
string
​
usedByBoards.name
string
Get organisations connectionsPut organisations connections