Create a new connection.
curl --request POST \
--url https://platform.versori.com/api/v2/o/{organisation_id}/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectionTemplateId": "<string>",
"connection": {
"name": "<string>",
"credentials": [
{
"id": "<string>"
}
],
"baseUrl": "<string>"
},
"externalId": "<string>"
}
'import requests
url = "https://platform.versori.com/api/v2/o/{organisation_id}/connections"
payload = {
"connectionTemplateId": "<string>",
"connection": {
"name": "<string>",
"credentials": [{ "id": "<string>" }],
"baseUrl": "<string>"
},
"externalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectionTemplateId: '<string>',
connection: {name: '<string>', credentials: [{id: '<string>'}], baseUrl: '<string>'},
externalId: '<string>'
})
};
fetch('https://platform.versori.com/api/v2/o/{organisation_id}/connections', 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/v2/o/{organisation_id}/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectionTemplateId' => '<string>',
'connection' => [
'name' => '<string>',
'credentials' => [
[
'id' => '<string>'
]
],
'baseUrl' => '<string>'
],
'externalId' => '<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/v2/o/{organisation_id}/connections"
payload := strings.NewReader("{\n \"connectionTemplateId\": \"<string>\",\n \"connection\": {\n \"name\": \"<string>\",\n \"credentials\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"baseUrl\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://platform.versori.com/api/v2/o/{organisation_id}/connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connectionTemplateId\": \"<string>\",\n \"connection\": {\n \"name\": \"<string>\",\n \"credentials\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"baseUrl\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.versori.com/api/v2/o/{organisation_id}/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectionTemplateId\": \"<string>\",\n \"connection\": {\n \"name\": \"<string>\",\n \"credentials\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"baseUrl\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"credentials": [
{
"id": "<string>",
"authSchemeConfig": {
"type": "none",
"none": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"apiKey": {
"id": "<string>",
"description": "<string>",
"name": "<string>",
"in": "query",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"basicAuth": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"oauth2": {
"id": "<string>",
"description": "<string>",
"tokenUrl": "<string>",
"scopes": [
{
"name": "<string>",
"description": "<string>"
}
],
"defaultScopes": [
"<string>"
],
"grant": {
"type": "authorizationCode",
"authorizationCode": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"clientCredentials": {},
"password": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
}
},
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"authorizeUrl": "<string>",
"additionalAuthorizeParams": "<string>",
"additionalTokenParams": "<string>",
"mtlsEnabled": true,
"mtlsCredentialId": "<string>",
"pkce": true
},
"oauth1": {
"id": "<string>",
"description": "<string>",
"consumerKey": "<string>",
"consumerSecret": "<string>",
"signatureMethod": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"tokenAuth": true,
"tempCredentialEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"location": "LOCATION_IGNORE",
"required": true,
"modifiable": true,
"targetName": "<string>",
"usages": "USAGE_UNKNOWN"
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"resourceOwnerAuthorizationEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"location": "LOCATION_IGNORE",
"required": true,
"modifiable": true,
"targetName": "<string>",
"usages": "USAGE_UNKNOWN"
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"tokenEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"location": "LOCATION_IGNORE",
"required": true,
"modifiable": true,
"targetName": "<string>",
"usages": "USAGE_UNKNOWN"
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"credentialId": "<string>"
},
"hmac": {
"id": "<string>",
"description": "<string>",
"name": "<string>",
"in": "query",
"algorithm": "sha1",
"digestInputs": [
"body"
],
"encoding": "hex",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"certificate": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"errors": [
"<string>"
],
"data": {
"binary": {
"valueBase64": "<string>"
},
"none": {},
"string": {
"value": "<string>"
},
"basicAuth": {
"username": "<string>",
"password": "<string>"
},
"oauth2Client": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"scopes": [
"<string>"
],
"additionalParams": "<string>",
"mTLSEnabled": true,
"mTLSCredentialId": "<string>"
},
"oauth2Token": {
"scopes": [
"<string>"
],
"refreshToken": "<string>",
"accessToken": "<string>",
"tokenType": "Bearer",
"expiresAt": "2023-11-07T05:31:56Z"
},
"oauth2Code": {
"code": "<string>",
"state": "<string>",
"additionalParams": "<string>"
},
"oauth2Password": {
"username": "<string>",
"password": "<string>"
},
"certificate": {
"certificate": "<string>",
"key": "<string>",
"ca": "<string>"
},
"oauth1": {
"state": "<string>",
"oauthToken": "<string>",
"oauthVerifier": "<string>"
},
"oauth1Token": {
"token": "<string>",
"tokenSecret": "<string>",
"additionalParams": [
{
"name": "<string>",
"value": "<string>"
}
]
}
},
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"systemId": "<string>",
"connectionTemplateId": "<string>"
}{
"code": "<string>",
"message": "<string>",
"fields": [
{
"field": "<string>",
"message": "<string>"
}
],
"details": "<string>"
}connections
Create a new connection.
CreateConnection creates a new connection for the given organisation.
POST
/
o
/
{organisation_id}
/
connections
Create a new connection.
curl --request POST \
--url https://platform.versori.com/api/v2/o/{organisation_id}/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectionTemplateId": "<string>",
"connection": {
"name": "<string>",
"credentials": [
{
"id": "<string>"
}
],
"baseUrl": "<string>"
},
"externalId": "<string>"
}
'import requests
url = "https://platform.versori.com/api/v2/o/{organisation_id}/connections"
payload = {
"connectionTemplateId": "<string>",
"connection": {
"name": "<string>",
"credentials": [{ "id": "<string>" }],
"baseUrl": "<string>"
},
"externalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectionTemplateId: '<string>',
connection: {name: '<string>', credentials: [{id: '<string>'}], baseUrl: '<string>'},
externalId: '<string>'
})
};
fetch('https://platform.versori.com/api/v2/o/{organisation_id}/connections', 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/v2/o/{organisation_id}/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectionTemplateId' => '<string>',
'connection' => [
'name' => '<string>',
'credentials' => [
[
'id' => '<string>'
]
],
'baseUrl' => '<string>'
],
'externalId' => '<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/v2/o/{organisation_id}/connections"
payload := strings.NewReader("{\n \"connectionTemplateId\": \"<string>\",\n \"connection\": {\n \"name\": \"<string>\",\n \"credentials\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"baseUrl\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://platform.versori.com/api/v2/o/{organisation_id}/connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connectionTemplateId\": \"<string>\",\n \"connection\": {\n \"name\": \"<string>\",\n \"credentials\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"baseUrl\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.versori.com/api/v2/o/{organisation_id}/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectionTemplateId\": \"<string>\",\n \"connection\": {\n \"name\": \"<string>\",\n \"credentials\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"baseUrl\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"credentials": [
{
"id": "<string>",
"authSchemeConfig": {
"type": "none",
"none": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"apiKey": {
"id": "<string>",
"description": "<string>",
"name": "<string>",
"in": "query",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"basicAuth": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"oauth2": {
"id": "<string>",
"description": "<string>",
"tokenUrl": "<string>",
"scopes": [
{
"name": "<string>",
"description": "<string>"
}
],
"defaultScopes": [
"<string>"
],
"grant": {
"type": "authorizationCode",
"authorizationCode": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"clientCredentials": {},
"password": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
}
},
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"authorizeUrl": "<string>",
"additionalAuthorizeParams": "<string>",
"additionalTokenParams": "<string>",
"mtlsEnabled": true,
"mtlsCredentialId": "<string>",
"pkce": true
},
"oauth1": {
"id": "<string>",
"description": "<string>",
"consumerKey": "<string>",
"consumerSecret": "<string>",
"signatureMethod": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"tokenAuth": true,
"tempCredentialEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"location": "LOCATION_IGNORE",
"required": true,
"modifiable": true,
"targetName": "<string>",
"usages": "USAGE_UNKNOWN"
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"resourceOwnerAuthorizationEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"location": "LOCATION_IGNORE",
"required": true,
"modifiable": true,
"targetName": "<string>",
"usages": "USAGE_UNKNOWN"
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"tokenEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"location": "LOCATION_IGNORE",
"required": true,
"modifiable": true,
"targetName": "<string>",
"usages": "USAGE_UNKNOWN"
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"credentialId": "<string>"
},
"hmac": {
"id": "<string>",
"description": "<string>",
"name": "<string>",
"in": "query",
"algorithm": "sha1",
"digestInputs": [
"body"
],
"encoding": "hex",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"certificate": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"errors": [
"<string>"
],
"data": {
"binary": {
"valueBase64": "<string>"
},
"none": {},
"string": {
"value": "<string>"
},
"basicAuth": {
"username": "<string>",
"password": "<string>"
},
"oauth2Client": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"scopes": [
"<string>"
],
"additionalParams": "<string>",
"mTLSEnabled": true,
"mTLSCredentialId": "<string>"
},
"oauth2Token": {
"scopes": [
"<string>"
],
"refreshToken": "<string>",
"accessToken": "<string>",
"tokenType": "Bearer",
"expiresAt": "2023-11-07T05:31:56Z"
},
"oauth2Code": {
"code": "<string>",
"state": "<string>",
"additionalParams": "<string>"
},
"oauth2Password": {
"username": "<string>",
"password": "<string>"
},
"certificate": {
"certificate": "<string>",
"key": "<string>",
"ca": "<string>"
},
"oauth1": {
"state": "<string>",
"oauthToken": "<string>",
"oauthVerifier": "<string>"
},
"oauth1Token": {
"token": "<string>",
"tokenSecret": "<string>",
"additionalParams": [
{
"name": "<string>",
"value": "<string>"
}
]
}
},
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"systemId": "<string>",
"connectionTemplateId": "<string>"
}{
"code": "<string>",
"message": "<string>",
"fields": [
{
"field": "<string>",
"message": "<string>"
}
],
"details": "<string>"
}Authorizations
bearerTokencookie
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
Body
application/json
This is the ID of the template that the connection is created against.
ConnectionCreate defines the connection to create.
Show child attributes
Show child attributes
The external ID of the end user for whom the connection is being created. If this is not provided, the connection will be created as a static connection.
Response
Created
Connection defines the credentials for the owning Connector, and additional variables which can be used to customize the Connector in a particular connection.
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.
Name is the name of the Connection. This must be unique within the owning Connector.
ConnectionCredentials defines the 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.
Show child attributes
Show child attributes
CreatedAt is the time the Connection was created.
UpdatedAt is the time the Connection was last updated.
The baseUrl on the connection allows a dynamic user to override the base URL of the connection. This is useful when users have their own instance of a service and want to connect to it.
For example, a user may have their own instance of shopify and their url is https://myshopify.com. They can
override the base url of the connection to https://myshopify.com and all requests will be made to this url.
If it is left as an empty string, it will be ignored.
ID of the system to add the project environment.
This is the ID of the template that the connection is created against.
⌘I