POST
/
organisations
/
{organisationId}
/
schema-utils
/
{schemaType}
/
import

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
schemaType
string
required

SchemaType is the type of schema which an App implements. The only supported values are currently "openapi", but is planned to be extended to include gRPC, GraphQL and SOAP.

Body

application/json
​
url
string
required

The URL which can be used to download the schema document.

Response

200 - application/json
​
availableServers
object[]
required
​
availableServers.name
string
required

Description is a human-friendly name for this server address. If a friendly name isn't available then this defaults to the URL.

​
availableServers.url
string
required

URL is the server address listening for requests.

​
schemaMetadata
object
required
​
schemaMetadata.type
string
required

Type denotes the type of schema the corresponding App is backed by. Currently the only supported value is "openapi", but other types such as "soap", "graphql" and "grpc" are on the roadmap.

​
schemaMetadata.url
string
required

URL is the private address for accessing the schema. This is not guaranteed to be publicly accessible and could be a non-HTTP protocol (i.e. gs:// or s3://)

​
schemaMetadata.version
string
required

Version denotes the version of the schema specification. This property is contextual based on the schema type, for example openapi schemas will contain the OpenAPI specification version (currently only 3.0.x is supported), but grpc APIs could be "proto2" or "proto3".

​
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.

​
supportedAuthConfigs.data
object
required

AppAuthConfigData should JSON-marshal to one of the types specified in the jsonschema oneOf:

  • AppAuthConfigOIDC
  • AppAuthConfigOAuth2
  • AppAuthConfigApiKey
  • AppAuthConfigHTTPRefresh
  • AppAuthConfigHTTPBasicAuth
  • AppAuthConfigJWTBearer
  • AppAuthConfigCustomFunction
​
supportedAuthConfigs.isValid
boolean
required

IsValid is true if and only if the data field is populated with all the required information to enable an organisation to connect to the App via this auth type. It is allowed for an App to have invalid auth configs providing there is at least one valid.

​
supportedAuthConfigs.type
string
required

Type denotes the method of authentication. Valid values are: "oidc", "oauth2", "apikey", `"httpBasicAuth"

​
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.

Put organisations schemas importGet organisations schema utils signed url