connections
Post organisations connections
Creates a connection between an organisation and an App. This is to be used by authentication methods which the user can explicitly configure, such as API Key and Basic Auth. For OAuth2/OIDC connections, users should call the InitialiseConnection endpoint instead.
POST
/
organisations
/
{organisationId}
/
connections
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
organisationId
string
requiredBody
application/json
name
string
requiredappId
string
requiredauthType
string
requireddata
object
requiredConnectionDataAPIKey is the data element of a connection which is using an apikey authentication type.
Response
201 - application/json
id
string
requiredorgId
string
requiredname
string
requiredapp
object
requiredauthConfig
object
AppAuthConfig describes how an organisation can authenticate with an app.
credentialId
string
requiredusedByBoards
object[]