PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
auth-scheme-configs
/
{auth_scheme_config_id}

Authorizations

Authorization
string
headerrequired

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

organisation_id
string
required
connector_id
string
required

ID is the unique identifier of the Connector.

auth_scheme_config_id
string
required

Body

application/json

AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.

id
string
required

ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.

description
string
required

Description enables users to distinguish multiple configurations which use the same schemeType.

schemeType
string
required
Allowed value: "none"
validationMessages
object[]

ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.

This field will be ignored if sent to the API.

validationMessages.text
string
required

Text contains the text of the message.

validationMessages.severity
enum<string>
required
Available options:
info,
warning,
error
validationMessages.detail
string[]

Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.

Response

200 - application/json

Connector represents a connector to an external system.

id
string
required

ID is the unique identifier of the Connector.

organisationId
string
required

OrganisationID is the unique identifier of the Organisation that owns the Connector.

name
string
required

Name is the user-provided name of the Connector

public
boolean
required
protocol
enum<string>
required

ProtocolType denotes the set of all valid connector types.

Available options:
http,
bigquery
authSchemeConfigs
object[]
required
authSchemeConfigs.id
string
required

ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.

authSchemeConfigs.description
string
required

Description enables users to distinguish multiple configurations which use the same schemeType.

authSchemeConfigs.validationMessages
object[]

ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.

This field will be ignored if sent to the API.

authSchemeConfigs.schemeType
string
required
Allowed value: "none"
connections
object[]
required

Connections is a list of all the connections this Connector has.

connections.id
string
required

ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all) public-facing APIs will use the name in combination with the Connector's id instead.

connections.name
string
required

Name is the name of the Connection. This must be unique within the owning Connector.

connections.credentials
object
required

ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.

connections.variables
object[]
required
connections.createdAt
string
required

CreatedAt is the time the Connection was created.

connections.updatedAt
string
required

UpdatedAt is the time the Connection was last updated.

versions
object[]
required

Versions is a list of all the versions this Connector has.

versions.id
string
required

ID is the unique identifier of the ConnectorVersion, this is typically only used internally and the version name is used externally in combination with the Connector id.

versions.name
string
required

Name denotes the actual version value for the Connector. This can be any value but a consistent naming strategy is recommended, such as SemVer, CalVer or an incrementing number. The names "default" and "latest" are reserved words and cannot be used.

versions.description
string

Description allows specifying additional information about the ConnectorVersion, such as what changed since the last version etc.

versions.isLatest
boolean
required

IsLatest denotes whether this is the latest version of the Connector.

versions.isDefault
boolean
required

IsDefault denotes whether this is the default version of the Connector.

versions.createdAt
string
required

CreatedAt is the time at which the ConnectorVersion was created.

versions.updatedAt
string
required

UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.

versions.publishedAt
string | null
required

PublishedAt is the time at which the ConnectorVersion was published.

versions.messages
object[]
createdAt
string
required

CreatedAt is the time at which the ConnectorVersion was created.

updatedAt
string
required

UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.

baseUrl
string
required

BaseURL is the base URL of all HTTP Actions within the Connector.

documentationURL
string

Hold an optional link to the documentation for the API.

imageURL
string

The URL for the icon for the connector

tags
object
connectionVariables
object[]

Connection Variables is a list of default variables initialised in every connector connection.

connectionVariables.name
string
required

Name is the name of the connection variable.

connectionVariables.value
string
required

Value is the value of the connection variable.