Upsert Auth Scheme Config to Connector

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.credentials.action

object[]

connections.credentials.action.id

string

required

connections.credentials.action.authSchemeConfig

object

required

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.

connections.credentials.action.credential

object

required

CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.

connections.credentials.action.credential.id

string

required

ID is the unique identifier of the Credential.

connections.credentials.action.credential.organisationId

string

required

OrganisationID is the unique identifier of the Organisation which owns the Credential.

connections.credentials.action.credential.type

enum<string>

required

CredentialType denotes the type of the credential which determines what the Credential's data property will contain.

none: No credential is required to authenticate with the Connector.
string: The credential is a string value, such as an API key or password.
binary: The credential is a binary value, such as a private key, certificate or other file.
basic-auth: The credential is a username and password to be used for basic authentication.
oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.
oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.
oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
custom-function: The credential is a custom function which will be called to authenticate with the Connector.
jwt-bearer: The credential is the JWT setup values to be used for generating a bearer token.
certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.

Available options:

none,

string,

binary,

basic-auth,

oauth2-client,

oauth2-code,

oauth2-password,

oauth2-token,

custom-function,

certificate,

jwt-bearer

connections.credentials.action.credential.name

string

required

Name is the name of the Credential.

connections.credentials.action.credential.data

object

required

CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.

connections.credentials.action.credential.usages

object[]

CredentialUsages is a list of references to the Connectors which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connectors.

connections.credentials.action.credential.errors

string[]

Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.

connections.credentials.action.credential.expiresAt

string

ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe to deletion events and if the reason is "expired", can trigger the correct notifications to interested parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).

connections.credentials.trigger

object[]

connections.credentials.trigger.id

string

required

connections.credentials.trigger.authSchemeConfig

object

required

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.

connections.credentials.trigger.credential

object

required

CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.

connections.credentials.trigger.credential.id

string

required

ID is the unique identifier of the Credential.

connections.credentials.trigger.credential.organisationId

string

required

OrganisationID is the unique identifier of the Organisation which owns the Credential.

connections.credentials.trigger.credential.type

enum<string>

required

CredentialType denotes the type of the credential which determines what the Credential's data property will contain.

none: No credential is required to authenticate with the Connector.
string: The credential is a string value, such as an API key or password.
binary: The credential is a binary value, such as a private key, certificate or other file.
basic-auth: The credential is a username and password to be used for basic authentication.
oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.
oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.
oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
custom-function: The credential is a custom function which will be called to authenticate with the Connector.
jwt-bearer: The credential is the JWT setup values to be used for generating a bearer token.
certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.

Available options:

none,

string,

binary,

basic-auth,

oauth2-client,

oauth2-code,

oauth2-password,

oauth2-token,

custom-function,

certificate,

jwt-bearer

connections.credentials.trigger.credential.name

string

required

Name is the name of the Credential.

connections.credentials.trigger.credential.data

object

required

CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.

connections.credentials.trigger.credential.usages

object[]

CredentialUsages is a list of references to the Connectors which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connectors.

connections.credentials.trigger.credential.errors

string[]

Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.

connections.credentials.trigger.credential.expiresAt

string

ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe to deletion events and if the reason is "expired", can trigger the correct notifications to interested parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).

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

API Reference

Connect API

Embedded API

Organisations API

Proxy API

Authorizations

Path Parameters

Body

Response