GET
/
o
/
{organisation_id}
/
connections
/
{connection_id}
curl --request GET \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/connections/{connection_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "name": "<string>",
          "in": "query"
        },
        "basicAuth": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ]
        },
        "oauth2": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "authorizeUrl": "<string>",
          "tokenUrl": "<string>",
          "scopes": [
            {
              "name": "<string>",
              "description": "<string>"
            }
          ],
          "defaultScopes": [
            "<string>"
          ],
          "additionalAuthorizeParams": "<string>",
          "additionalTokenParams": "<string>",
          "mtlsEnabled": true,
          "mtlsCredentialId": "<string>",
          "pkce": true,
          "grant": {
            "authorizationCode": {
              "credentialId": "<string>",
              "organisationId": "<string>",
              "clientId": "<string>",
              "clientSecret": "<string>"
            },
            "clientCredentials": {},
            "password": {
              "credentialId": "<string>",
              "organisationId": "<string>",
              "clientId": "<string>",
              "clientSecret": "<string>"
            },
            "type": "authorizationCode"
          }
        },
        "oauth1": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "consumerKey": "<string>",
          "consumerSecret": "<string>",
          "tempCredentialEndpoint": {
            "url": "<string>",
            "additionalParamConfigs": [
              {
                "parameterName": "<string>",
                "targetName": "<string>",
                "location": "LOCATION_IGNORE",
                "usages": "USAGE_UNKNOWN",
                "required": true,
                "modifiable": true
              }
            ],
            "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
          },
          "resourceOwnerAuthorizationEndpoint": {
            "url": "<string>",
            "additionalParamConfigs": [
              {
                "parameterName": "<string>",
                "targetName": "<string>",
                "location": "LOCATION_IGNORE",
                "usages": "USAGE_UNKNOWN",
                "required": true,
                "modifiable": true
              }
            ],
            "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
          },
          "tokenEndpoint": {
            "url": "<string>",
            "additionalParamConfigs": [
              {
                "parameterName": "<string>",
                "targetName": "<string>",
                "location": "LOCATION_IGNORE",
                "usages": "USAGE_UNKNOWN",
                "required": true,
                "modifiable": true
              }
            ],
            "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
          },
          "signatureMethod": "<string>",
          "credentialId": "<string>"
        },
        "hmac": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "name": "<string>",
          "in": "query",
          "algorithm": "sha1",
          "digestInputs": [
            "body"
          ]
        },
        "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>"
            ],
            "accessToken": "<string>",
            "tokenType": "Bearer",
            "expiresAt": "2023-11-07T05:31:56Z",
            "refreshToken": "<string>"
          },
          "oauth2Code": {
            "code": "<string>",
            "state": "<string>"
          },
          "oauth2Password": {
            "username": "<string>",
            "password": "<string>"
          },
          "certificate": {
            "certificate": "<string>",
            "key": "<string>",
            "ca": "<string>"
          },
          "oauth1": {
            "state": "<string>",
            "oauthToken": "<string>",
            "oauthVerifier": "<string>"
          }
        },
        "expiresAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "baseUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "systemId": "<string>",
  "connectionTemplateId": "<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
required
​
connection_id
string
required

Response

200
application/json

OK

Connection defines the credentials for the owning Connector, and additional variables which can be used to customize the Connector in a particular connection.