GET
/
organisations
/
{organisationId}
/
schemas
/
{id}
/
info
cURL
curl --request GET \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/info \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "title": "<string>",
  "availableServers": [
    {
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "schemaMetadata": {
    "type": "<string>",
    "version": "<string>",
    "url": "<string>"
  },
  "supportedAuthConfigs": [
    {
      "type": "<string>",
      "isValid": true,
      "data": {
        "discoveryUrl": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>",
        "scopes": {}
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required

OrganisationID is the ID of the organisation that the schema belongs to.

​
id
string
required

ID is the schema identifier

Response

GetSchemaInfoResponse is the request body for getting the schema info of an existing Schema.

​
availableServers
object[]
required
​
schemaMetadata
object
required
​
supportedAuthConfigs
object[]
required

SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.

​
id
string

The ID of the Schema record if it is stored.

​
title
string

Title is calculated from the parsed schema. Not all schemas contain this information so may be null.