API Reference

Authorization

Versori User Documentation

Home

Integrate

Embedded

Update an existing data mapping entry by ID for the given organisation and mapping.


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.


AppAuthConfig describes how an organisation can authenticate with an app.


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.


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


In denotes where the API key should be set when calling the API. Possible values are: `"query"`,
`"header"` or `"cookie"`.


Name is the header, query param or cookie name which the API key should be provided as.


The url to the function to call to authenticate the request.

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

- AppAuthConfigOIDC
- AppAuthConfigOAuth2
- AppAuthConfigApiKey
- AppAuthConfigHTTPRefresh
- AppAuthConfigHTTPBasicAuth
- AppAuthConfigJWTBearer
- AppAuthConfigCustomFunction


Password is the secret used to perform the basic authentication.


User is the identifier to perform the basic authentication.


HeaderDestination is used if `"in"` is set to `"header"` to specify the header key for the ClientSecret data to be sent with.
This can be empty if the `"in"` is not set to `"header"`.


Headers is a list of static headers to send along with the token request.


In denotes where the token should be set when calling the API. Possible values are: `"query"`,
`"header"` or `"cookie"`.


The http method to use for the token request.

Name is the header, query param or cookie name which the token should be provided as.


Prefix contains any prefix that should be used to set the token in the header, such as `"Bearer"`.


SecretIn denotes where the client secret should be set when calling the API. Possible values are: `"header"` or `"body"`.


Selector is an expression to evaluate to obtain the token from the Response returned from the TokenEndpoint.
This always extracts from the body response from the TokenEndpoint.


Extracting token from response `{"result"`:{"tok""my_token"}}`

Extracting token from response `{"tok""my_token"}`

TokenEndpoint is the URL to use to Request a token.


TokenTTL is the duration in seconds for a token to last before refreshing to get a new one.


The duration for a token to last before refreshing to get a new one.


The prefix of the JWT in the header. Defaults to "Bearer" if not set.


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


FlowType is the type of OAuth2 Flow supported. Valid values are `authorization_code` and `client_credentials` and `resource_owner_password`.


AppAuthConfigOIDC specifies the configuration for authenticating using the OpenID Connect specification.


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

This defines which fields from the source map to fields in the target in a data mapping.

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


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.


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


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.


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


URL is the server address listening for requests.


DataMappingEntryUpdate is the request body to update a credential. The ID and organisation ID and Mapping ID
fields are taken from the URL path.


apiKey

Welcome to the Versori Platform documentation.

Welcome

Introduction

Connect your APIs to the Versori Platform.

Overview

Learn about the protocols used by the Versori Platform.

Protocols

Authentication Methods

Actions

Triggers

Provide credentials for a Connector to facilitate Versori to interact with an external system.

Connections

Build integrations between your systems with Boards.

How It Works

Creating a Hub

Quickstart React

Quickstart

React SDK

Build integrations between your internal systems.

Boards are the entrypoint to building integrations.

Select one of the following APIs to get started

Learn how to authenticate with the Versori Platform.

Authentication

Our next-generation API for connecting to your external systems.

Our next-generation API for exposing Versori-powered integrations to your users.

Organisations API provides access to manage your Versori Organisation.

CreateSigningKey creates a new Signing Key for the Organisation. 

This API creates a new RSA key pair, storing the public key and returning the private key. The private key must 
be kept secure and should not be shared publicly as it has the ability to sign JWTs which can be used to 
authenticate to Versori APIs on behalf of your Organisation (or scoped to a specific End User within 
Versori Embedded).

If the private key is lost, it cannot be recovered and a new key pair must be generated. In this scenario, it is
the Organisation's responsibility to delete the Signing Key from Versori so that any JWTs signed by the lost key
are invalidated.


Create Signing Key

ListSigningKeys returns a list of all Signing Keys for the Organisation.


List Signing Keys

DeleteSigningKey deletes the signing key for the Organisation.

Any existing JWTs signed by this key will be invalidated and will no longer be accepted by the Versori platform.


Delete Signing Key

GetPublicKey returns the public key for the given Signing Key ID. This can be used to verify JWTs signed by an 
Organisation's Signing Key.


Retrieve public key

Proxy API enables authenticated requests through Connections in the Platform.

Use Cases

Endpoint

Welcome to the user documentation for the Versori Platform

Core Concepts

Within Switchboard, apps are the external-system nodes that you use to build out your integrations.

Apps

Boards

The Board Editor is your main tool for creating and editing boards. It is a visual tool that allows you to create and edit boards by dragging and dropping components onto the board.

Board Editor

The Hubs SDK is a tool that allows the users of your Product to integrate into different Apps you have configured in the Versori Platform.

Hubs SDK

Learn how to use Actions to automate your workflows.

The transformer action is a drag and drop action that allows you to transform the data in your workflow.

Transformer

The Databuilder allows for familiar form based templating and transformations

Databuilder

The filter action allows you to filter the resulting data based on a series of conditions.

Filter

Datamapper provides storage within Switchboard for remembering cross-system references to different entities.

Datamapper

The Batch action allows you to aggregate requests into a single output format.

Batch

The Delay Action is used to delay the execution of the next node in the workflow.

Delay

The Splitter Action accepts a List input and splits each item to be processed individually.

Splitter

The Trigger Action is used as a startpoint within your flows, to trigger requests either manually or on a schedule.

Trigger

Boards are built from Apps, and Actions in a drag-and-drop interface.

How to create a Board, an use the Board Editor

Multiple methods of connecting your apps are available.

How to Connect to your Apps

When building your integrations - you can add your operations from different systems, and provide further configuration.

How to add a Webhook Listener into your Integration

Selectors provide an intuitive interface for plucking data from previous steps in your flow, to be used within your requests and actions.

How to use Selectors to template data within your Integrations

The Hubs SDK enables users to authenticate and onboard into external integrations that are connected to your product

How to use the Versori Hubs SDK

Preview the output of a transformer. This endpoint is useful for testing a transformer before creating an integration.


Preview the output of a transformer.

Retrieve a signed URL for uploading a schema specification


Upload a schema document based on a source URL. The server will download this URL and upload to object
storage automatically.


SchemaInfo processes the schema referenced by the provided URL and returns information to allow a user to create
an App.

Deprecated: This endpoint is no longer supported, users should create a Schema using the `CreateSchema`
(POST /organisations/{organisationId}/schemas) operation, and use the `GetSchemaInfo` operation to retrieve
this information.


Retrieve a signed URL for uploading assets


API Reference

Put organisations data mappings entries

Authorizations

Path Parameters

Body

Response