PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
auth-scheme-configs
/
{auth_scheme_config_id}
Upsert Auth Scheme Config to Connector
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "description": "<string>",
  "validationMessages": [
    {
      "text": "<string>",
      "severity": "info",
      "detail": [
        "<string>"
      ]
    }
  ],
  "schemeType": "<string>"
}'
{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        {
          "text": "<any>",
          "severity": "<any>",
          "detail": "<any>"
        }
      ],
      "schemeType": "<string>"
    }
  ],
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          "<any>"
        ],
        "trigger": [
          "<any>"
        ]
      },
      "variables": [
        {
          "name": "<any>",
          "value": "<any>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "versions": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "text": "<any>",
          "severity": "<any>",
          "detail": "<any>"
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "baseUrl": "<string>"
}

Authorizations

Authorization
string
header
required

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<ulid>
required
connector_id
string<ulid>
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.

AuthSchemeConfigNone is a placeholder object with the schemeType set to none. There is no other configuration required.

id
string<ulid>
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.

Response

OK

Connector represents a connector to an external system. HTTPConnector represents a connector to an external system over HTTP. ConnectorBase holds common fields which exist across all Connector protocols.

id
string<ulid>
required

ID is the unique identifier of the Connector.

organisationId
string<ulid>
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:
TitleConst
http
authSchemeConfigs
object[]
required
connections
object[]
required

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

versions
object[]
required

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

createdAt
string<date-time>
required

CreatedAt is the time at which the ConnectorVersion was created.

updatedAt
string<date-time>
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.