Skip to main content
POST
/
organisations
/
{organisationId}
/
connections
cURL
curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My API Key",
  "appId": "01G01QZNWG0000000000000000",
  "authType": "apikey",
  "data": {
    "apiKey": "my-secret-key"
  }
}
'
{
  "id": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "app": {
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "public": true,
    "server": {
      "name": "<string>",
      "url": "<string>"
    },
    "schemaMetadata": {
      "type": "<string>",
      "version": "<string>",
      "url": "<string>"
    },
    "schema": {
      "id": "<string>",
      "type": "<string>",
      "version": "<string>",
      "sourceUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "supportedAuthConfigs": [
      {
        "type": "<string>",
        "isValid": true,
        "data": {
          "discoveryUrl": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>",
          "scopes": {}
        }
      }
    ],
    "imageUrl": "<string>",
    "schemaId": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "credentialId": "<string>",
  "authConfig": {
    "type": "<string>",
    "isValid": true,
    "data": {
      "discoveryUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": {}
    }
  },
  "usedByBoards": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.versori.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required

Body

application/json

CreateConnectionRequest is the payload for creating a new Connection.

CreateConnectionRequestBody is the request body to create a new connection. The ID is automatically generated and the organisation ID is defined by the request's path parameter.

​
name
string
required
​
appId
string
required
​
authType
string
required
​
data
object
required

ConnectionDataAPIKey is the data element of a connection which is using an apikey authentication type.

Response

A single Connection result.

​
id
string
required
​
orgId
string
required
​
name
string
required
​
app
object
required
​
credentialId
string
required
​
authConfig
object

AppAuthConfig describes how an organisation can authenticate with an app.

​
usedByBoards
object[]