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.
Authorizations
Path Parameters
Body
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.
ConnectionDataAPIKey is the data element of a connection which is using an apikey authentication type.
Response
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.
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