Upsert Auth Scheme Config to Connector - Versori User Documentation

PUT

{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>",
  "schemeType": "none",
  "validationMessages": [
    {
      "text": "<string>",
      "detail": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}"

payload = {
    "id": "<string>",
    "description": "<string>",
    "schemeType": "none",
    "validationMessages": [
        {
            "text": "<string>",
            "detail": ["<string>"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    description: '<string>',
    schemeType: 'none',
    validationMessages: [{text: '<string>', detail: ['<string>']}]
  })
};

fetch('https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'description' => '<string>',
    'schemeType' => 'none',
    'validationMessages' => [
        [
                'text' => '<string>',
                'detail' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"schemeType\": \"none\",\n  \"validationMessages\": [\n    {\n      \"text\": \"<string>\",\n      \"detail\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("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")
  .body("{\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"schemeType\": \"none\",\n  \"validationMessages\": [\n    {\n      \"text\": \"<string>\",\n      \"detail\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"schemeType\": \"none\",\n  \"validationMessages\": [\n    {\n      \"text\": \"<string>\",\n      \"detail\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "schemeType": "none",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "schemeType": "none",
              "validationMessages": [
                {
                  "text": "<string>",
                  "severity": "info",
                  "detail": [
                    "<string>"
                  ]
                }
              ]
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "type": "none",
              "name": "<string>",
              "data": {},
              "usages": [
                {
                  "connection": {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "protocol": "http",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ],
        "trigger": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "schemeType": "none",
              "validationMessages": [
                {
                  "text": "<string>",
                  "severity": "info",
                  "detail": [
                    "<string>"
                  ]
                }
              ]
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "type": "none",
              "name": "<string>",
              "data": {},
              "usages": [
                {
                  "connection": {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "protocol": "http",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "versions": [
    {
      "id": "<string>",
      "name": "<string>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "messages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "baseUrl": "<string>",
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<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.

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.

Show child attributes

Response

Option 1
Option 2

Connector represents a connector to an external system.

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:

http,

bigquery

Allowed value: "http"

authSchemeConfigs

object[]

required

Show child attributes

connections

object[]

required

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

Show child attributes

versions

object[]

required

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

Show child attributes

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.

Show child attributes

⌘I

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>",
  "schemeType": "none",
  "validationMessages": [
    {
      "text": "<string>",
      "detail": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}"

payload = {
    "id": "<string>",
    "description": "<string>",
    "schemeType": "none",
    "validationMessages": [
        {
            "text": "<string>",
            "detail": ["<string>"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    description: '<string>',
    schemeType: 'none',
    validationMessages: [{text: '<string>', detail: ['<string>']}]
  })
};

fetch('https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'description' => '<string>',
    'schemeType' => 'none',
    'validationMessages' => [
        [
                'text' => '<string>',
                'detail' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"schemeType\": \"none\",\n  \"validationMessages\": [\n    {\n      \"text\": \"<string>\",\n      \"detail\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("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")
  .body("{\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"schemeType\": \"none\",\n  \"validationMessages\": [\n    {\n      \"text\": \"<string>\",\n      \"detail\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/auth-scheme-configs/{auth_scheme_config_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"schemeType\": \"none\",\n  \"validationMessages\": [\n    {\n      \"text\": \"<string>\",\n      \"detail\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "schemeType": "none",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "schemeType": "none",
              "validationMessages": [
                {
                  "text": "<string>",
                  "severity": "info",
                  "detail": [
                    "<string>"
                  ]
                }
              ]
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "type": "none",
              "name": "<string>",
              "data": {},
              "usages": [
                {
                  "connection": {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "protocol": "http",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ],
        "trigger": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "schemeType": "none",
              "validationMessages": [
                {
                  "text": "<string>",
                  "severity": "info",
                  "detail": [
                    "<string>"
                  ]
                }
              ]
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "type": "none",
              "name": "<string>",
              "data": {},
              "usages": [
                {
                  "connection": {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "protocol": "http",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "versions": [
    {
      "id": "<string>",
      "name": "<string>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "messages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "baseUrl": "<string>",
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}