> ## Documentation Index > Fetch the complete documentation index at: https://docs.versori.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a new connection. > CreateConnection creates a new connection for the given organisation. ## OpenAPI ````yaml /openapi/platform-api.yaml post /o/{organisation_id}/connections openapi: 3.1.0 info: title: Versori Platform API version: 0.0.1 license: name: UNLICENSED servers: - description: Production url: https://platform.versori.com/api/v2 - description: Staging url: https://platform-staging.versori.com/api/v2 - description: Development url: http://localhost:8901 security: - bearerToken: [] - cookie: [] paths: /o/{organisation_id}/connections: parameters: - $ref: '#/components/parameters/organisation_id' post: tags: - connections summary: Create a new connection. description: | CreateConnection creates a new connection for the given organisation. operationId: CreateConnection requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvSystemConnectionCreate' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/Connection' default: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: organisation_id: name: organisation_id in: path required: true schema: type: string format: ulid x-go-type: ulid.ULID x-go-name: OrganisationID x-go-type-import: path: versori.dev/vergo/ulid schemas: EnvSystemConnectionCreate: type: object properties: connectionTemplateId: $ref: '#/components/schemas/TemplateID' connection: $ref: '#/components/schemas/ConnectionCreate' externalId: type: string description: > The external ID of the end user for whom the connection is being created. If this is not provided, the connection will be created as a static connection. required: - connectionTemplateId - connection Connection: description: > Connection defines the credentials for the owning Connector, and additional variables which can be used to customize the Connector in a particular connection. type: object properties: id: type: string format: ulid description: > ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all) public-facing APIs will use the `name` in combination with the Connector's `id` instead. x-go-name: ID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid name: type: string description: >- Name is the name of the Connection. This must be unique within the owning Connector. credentials: $ref: '#/components/schemas/ConnectionCredentials' baseUrl: description: > The baseUrl on the connection allows a dynamic user to override the base URL of the connection. This is useful when users have their own instance of a service and want to connect to it. For example, a user may have their own instance of shopify and their url is `https://myshopify.com`. They can override the base url of the connection to `https://myshopify.com` and all requests will be made to this url. If it is left as an empty string, it will be ignored. type: string format: uri x-go-type-skip-optional-pointer: true x-go-name: baseURL createdAt: type: string format: date-time description: CreatedAt is the time the Connection was created. updatedAt: type: string format: date-time description: UpdatedAt is the time the Connection was last updated. systemId: description: ID of the system to add the project environment. type: string format: ulid x-go-type: ulid.ULID x-go-name: SystemID x-go-type-import: path: versori.dev/vergo/ulid x-go-type-skip-optional-pointer: true connectionTemplateId: $ref: '#/components/schemas/TemplateID' required: - id - name - credentials - createdAt - updatedAt Error: type: object properties: code: type: string description: Code is a machine-readable error code. message: type: string description: Message is a human-readable error message. fields: type: array items: $ref: '#/components/schemas/ErrorField' x-go-type-skip-optional-pointer: true details: type: string x-go-type-skip-optional-pointer: true required: - code - message TemplateID: type: string description: | This is the ID of the template that the connection is created against. format: ulid x-go-type: ulid.ULID x-go-name: EnvironmentSystemID x-go-type-skip-optional-pointer: true x-go-type-import: path: versori.dev/vergo/ulid ConnectionCreate: description: ConnectionCreate defines the connection to create. type: object properties: name: type: string description: Name is the name of the Connection. credentials: $ref: '#/components/schemas/ConnectionCredentialsCreate' baseUrl: type: string format: uri description: > BaseURL is the base URL for the connection. This allows you to override the baseURL for the system being connected to. An example is where the system's baseURL is https://shopifyplaceholder.com and you want to connect to your own shopify which is at https://myshopify.com. Everything after the top-level domain will be ignored. If the scheme is missing, then https:// will be used. x-go-name: BaseURL x-go-type-skip-optional-pointer: true required: - name - credentials ConnectionCredentials: description: > ConnectionCredentials defines the credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request. type: array items: $ref: '#/components/schemas/ConnectionCredential' x-go-type-skip-optional-pointer: true ErrorField: description: ErrorField denotes a field which has an error. type: object properties: field: type: string description: > Field is the name of the field which has an error, this may be a path to a nested field, including array elements. The format of this field is of the form: "field1.field2[0].field3" message: type: string description: Message is the error message for this specific field. required: - field - message ConnectionCredentialsCreate: type: array items: $ref: '#/components/schemas/ConnectionCredential' x-go-type-skip-optional-pointer: true ConnectionCredential: description: >- ConnectionCredential contains the a Credential and the AuthSchemeConfig to define how the Credential should be used against the Connection's Connector. type: object properties: id: type: string format: ulid x-go-name: ID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid authSchemeConfig: $ref: '#/components/schemas/AuthSchemeConfig' credential: $ref: '#/components/schemas/Credential' required: - id AuthSchemeConfig: type: object description: > An AuthSchemeConfig describes how credentials should be used to authenticate with a System, an example being where an API key should be sent and what the header/query parameter/cookie name is. For OAuth2, this config object also contains data such as the token URL, client ID and secret, and scopes to request. This type contains a string called `type` which denotes which field in this object should be populated. For example if the `type` is `api-key`, then the `apiKey` field will be populated with an `AuthSchemeConfigAPIKey` object. properties: type: $ref: '#/components/schemas/AuthSchemeType' none: $ref: '#/components/schemas/AuthSchemeConfigNone' apiKey: $ref: '#/components/schemas/AuthSchemeConfigAPIKey' basicAuth: $ref: '#/components/schemas/AuthSchemeConfigBasicAuth' oauth2: $ref: '#/components/schemas/AuthSchemeConfigOAuth2' oauth1: $ref: '#/components/schemas/AuthSchemeConfigOAuth1' hmac: $ref: '#/components/schemas/AuthSchemeConfigHMAC' certificate: $ref: '#/components/schemas/AuthSchemeConfigCertificate' required: - type Credential: description: > CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types. type: object properties: id: description: ID is the unique identifier of the Credential. type: string format: ulid x-go-name: ID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid organisationId: description: >- OrganisationID is the unique identifier of the Organisation which owns the Credential. type: string format: ulid x-go-name: OrganisationID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid type: $ref: '#/components/schemas/CredentialType' name: type: string description: Name is the name of the Credential. errors: description: > Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid. type: array items: type: string x-go-type-skip-optional-pointer: true data: $ref: '#/components/schemas/CredentialData' expiresAt: type: string format: date-time description: > ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe to deletion events and if the reason is "expired", can trigger the correct notifications to interested parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it). required: - id - organisationId AuthSchemeType: description: > Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see enum values for possible options. type: string enum: - none - api-key - basic-auth - oauth2 - hmac - jwt-bearer - certificate - oauth1 - secret AuthSchemeConfigNone: title: None description: > AuthSchemeConfigNone is a placeholder object with the schemeType set to `none`. There is no other configuration required. type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' AuthSchemeConfigAPIKey: title: API Key description: > AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system. type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' - type: object properties: name: type: string description: >- Name is the query parameter/header/cookie name which will be used to send the API key. in: $ref: '#/components/schemas/AuthSchemeConfigAPIKeyIn' required: - name - in AuthSchemeConfigBasicAuth: title: Basic Auth description: > AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to `basic-auth`. There is no other configuration required. type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' AuthSchemeConfigOAuth2: title: OAuth 2.0 description: > AuthSchemeConfigOAuth2 defines how a Connector uses an OAuth2 credential to authenticate with the system. This is to be used for all OAuth 2.0 flows which require a client ID and client secret as part of the Connector's configuration. Connectors which use the `client_credentials` grant type, where the user provides the Client ID and Client Secret at the point where they connect, should use the `AuthSchemeConfigOAuth2ClientCredentials` type instead. type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' - type: object properties: authorizeUrl: type: string format: uri description: > AuthorizeURL is the URL which the user will be redirected to in order to authorize the application. x-go-name: AuthorizeURL x-go-type-skip-optional-pointer: true tokenUrl: type: string format: uri description: > TokenURL is the URL which the application will use to issue an access token. x-go-name: TokenURL scopes: description: > Scopes is the list of all OAuth2 scopes which the application supports. The user will be allowed to choose which scopes to request when configuring the Connection. type: array items: $ref: '#/components/schemas/OAuth2Scope' defaultScopes: description: > DefaultScopes is the list of scopes which will be requested by default when the user connects the Connector. This is useful for Connectors which require a specific set of scopes to function correctly. type: array items: type: string additionalAuthorizeParams: description: > AdditionalAuthorizeParams is a URL-encoded query string which should be attached to the AuthorizeURL when the user is redirected to the OAuth 2.0 authorization endpoint. This value is only used by the UI to drive the default values when connecting, the API to `InitialiseOAuth2Connection` can be provided a different value if required. type: string x-go-type-skip-optional-pointer: true additionalTokenParams: description: > AdditionalTokenParams is a URL-encoded string following the `application/x-www-form-urlencoded` mime-type, which can be used to pass additional parameters to the OAuth 2.0 token endpoint within the request body. type: string x-go-type-skip-optional-pointer: true mtlsEnabled: type: boolean description: > MTLSEnabled is a flag which determines whether the Connector should use Mutual TLS (mTLS) to authenticate with the OAuth 2.0 token endpoint. This is useful for Connectors which require a higher level of security. x-go-name: MTLSEnabled x-go-type-skip-optional-pointer: true mtlsCredentialId: type: string description: > MTLSCredentialID is the unique identifier of the Credential which contains the client certificate and private key to be used as part of the mTLS connection. This may be unset when creating a connection, in which case if `mtlsEnabled` is true, then the API will find an associated AuthSchemeConfigCertificate and link them automatically. x-go-name: MTLSCredentialID pkce: type: boolean x-go-type-skip-optional-pointer: true grant: $ref: '#/components/schemas/AuthSchemeConfigOAuth2Grant' required: - tokenUrl - scopes - defaultScopes - grant AuthSchemeConfigOAuth1: title: OAuth 2.0 type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' - type: object properties: tokenAuth: type: boolean description: > If set to 'true' the endpoints are optional but when connecting you need to use oauth1-token credentials and provide the token and token secret. If left empty or set to 'false' you need to provide all the endpoint and connect using the oauth1 credentials which uses the browser authorize flow. x-go-type-skip-optional-pointer: true consumerKey: type: string consumerSecret: type: string tempCredentialEndpoint: $ref: '#/components/schemas/Endpoint' resourceOwnerAuthorizationEndpoint: $ref: '#/components/schemas/Endpoint' tokenEndpoint: $ref: '#/components/schemas/Endpoint' signatureMethod: type: string description: One of 'sha256', 'sha1' credentialId: type: string format: ulid x-go-type: ulid.ULID x-go-name: CredentialID x-go-type-import: path: versori.dev/vergo/ulid x-go-type-skip-optional-pointer: true required: - consumerKey - consumerSecret - signatureMethod AuthSchemeConfigHMAC: title: HMAC description: > AuthSchemeConfigHMAC defines how a Connector uses an HMAC credential to authenticate with the system. This may be used on outbound requests to sign the request body, however it is more commonly used on inbound requests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger. type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' - type: object properties: name: type: string description: >- Name is the query parameter/header/cookie name which will be used to send the signature. in: $ref: '#/components/schemas/AuthSchemeConfigHMACIn' algorithm: description: >- AuthSchemeConfigHMACAlgorithm defines the hashing algorithm to use when generating the HMAC signature. type: string enum: - sha1 - sha256 - sha512 digestInputs: description: > AuthSchemeConfigHMACInputs defines what parts of a HTTP request are consumed to generate the HMAC signature. Some systems only generate the signature from the request body, others may include the URL. The order of this array defines the order in which the input is fed into the hashing function. type: array items: type: string enum: - body - url encoding: description: > Encoding defines how the HMAC signature was encoded. This can be one of `hex`, `base64` or `base64url`. type: string enum: - hex - base64 - base64url required: - name - in - algorithm - digestInputs - encoding AuthSchemeConfigCertificate: title: TLS Certificate description: > AuthSchemeConfigCertificate is a placeholder object with the schemeType set to `certificate`. There is no other config required type: object allOf: - $ref: '#/components/schemas/AuthSchemeConfigBase' CredentialType: description: > CredentialType denotes the type of the credential which determines what the Credential's `data` property will contain. - none: No credential is required to authenticate with the Connector. - string: The credential is a string value, such as an API key or password. - binary: The credential is a binary value, such as a private key, certificate or other file. - basic-auth: The credential is a username and password to be used for basic authentication. - oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication. - oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token. - oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication. - oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication. - oauth1: The credential is an OAuth1 access_token to be used for OAuth1 authentication. - oauth1-token: The credential is the oatuh1 token allowing bypassing the user authorization step. - certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication. type: string enum: - none - string - binary - basic-auth - oauth2-client - oauth1 - oauth1-token - oauth2-code - oauth2-password - oauth2-token - certificate x-go-type-skip-optional-pointer: true CredentialData: type: object properties: binary: $ref: '#/components/schemas/CredentialDataBinary' none: $ref: '#/components/schemas/CredentialDataNone' string: $ref: '#/components/schemas/CredentialDataString' basicAuth: $ref: '#/components/schemas/CredentialDataBasicAuth' oauth2Client: $ref: '#/components/schemas/CredentialDataOAuth2Client' oauth2Token: $ref: '#/components/schemas/CredentialDataOAuth2Token' oauth2Code: $ref: '#/components/schemas/CredentialDataOAuth2Code' oauth2Password: $ref: '#/components/schemas/CredentialDataOAuth2Password' certificate: $ref: '#/components/schemas/CredentialDataCertificate' oauth1: $ref: '#/components/schemas/CredentialDataOAuth1' oauth1Token: $ref: '#/components/schemas/CredentialDataOAuth1Token' AuthSchemeConfigBase: type: object properties: id: type: string format: ulid description: > ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained. x-go-name: ID description: description: > Description enables users to distinguish multiple configurations which use the same schemeType. type: string validationMessages: description: > ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig. This field will be ignored if sent to the API. type: array items: $ref: '#/components/schemas/Message' x-go-type-skip-optional-pointer: true required: - id - description AuthSchemeConfigAPIKeyIn: description: > AuthSchemeConfigAPIKeyIn defines the location of the API key in the request. type: string enum: - query - header - cookie OAuth2Scope: description: > OAuth2Scope represents a single scope which can be requested by an OAuth2 application. type: object properties: name: type: string description: > Name is the name of the scope as determined by the application to which this Connector is connecting to. description: type: string description: > Description describes the scope in human-friendly terminology. This text may be displayed to users via a help tooltip or similar. x-go-type-skip-optional-pointer: true required: - name AuthSchemeConfigOAuth2Grant: type: object properties: authorizationCode: $ref: '#/components/schemas/AuthSchemeConfigOAuth2GrantAuthorizationCode' clientCredentials: $ref: '#/components/schemas/AuthSchemeConfigOAuth2GrantClientCredentials' password: $ref: '#/components/schemas/AuthSchemeConfigOAuth2GrantPassword' type: $ref: '#/components/schemas/AuthSchemeConfigOAuth2GrantType' required: - type Endpoint: type: object properties: url: type: string description: URL of the endpoint, may contain templated values in curly braces additionalParamConfigs: type: array items: $ref: '#/components/schemas/ParameterConfig' x-go-type-skip-optional-pointer: true parameterTransmission: type: string enum: - AUTH_STYLE_AUTHORIZATION_HEADER - AUTH_STYLE_FORM - AUTH_STYLE_QUERY required: - url AuthSchemeConfigHMACIn: description: >- AuthSchemeConfigHMACIn defines where the signature should be set on requests. type: string enum: - query - header - cookie CredentialDataBinary: title: Binary description: > CredentialDataBinary is commonly used to store non-string data such as binary files or encryption keys. This value will be redacted when returned in a response. type: object properties: valueBase64: type: string description: > Value is a base64 encoded string containing the credential data. This could decode to a valid utf-8 string, or it could decode to a binary file such as a private key etc. When read from the API this field will be redacted. required: - valueBase64 CredentialDataNone: title: None description: > CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes. type: object additionalProperties: false CredentialDataString: title: String description: > CredentialDataString contains a string value and nothing else and is commonly used for API keys. This value will be redacted when returned in a response. type: object properties: value: type: string description: > Value is a UTF-8 string containing the credential data. When read from the API this field will be redacted. required: - value CredentialDataBasicAuth: title: Username/Password description: > CredentialDataBasicAuth contains the username and password required to authenticate with the Connector. The `password` property will be redacted when returned in a response. type: object properties: username: type: string description: Username is the username used to authenticate with the Connector. password: type: string description: > Password is the password used to authenticate with the Connector. Will be redacted when returned in a response. required: - username - password CredentialDataOAuth2Client: title: OAuth 2.0 Client description: > CredentialDataOAuth2Client contains the OAuth2 client credentials required to either issue an access token from a refresh_token, or via the `client_credentials` and `authorization_code` grant types. The `clientSecret` property will be redacted when returned in a response. type: object properties: clientId: type: string description: > ClientID is the OAuth2 client ID used to authenticate with the Connector. x-go-name: ClientID clientSecret: type: string description: > ClientSecret is the OAuth2 client secret used to authenticate with the Connector. Will be redacted when returned in a response. tokenUrl: type: string format: uri description: >- TokenURL is the URL which the application will use to issue an access token. x-go-name: TokenURL scopes: type: array items: type: string description: > Scopes is a list of scopes which should be requested when issuing an access token. This is only required if this credential is being used on a `client_credentials` grant type, for `authorization_code` grant types the requested scopes come from the `CredentialDataOAuth2Token` credential. x-go-type-skip-optional-pointer: true additionalParams: description: > AdditionalParams is a URL-encoded query string which can be used to pass additional parameters to the OAuth 2.0 token endpoint. These parameters are attached to the body in the formatted as the `application/x-www-form-urlencoded` content-type. type: string x-go-type-skip-optional-pointer: true mTLSEnabled: type: boolean description: > MTLSEnabled is a boolean flag which determines whether the client should use mutual TLS authentication when communicating with the OAuth2 provider. If enabled, the `mTLSCredentialId` field must be set, or it must be created via the `CreateConnection` endpoint with an associated mTLS credential defined beforehand, in which case the mTLSCredentialID field will be populated upon saving by the API. x-go-type-skip-optional-pointer: true mTLSCredentialId: type: string description: > MTLSCredentialID is an optional reference to another credential being created. If set the certificate credential will be used when making a request to the tokenUrl. x-go-name: MTLSCredentialID x-go-type-skip-optional-pointer: true required: - clientId - clientSecret - tokenUrl CredentialDataOAuth2Token: title: OAuth 2.0 Token description: > CredentialDataOAuth2Token is primarily used to store the refresh_token for an user who has authorized an OAuth2 Application to access their data. However, this information is not exposed publicly and the only data visible via the API are the `scopes` which the user has granted consent for. This can be used to determine whether the user should be prompted to re-authorize the application with additional scopes in the event they choose to use a new endpoint which requires additional scopes to what they've already consented to. type: object properties: scopes: type: array items: type: string description: Scopes is a list of scopes which the user has granted consent for. accessToken: type: string description: > AccessToken is the OAuth2 access token which can be used to authenticate with the Connector. This information is redacted when read from the API. x-go-type-skip-optional-pointer: true tokenType: type: string description: > TokenType is the type of token which is being issued. Defaults to "Bearer" if not set. default: Bearer x-go-type-skip-optional-pointer: true expiresAt: type: string format: date-time description: > ExpiresAt is the time at which the access token will expire. If not defined, the accessToken will be reused until a 401 response is received from the Connector, at which point the token should be refreshed with the provided `refreshToken`. Ideally this should be provided so that erroneous failures can be avoided. x-go-type-skip-optional-pointer: true refreshToken: type: string description: > RefreshToken is the OAuth2 refresh token which can be used to issue new access tokens. This information is redacted when read from the API. This is a required field as it is used to refresh the access token when it expires. If users are providing an access token which does not expire using this credential type, then the same functionality may be achieved by using a simple API key and OAuth 2.0 need not be used. required: - scopes - refreshToken CredentialDataOAuth2Code: title: OAuth 2.0 Code description: > CredentialDataOAuth2Code is used to exchange an authorization code for an access token and is denoted by the `oauth2-code` type. This is only used when creating or updating an OAuth 2.0 connection using the `authorization_code` grant type. Retrieving this credential will return a payload of type `oauth2-token` in the shape of a `CredentialDataOAuth2Token` object. type: object properties: code: description: > Code is the authorization code which will be exchanged for an access token. type: string state: description: > State is the state value which is propagated through the OAuth2 flow. type: string additionalParams: description: > AdditionalParams is a URL-encoded query string which can be used to pass additional parameters to the OAuth 2.0 token endpoint. These parameters are attached to the body in the formatted as the `application/x-www-form-urlencoded` content-type. type: string x-go-type-skip-optional-pointer: true required: - code - state CredentialDataOAuth2Password: title: OAuth 2.0 Password description: > CredentialDataOAuth2Password contains the username and password of a Resource Owner within an OAuth 2.0 application. The `password` property will be redacted when returned in a response. type: object properties: username: type: string description: Username is the username used to authenticate with the Connector. password: type: string description: > Password is the password used to authenticate with the Connector. Will be redacted when returned in a response. required: - username - password CredentialDataCertificate: title: Certificate description: > CredentialDataCertificate contains the Certificate, Certificate key and CA(Certificate authority). type: object properties: certificate: type: string description: Certificate is the certificate that will be send to the connection. key: type: string description: Key is the accompanying key for the certificate. ca: type: string description: >- CA is the Certificate Authority to verify the server certificates against. required: - certificate - key - ca CredentialDataOAuth1: title: OAuth1 type: object properties: state: type: string oauthToken: type: string oauthVerifier: type: string required: - oauthVerifier - oauthToken - state CredentialDataOAuth1Token: title: OAuth1Token type: object properties: token: type: string tokenSecret: type: string additionalParams: type: array items: $ref: '#/components/schemas/AdditionalParam' x-go-type-skip-optional-pointer: true required: - token - tokenSecret Message: description: > Message is a message to be displayed to the user to indicate some information about the preceding request. type: object properties: text: description: Text contains the text of the message. type: string severity: $ref: '#/components/schemas/MessageSeverity' detail: description: > Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors. type: array items: type: string x-go-type-skip-optional-pointer: true required: - text - severity AuthSchemeConfigOAuth2GrantAuthorizationCode: title: authorization_code description: > AuthSchemeConfigOAuth2GrantAuthorizationCode contains grant-specific configuration for the `authorization_code` grant type. How the API manages changes to this configuration is as follows: - CredentialID and OrganisationID are not set, a new credential is created containing the sensitive information and the non-sensitive information is updated in the database. - Otherwise, both the credential and the database are updated using JSON Merge Patch, with undefined properties not being updated. - Any other permutation will result in a 400 Bad Request. type: object properties: credentialId: description: > CredentialID is the unique identifier of the Credential which contains the client ID and client secret to be used as part of the `password` flow. type: string format: ulid x-go-name: CredentialID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid x-go-type-skip-optional-pointer: true organisationId: description: > OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different to the Connector's OrganisationID since some may be imported from Versori's public library. type: string format: ulid x-go-name: OrganisationID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid x-go-type-skip-optional-pointer: true clientId: description: > ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the user in plaintext. type: string x-go-name: ClientID clientSecret: description: > ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the user. type: string required: - grantType AuthSchemeConfigOAuth2GrantClientCredentials: title: client_credentials type: object AuthSchemeConfigOAuth2GrantPassword: title: password description: > AuthSchemeConfigOAuth2GrantPassword contains grant-specific configuration for the `password` grant type. How the API manages changes to this configuration is as follows: - CredentialID and OrganisationID are not set, a new credential is created containing the sensitive information and the non-sensitive information is created/updated in the database. - Otherwise, both the credential and the database are updated using JSON Merge Patch. - Any other permutation will result in a 400 Bad Request. type: object properties: credentialId: description: > CredentialID is the unique identifier of the Credential which contains the client ID and client secret to be used as part of the `password` flow. type: string format: ulid x-go-name: CredentialID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid x-go-type-skip-optional-pointer: true organisationId: description: > OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different to the Connector's OrganisationID since some may be imported from Versori's public library. type: string format: ulid x-go-name: OrganisationID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid x-go-type-skip-optional-pointer: true clientId: description: > ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the user in plaintext. type: string x-go-name: ClientID clientSecret: description: > ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the user. It may be populated when updating the Credential. type: string required: - grantType AuthSchemeConfigOAuth2GrantType: type: string enum: - authorizationCode - clientCredentials - password ParameterConfig: type: object properties: parameterName: type: string description: Key of the additional parameter to insert targetName: type: string description: Override name for the parameter in endpoint requests x-go-type-skip-optional-pointer: true location: type: string enum: - LOCATION_IGNORE - LOCATION_BODY - LOCATION_HEADER - LOCATION_QUERY - LOCATION_ENDPOINT - LOCATION_HEADER_PARAMETER usages: type: string enum: - USAGE_UNKNOWN - USAGE_TEMP_CREDENTIAL_ENDPOINT - USAGE_TOKEN_REQUEST_ENDPOINT required: type: boolean description: Whether parameter is required in requests modifiable: type: boolean description: Whether parameter can be modified by user required: - location - usage - required - modifiable - parameterName AdditionalParam: type: object properties: name: type: string value: type: string required: - name MessageSeverity: type: string enum: - info - warning - error securitySchemes: bearerToken: description: > Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP. type: http scheme: bearer cookie: description: Cookie authentication used by the Versori Platform. type: apiKey in: cookie name: cookie ````