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.

Response

200
application/json

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.