Get organisations apps - Versori User Documentation

Authorizations

Authorization

string

header

required

Path Parameters

organisationId

string

required

Query Parameters

first

integer

default:

before

string

after

string

sort

string

Response

200 - application/json

totalCount

integer

required

items

object[]

items.createdAt

string

required

items.id

string

required

items.name

string

required

items.orgId

string

required

items.public

boolean

required

items.schema

object

required

items.schema.createdAt

string

required

items.schema.id

string

required

items.schema.sourceUrl

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://)

items.schema.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.

items.schema.updatedAt

string

required

items.schema.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".

items.schema.deletedAt

string

items.schemaMetadata

object

required

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

items.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://)

items.schemaMetadata.version

string

required

items.server

object

required

items.server.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.

items.server.url

string

required

URL is the server address listening for requests.

items.updatedAt

string

required

items.deletedAt

string

items.imageUrl

string

items.schemaId

string

items.supportedAuthConfigs

object[]

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.

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

items.supportedAuthConfigs.data.clientId

string

items.supportedAuthConfigs.data.clientSecret

string

ClientSecret is the OAuth2.0 client's secret. This should be write-only, and not be viewable after creation.

items.supportedAuthConfigs.data.discoveryUrl

string

Takes precedent over the endpoint properties. If this property is set, it will be queried and override any defined endpoint properties.

items.supportedAuthConfigs.data.scopes

object

Scopes is a map of scopes this API supports, with the scope name as keys and a description as the value. It may not be required to specify them all to connect the App.

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

items.supportedAuthConfigs.type

string

required

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

string

API Reference

Authorizations

Path Parameters

Query Parameters

Response