POST
/
organisations
/
{organisationId}
/
connection-init

Authorizations

Authorization
string
headerrequired

Path Parameters

organisationId
string
required

Body

application/json
appId
string
required
authType
string
required

Response

200 - application/json
action
object
required
action.redirect
object

InitConnectionActionRedirect tells the user agent to redirect to the provided URL to complete the connection. This is most likely to perform an OAuth2.0 authorization code grant, but there may be other protocols in the future. In the case of an OAuth2.0 flow, the redirect URL will be back to switchboard to complete the connection process, this will be transparent to the user.

action.form
object

InitConnectionActionForm tells the user agent to render a form requesting additional information from the user such as api-key or basic-auth credentials.