Put organisations connections - Versori User Documentation

Authorizations

Authorization

string

headerrequired

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

Path Parameters

organisationId

string

required

connectionId

string

required

Body

application/json

name

string

required

data

object

required

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

data.apiKey

string

required

Response

200 - application/json

string

required

orgId

string

required

name

string

required

app

object

required

app.id

string

required

app.orgId

string

required

app.name

string

required

app.public

boolean

required

app.server

object

required

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

app.server.url

string

required

URL is the server address listening for requests.

app.schemaMetadata

object

required

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

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

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

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.

app.supportedAuthConfigs.type

string

required

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

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

app.supportedAuthConfigs.data

object

required

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

AppAuthConfigOIDC
AppAuthConfigOAuth2
AppAuthConfigApiKey
AppAuthConfigHTTPRefresh
AppAuthConfigHTTPBasicAuth

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

app.supportedAuthConfigs.data.clientId

string

app.supportedAuthConfigs.data.clientSecret

string

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

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

app.imageUrl

string

app.schema

object

required

app.schema.id

string

required

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

app.schema.version

string

required

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

app.schema.createdAt

string

required

app.schema.updatedAt

string

required

app.schema.deletedAt

string

app.schemaId

string

app.createdAt

string

required

app.updatedAt

string

required

app.deletedAt

string

authConfig

object

AppAuthConfig describes how an organisation can authenticate with an app.

authConfig.type

string

required

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

authConfig.isValid

boolean

required

authConfig.data

object

required

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

AppAuthConfigOIDC
AppAuthConfigOAuth2
AppAuthConfigApiKey
AppAuthConfigHTTPRefresh
AppAuthConfigHTTPBasicAuth

authConfig.data.discoveryUrl

string

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

authConfig.data.clientId

string

authConfig.data.clientSecret

string

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

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

credentialId

string

required

usedByBoards

object[]

usedByBoards.id

string

usedByBoards.name

string

API Reference

Authorizations

Path Parameters

Body

Response