Get organisations connections

Retrieves connections for an organisation, potentially filtering by appId. The response is structured as a page but currently the response returns all items. Consumers wishing to be backwards compatible should not assume this API will always return all items.

GET /organisations/{organisationId}/connections

cURL

cURL

curl --request GET \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections \
  --header 'Authorization: <api-key>'

200

{
  "totalCount": 123,
  "items": [
    {
      "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>"
        }
      ]
    }
  ],
  "next": "<string>",
  "prev": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

organisationId · string · required

Query Parameters

appId · string

Optionally filter connections by an App ID

first · integer · default: 20

before · string

after · string

sort · string

Pattern: ^([^:,]+:[^:,]+)(,[^:,]+:[^:,]+)*$

Response

200

application/json

A paginated result of Apps.

totalCount · integer · required

items · object[] · required

Show child attributes

next · string

prev · string