Authorizations
Path Parameters
Body
application/json
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>"
},
"supportedAuthConfigs": [
{
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
],
"imageUrl": "<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"
},
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"authConfig": {
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
},
"credentialId": "<string>",
"usedByBoards": [
{
"id": "<string>",
"name": "<string>"
}
]
}Creates a connection between an organisation and an App. This is to be used by authentication methods which the user can explicitly configure, such as API Key and Basic Auth. For OAuth2/OIDC connections, users should call the InitialiseConnection endpoint instead.
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>"
},
"supportedAuthConfigs": [
{
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
],
"imageUrl": "<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"
},
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"authConfig": {
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
},
"credentialId": "<string>",
"usedByBoards": [
{
"id": "<string>",
"name": "<string>"
}
]
}