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.
Labels is a map of key-value pairs that can be used to store arbitrary metadata about a resource.
Keys must start with a letter and can only contain letters, numbers, and underscores.
Values can be any string.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Versori User Documentation","colors":{"primary":"#6EB0D8","light":"#6EB0D8","dark":"#6EB0D8"},"logo":{"light":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af","dark":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark-white.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1568a99dadb6fa8dfc83009eba877497"},"favicon":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1765cb3e4363526dd85cf7c576a8f68f","api":{"openapi":["openapi/connect-api-v1.yaml","openapi/embedded-api-v1.yaml","openapi/organisations-api-v1.yaml","openapi/switchboard-api-v1alpha1.yaml","openapi/platform-api.yaml"],"playground":{"display":"interactive","proxy":false},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":["https://platform.versori.com/api"]}},"background":{"decoration":"gradient","color":{"light":"#ffffff","dark":"#151919"}},"search":{"prompt":"Search the docs..."},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"versori","hasAudioNarration":false,"actualSubdomain":"versori","customDomains":["docs.versori.com"],"gitSource":{"type":"github","owner":"versori","repo":"user-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad09d9413e5d952c6a7407c","collectionId":"314b2d25-0631-41c2-aeae-fdf8104d942c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad09d9413e5d952c6a7407c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad09d9413e5d952c6a7407c","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":525},{"language":"default","tag":"Platform API","count":115},{"language":"default","tag":"Switchboard API","count":82},{"language":"default","tag":"Endpoints","count":62},{"language":"default","tag":"Connect API","count":41},{"language":"default","tag":"Organisations API","count":38},{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"projects","count":32},{"language":"default","tag":"User Guide","count":31},{"language":"default","tag":"CLI","count":27}]},"assistantConfig":{},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area.max-w-xl{max-width:64rem}.whitespace-pre-line{white-space:unset}"}],"page":{"pagePath":"v2/api-reference/systems/create-a-new-system","slug":"/v2/api-reference/systems/create-a-new-system","pageMetadata":{"openapi":"post /o/{organisation_id}/systems","title":"Create a new system.","description":null,"href":"/v2/api-reference/systems/create-a-new-system"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /o/{organisation_id}/systems","title":"Create a new system.","description":null,"href":"/v2/api-reference/systems/create-a-new-system"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"CreateSystem","summary":"Create a new system.","tags":["systems"],"requestBody":"c8ff2887-2b3c-4275-9661-8970a03fff1c","responses":{"201":"ce4deac5-b47f-4cf2-9c5a-6d33d31bb633","default":"75c069ad-b136-4106-ad09-1d6d23e01220"},"method":"post","type":"path","servers":["d0eac863-e307-4ad7-a239-2c447e8ba4c0","0bedeed1-5e05-4d49-a0f1-0acdda0da1fe","731967af-8899-446e-b2cf-c9e6c5801b84"],"security":["ad977c79-c846-4804-9548-4d09cb6f8f14","b1012d3e-47bf-44f7-b929-7fdf4592103d"],"path":"/o/{organisation_id}/systems","baseUrlOptions":["https://platform.versori.com/api/v2","https://platform-staging.versori.com/api/v2","http://localhost:8901"],"title":"Create a new system.","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"aec20e87-5bb4-43ac-be81-8aaf72cbf019":{"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"},"isRequired":true,"uniqueKey":"","typeLabel":"string\u003culid>"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"domain":{"type":"string","isRequired":true,"uniqueKey":"domain","typeLabel":"string"},"templateBaseUrl":{"type":"string","isRequired":true,"uniqueKey":"templateBaseUrl","typeLabel":"string"},"authSchemeConfigs":{"type":"array","items":{"type":"object","description":"An AuthSchemeConfig describes how credentials should be used to authenticate with a System, an example being where\nan API key should be sent and what the header/query parameter/cookie name is. For OAuth2, this config object also\ncontains data such as the token URL, client ID and secret, and scopes to request.\nThis type contains a string called `type` which denotes which field in this object should be populated.\nFor example if the `type` is `api-key`, then the `apiKey` field will be populated with an\n`AuthSchemeConfigAPIKey` object.\n","properties":{"type":{"description":"Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see\nenum values for possible options.\n","type":"string","enum":["none","api-key","basic-auth","oauth2","hmac","jwt-bearer","certificate","oauth1","secret"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"none":{"type":"object","title":"None","description":"AuthSchemeConfigNone is a placeholder object with the schemeType set to `none`. There is no other configuration\nrequired.\n","required":["id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.description","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].none","typeLabel":"None · object"},"apiKey":{"type":"object","title":"API Key","description":"AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system.\n","required":["name","in","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.description","typeLabel":"string"},"name":{"type":"string","description":"Name is the query parameter/header/cookie name which will be used to send the API key.","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigAPIKeyIn defines the location of the API key in the request.\n","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.in","typeLabel":"enum\u003cstring>"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey","typeLabel":"API Key · object"},"basicAuth":{"type":"object","title":"Basic Auth","description":"AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to `basic-auth`. There is no other\nconfiguration required.\n","required":["id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.description","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth","typeLabel":"Basic Auth · object"},"oauth2":{"type":"object","title":"OAuth 2.0","description":"AuthSchemeConfigOAuth2 defines how a Connector uses an OAuth2 credential to authenticate\nwith the system. This is to be used for all OAuth 2.0 flows which require a client ID and\nclient secret as part of the Connector's configuration. Connectors which use the\n`client_credentials` grant type, where the user provides the Client ID and Client Secret at\nthe point where they connect, should use the `AuthSchemeConfigOAuth2ClientCredentials` type\ninstead.\n","required":["tokenUrl","scopes","defaultScopes","grant","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.description","typeLabel":"string"},"tokenUrl":{"type":"string","format":"uri","description":"TokenURL is the URL which the application will use to issue an access token.\n","x-go-name":"TokenURL","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.tokenUrl","typeLabel":"string\u003curi>"},"scopes":{"description":"Scopes is the list of all OAuth2 scopes which the application supports. The user\nwill be allowed to choose which scopes to request when configuring the Connection.\n","type":"array","items":{"description":"OAuth2Scope represents a single scope which can be requested by an OAuth2 application.\n","type":"object","properties":{"name":{"type":"string","description":"Name is the name of the scope as determined by the application to which this Connector\nis connecting to.\n","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Description describes the scope in human-friendly terminology. This text may be\ndisplayed to users via a help tooltip or similar.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes","typeLabel":"object[]"},"defaultScopes":{"description":"DefaultScopes is the list of scopes which will be requested by default when the user\nconnects the Connector. This is useful for Connectors which require a specific set\nof scopes to function correctly.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.defaultScopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.defaultScopes","typeLabel":"string[]"},"grant":{"type":"object","properties":{"type":{"type":"string","enum":["authorizationCode","clientCredentials","password"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.type","typeLabel":"enum\u003cstring>"},"authorizationCode":{"title":"authorization_code","description":"AuthSchemeConfigOAuth2GrantAuthorizationCode contains grant-specific configuration for the\n`authorization_code` grant type.\n\nHow the API manages changes to this configuration is as follows:\n\n- CredentialID and OrganisationID are not set, a new credential is created containing the\n sensitive information and the non-sensitive information is updated in the database.\n- Otherwise, both the credential and the database are updated using JSON Merge Patch, with\n undefined properties not being updated.\n- Any other permutation will result in a 400 Bad Request.\n","type":"object","properties":{"credentialId":{"description":"CredentialID is the unique identifier of the Credential which contains the client ID and\nclient secret to be used as part of the `password` flow.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.credentialId","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation that owns the Credential.\nThis can be different to the Connector's OrganisationID since some may be imported from\nVersori's public library.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.organisationId","typeLabel":"string\u003culid>"},"clientId":{"description":"ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be\npresented to the user in plaintext.\n","type":"string","x-go-name":"ClientID","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.clientId","typeLabel":"string"},"clientSecret":{"description":"ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be\ndisplayed to the user.\n","type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.clientSecret","typeLabel":"string"}},"required":["grantType"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode","typeLabel":"authorization_code · object"},"clientCredentials":{"title":"client_credentials","type":"object","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.clientCredentials","typeLabel":"client_credentials · object"},"password":{"title":"password","description":"AuthSchemeConfigOAuth2GrantPassword contains grant-specific configuration for the `password`\ngrant type.\n\nHow the API manages changes to this configuration is as follows:\n\n- CredentialID and OrganisationID are not set, a new credential is created containing the\n sensitive information and the non-sensitive information is created/updated in the\n database.\n- Otherwise, both the credential and the database are updated using JSON Merge Patch.\n- Any other permutation will result in a 400 Bad Request.\n","type":"object","properties":{"credentialId":{"description":"CredentialID is the unique identifier of the Credential which contains the client ID and\nclient secret to be used as part of the `password` flow.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.credentialId","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different\nto the Connector's OrganisationID since some may be imported from Versori's public library.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.organisationId","typeLabel":"string\u003culid>"},"clientId":{"description":"ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the\nuser in plaintext.\n","type":"string","x-go-name":"ClientID","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.clientId","typeLabel":"string"},"clientSecret":{"description":"ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the\nuser. It may be populated when updating the Credential.\n","type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.clientSecret","typeLabel":"string"}},"required":["grantType"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password","typeLabel":"password · object"}},"required":["type"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant","typeLabel":"object"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages","typeLabel":"object[]"},"authorizeUrl":{"type":"string","format":"uri","description":"AuthorizeURL is the URL which the user will be redirected to in order to authorize\nthe application.\n","x-go-name":"AuthorizeURL","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.authorizeUrl","typeLabel":"string\u003curi>"},"additionalAuthorizeParams":{"description":"AdditionalAuthorizeParams is a URL-encoded query string which should be attached to\nthe AuthorizeURL when the user is redirected to the OAuth 2.0 authorization\nendpoint.\n\nThis value is only used by the UI to drive the default values when connecting, the\nAPI to `InitialiseOAuth2Connection` can be provided a different value if required.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.additionalAuthorizeParams","typeLabel":"string"},"additionalTokenParams":{"description":"AdditionalTokenParams is a URL-encoded string following the\n`application/x-www-form-urlencoded` mime-type, which can be used to pass additional\nparameters to the OAuth 2.0 token endpoint within the request body.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.additionalTokenParams","typeLabel":"string"},"mtlsEnabled":{"type":"boolean","description":"MTLSEnabled is a flag which determines whether the Connector should use Mutual TLS\n(mTLS) to authenticate with the OAuth 2.0 token endpoint. This is useful for\nConnectors which require a higher level of security.\n","x-go-name":"MTLSEnabled","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.mtlsEnabled","typeLabel":"boolean"},"mtlsCredentialId":{"type":"string","description":"MTLSCredentialID is the unique identifier of the Credential which contains the\nclient certificate and private key to be used as part of the mTLS connection.\n\nThis may be unset when creating a connection, in which case if `mtlsEnabled` is\ntrue, then the API will find an associated AuthSchemeConfigCertificate and link\nthem automatically.\n","x-go-name":"MTLSCredentialID","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.mtlsCredentialId","typeLabel":"string"},"pkce":{"type":"boolean","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.pkce","typeLabel":"boolean"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2","typeLabel":"OAuth 2.0 · object"},"oauth1":{"type":"object","title":"OAuth 2.0","required":["consumerKey","consumerSecret","signatureMethod","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.description","typeLabel":"string"},"consumerKey":{"type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.consumerKey","typeLabel":"string"},"consumerSecret":{"type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.consumerSecret","typeLabel":"string"},"signatureMethod":{"type":"string","description":"One of 'sha256', 'sha1'","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.signatureMethod","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages","typeLabel":"object[]"},"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.\nIf 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.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenAuth","typeLabel":"boolean"},"tempCredentialEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"URL of the endpoint, may contain templated values in curly braces","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.url","typeLabel":"string"},"additionalParamConfigs":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string","description":"Key of the additional parameter to insert","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].parameterName","typeLabel":"string"},"location":{"type":"string","enum":["LOCATION_IGNORE","LOCATION_BODY","LOCATION_HEADER","LOCATION_QUERY","LOCATION_ENDPOINT","LOCATION_HEADER_PARAMETER"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether parameter is required in requests","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].required","typeLabel":"boolean"},"modifiable":{"type":"boolean","description":"Whether parameter can be modified by user","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].modifiable","typeLabel":"boolean"},"targetName":{"type":"string","description":"Override name for the parameter in endpoint requests","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].targetName","typeLabel":"string"},"usages":{"type":"string","enum":["USAGE_UNKNOWN","USAGE_TEMP_CREDENTIAL_ENDPOINT","USAGE_TOKEN_REQUEST_ENDPOINT"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].usages","typeLabel":"enum\u003cstring>"}},"required":["location","usage","required","modifiable","parameterName"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs","typeLabel":"object[]"},"parameterTransmission":{"type":"string","enum":["AUTH_STYLE_AUTHORIZATION_HEADER","AUTH_STYLE_FORM","AUTH_STYLE_QUERY"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.parameterTransmission","typeLabel":"enum\u003cstring>"}},"required":["url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint","typeLabel":"object"},"resourceOwnerAuthorizationEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"URL of the endpoint, may contain templated values in curly braces","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.url","typeLabel":"string"},"additionalParamConfigs":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string","description":"Key of the additional parameter to insert","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].parameterName","typeLabel":"string"},"location":{"type":"string","enum":["LOCATION_IGNORE","LOCATION_BODY","LOCATION_HEADER","LOCATION_QUERY","LOCATION_ENDPOINT","LOCATION_HEADER_PARAMETER"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether parameter is required in requests","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].required","typeLabel":"boolean"},"modifiable":{"type":"boolean","description":"Whether parameter can be modified by user","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].modifiable","typeLabel":"boolean"},"targetName":{"type":"string","description":"Override name for the parameter in endpoint requests","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].targetName","typeLabel":"string"},"usages":{"type":"string","enum":["USAGE_UNKNOWN","USAGE_TEMP_CREDENTIAL_ENDPOINT","USAGE_TOKEN_REQUEST_ENDPOINT"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].usages","typeLabel":"enum\u003cstring>"}},"required":["location","usage","required","modifiable","parameterName"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs","typeLabel":"object[]"},"parameterTransmission":{"type":"string","enum":["AUTH_STYLE_AUTHORIZATION_HEADER","AUTH_STYLE_FORM","AUTH_STYLE_QUERY"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.parameterTransmission","typeLabel":"enum\u003cstring>"}},"required":["url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint","typeLabel":"object"},"tokenEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"URL of the endpoint, may contain templated values in curly braces","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.url","typeLabel":"string"},"additionalParamConfigs":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string","description":"Key of the additional parameter to insert","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].parameterName","typeLabel":"string"},"location":{"type":"string","enum":["LOCATION_IGNORE","LOCATION_BODY","LOCATION_HEADER","LOCATION_QUERY","LOCATION_ENDPOINT","LOCATION_HEADER_PARAMETER"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether parameter is required in requests","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].required","typeLabel":"boolean"},"modifiable":{"type":"boolean","description":"Whether parameter can be modified by user","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].modifiable","typeLabel":"boolean"},"targetName":{"type":"string","description":"Override name for the parameter in endpoint requests","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].targetName","typeLabel":"string"},"usages":{"type":"string","enum":["USAGE_UNKNOWN","USAGE_TEMP_CREDENTIAL_ENDPOINT","USAGE_TOKEN_REQUEST_ENDPOINT"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].usages","typeLabel":"enum\u003cstring>"}},"required":["location","usage","required","modifiable","parameterName"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs","typeLabel":"object[]"},"parameterTransmission":{"type":"string","enum":["AUTH_STYLE_AUTHORIZATION_HEADER","AUTH_STYLE_FORM","AUTH_STYLE_QUERY"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.parameterTransmission","typeLabel":"enum\u003cstring>"}},"required":["url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint","typeLabel":"object"},"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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.credentialId","typeLabel":"string\u003culid>"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1","typeLabel":"OAuth 2.0 · object"},"hmac":{"type":"object","title":"HMAC","description":"AuthSchemeConfigHMAC defines how a Connector uses an HMAC credential to authenticate with the system.\n\nThis may be used on outbound requests to sign the request body, however it is more commonly used on inbound\nrequests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger.\n","required":["name","in","algorithm","digestInputs","encoding","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.description","typeLabel":"string"},"name":{"type":"string","description":"Name is the query parameter/header/cookie name which will be used to send the signature.","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigHMACIn defines where the signature should be set on requests.","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.in","typeLabel":"enum\u003cstring>"},"algorithm":{"description":"AuthSchemeConfigHMACAlgorithm defines the hashing algorithm to use when generating the HMAC signature.","type":"string","enum":["sha1","sha256","sha512"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.algorithm","typeLabel":"enum\u003cstring>"},"digestInputs":{"description":"AuthSchemeConfigHMACInputs defines what parts of a HTTP request are consumed to generate the HMAC signature. Some systems\nonly generate the signature from the request body, others may include the URL. The order of this array\ndefines the order in which the input is fed into the hashing function.\n","type":"array","items":{"type":"string","enum":["body","url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.digestInputs.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.digestInputs","typeLabel":"enum\u003cstring>[]"},"encoding":{"description":"Encoding defines how the HMAC signature was encoded. This can be one of `hex`, `base64` or `base64url`.\n","type":"string","enum":["hex","base64","base64url"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.encoding","typeLabel":"enum\u003cstring>"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac","typeLabel":"HMAC · object"},"certificate":{"type":"object","title":"TLS Certificate","description":"AuthSchemeConfigCertificate is a placeholder object with the schemeType set to `certificate`.\nThere is no other config required\n","required":["id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.description","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate","typeLabel":"TLS Certificate · object"}},"required":["type"],"uniqueKey":"authSchemeConfigs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"authSchemeConfigs","typeLabel":"object[]"},"labels":{"type":"object","description":"Labels is a map of key-value pairs that can be used to store arbitrary metadata about a resource.\nKeys must start with a letter and can only contain letters, numbers, and underscores.\nValues can be any string.\n","x-go-type":"map[string]string","x-go-type-skip-optional-pointer":true,"uniqueKey":"labels","typeLabel":"object"}},"required":["name","authSchemeConfigs","domain","templateBaseUrl"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","domain":"\u003cstring>","templateBaseUrl":"\u003cstring>","authSchemeConfigs":[{}],"labels":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ce4deac5-b47f-4cf2-9c5a-6d33d31bb633":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"ulid","x-go-type":"ulid.ULID","x-go-type-skip-optional-pointer":true,"x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-name":"ID","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003culid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"domain":{"type":"string","isRequired":true,"uniqueKey":"domain","typeLabel":"string"},"authSchemeConfigs":{"description":"","type":"array","items":{"type":"object","description":"An AuthSchemeConfig describes how credentials should be used to authenticate with a System, an example being where\nan API key should be sent and what the header/query parameter/cookie name is. For OAuth2, this config object also\ncontains data such as the token URL, client ID and secret, and scopes to request.\nThis type contains a string called `type` which denotes which field in this object should be populated.\nFor example if the `type` is `api-key`, then the `apiKey` field will be populated with an\n`AuthSchemeConfigAPIKey` object.\n","properties":{"type":{"description":"Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see\nenum values for possible options.\n","type":"string","enum":["none","api-key","basic-auth","oauth2","hmac","jwt-bearer","certificate","oauth1","secret"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"none":{"type":"object","title":"None","description":"AuthSchemeConfigNone is a placeholder object with the schemeType set to `none`. There is no other configuration\nrequired.\n","required":["id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.description","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].none.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].none","typeLabel":"None · object"},"apiKey":{"type":"object","title":"API Key","description":"AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system.\n","required":["name","in","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.description","typeLabel":"string"},"name":{"type":"string","description":"Name is the query parameter/header/cookie name which will be used to send the API key.","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigAPIKeyIn defines the location of the API key in the request.\n","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.in","typeLabel":"enum\u003cstring>"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].apiKey","typeLabel":"API Key · object"},"basicAuth":{"type":"object","title":"Basic Auth","description":"AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to `basic-auth`. There is no other\nconfiguration required.\n","required":["id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.description","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].basicAuth","typeLabel":"Basic Auth · object"},"oauth2":{"type":"object","title":"OAuth 2.0","description":"AuthSchemeConfigOAuth2 defines how a Connector uses an OAuth2 credential to authenticate\nwith the system. This is to be used for all OAuth 2.0 flows which require a client ID and\nclient secret as part of the Connector's configuration. Connectors which use the\n`client_credentials` grant type, where the user provides the Client ID and Client Secret at\nthe point where they connect, should use the `AuthSchemeConfigOAuth2ClientCredentials` type\ninstead.\n","required":["tokenUrl","scopes","defaultScopes","grant","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.description","typeLabel":"string"},"tokenUrl":{"type":"string","format":"uri","description":"TokenURL is the URL which the application will use to issue an access token.\n","x-go-name":"TokenURL","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.tokenUrl","typeLabel":"string\u003curi>"},"scopes":{"description":"Scopes is the list of all OAuth2 scopes which the application supports. The user\nwill be allowed to choose which scopes to request when configuring the Connection.\n","type":"array","items":{"description":"OAuth2Scope represents a single scope which can be requested by an OAuth2 application.\n","type":"object","properties":{"name":{"type":"string","description":"Name is the name of the scope as determined by the application to which this Connector\nis connecting to.\n","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Description describes the scope in human-friendly terminology. This text may be\ndisplayed to users via a help tooltip or similar.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.scopes","typeLabel":"object[]"},"defaultScopes":{"description":"DefaultScopes is the list of scopes which will be requested by default when the user\nconnects the Connector. This is useful for Connectors which require a specific set\nof scopes to function correctly.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.defaultScopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.defaultScopes","typeLabel":"string[]"},"grant":{"type":"object","properties":{"type":{"type":"string","enum":["authorizationCode","clientCredentials","password"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.type","typeLabel":"enum\u003cstring>"},"authorizationCode":{"title":"authorization_code","description":"AuthSchemeConfigOAuth2GrantAuthorizationCode contains grant-specific configuration for the\n`authorization_code` grant type.\n\nHow the API manages changes to this configuration is as follows:\n\n- CredentialID and OrganisationID are not set, a new credential is created containing the\n sensitive information and the non-sensitive information is updated in the database.\n- Otherwise, both the credential and the database are updated using JSON Merge Patch, with\n undefined properties not being updated.\n- Any other permutation will result in a 400 Bad Request.\n","type":"object","properties":{"credentialId":{"description":"CredentialID is the unique identifier of the Credential which contains the client ID and\nclient secret to be used as part of the `password` flow.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.credentialId","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation that owns the Credential.\nThis can be different to the Connector's OrganisationID since some may be imported from\nVersori's public library.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.organisationId","typeLabel":"string\u003culid>"},"clientId":{"description":"ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be\npresented to the user in plaintext.\n","type":"string","x-go-name":"ClientID","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.clientId","typeLabel":"string"},"clientSecret":{"description":"ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be\ndisplayed to the user.\n","type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode.clientSecret","typeLabel":"string"}},"required":["grantType"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.authorizationCode","typeLabel":"authorization_code · object"},"clientCredentials":{"title":"client_credentials","type":"object","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.clientCredentials","typeLabel":"client_credentials · object"},"password":{"title":"password","description":"AuthSchemeConfigOAuth2GrantPassword contains grant-specific configuration for the `password`\ngrant type.\n\nHow the API manages changes to this configuration is as follows:\n\n- CredentialID and OrganisationID are not set, a new credential is created containing the\n sensitive information and the non-sensitive information is created/updated in the\n database.\n- Otherwise, both the credential and the database are updated using JSON Merge Patch.\n- Any other permutation will result in a 400 Bad Request.\n","type":"object","properties":{"credentialId":{"description":"CredentialID is the unique identifier of the Credential which contains the client ID and\nclient secret to be used as part of the `password` flow.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.credentialId","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different\nto the Connector's OrganisationID since some may be imported from Versori's public library.\n","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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.organisationId","typeLabel":"string\u003culid>"},"clientId":{"description":"ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the\nuser in plaintext.\n","type":"string","x-go-name":"ClientID","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.clientId","typeLabel":"string"},"clientSecret":{"description":"ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the\nuser. It may be populated when updating the Credential.\n","type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password.clientSecret","typeLabel":"string"}},"required":["grantType"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant.password","typeLabel":"password · object"}},"required":["type"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.grant","typeLabel":"object"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.validationMessages","typeLabel":"object[]"},"authorizeUrl":{"type":"string","format":"uri","description":"AuthorizeURL is the URL which the user will be redirected to in order to authorize\nthe application.\n","x-go-name":"AuthorizeURL","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.authorizeUrl","typeLabel":"string\u003curi>"},"additionalAuthorizeParams":{"description":"AdditionalAuthorizeParams is a URL-encoded query string which should be attached to\nthe AuthorizeURL when the user is redirected to the OAuth 2.0 authorization\nendpoint.\n\nThis value is only used by the UI to drive the default values when connecting, the\nAPI to `InitialiseOAuth2Connection` can be provided a different value if required.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.additionalAuthorizeParams","typeLabel":"string"},"additionalTokenParams":{"description":"AdditionalTokenParams is a URL-encoded string following the\n`application/x-www-form-urlencoded` mime-type, which can be used to pass additional\nparameters to the OAuth 2.0 token endpoint within the request body.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.additionalTokenParams","typeLabel":"string"},"mtlsEnabled":{"type":"boolean","description":"MTLSEnabled is a flag which determines whether the Connector should use Mutual TLS\n(mTLS) to authenticate with the OAuth 2.0 token endpoint. This is useful for\nConnectors which require a higher level of security.\n","x-go-name":"MTLSEnabled","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.mtlsEnabled","typeLabel":"boolean"},"mtlsCredentialId":{"type":"string","description":"MTLSCredentialID is the unique identifier of the Credential which contains the\nclient certificate and private key to be used as part of the mTLS connection.\n\nThis may be unset when creating a connection, in which case if `mtlsEnabled` is\ntrue, then the API will find an associated AuthSchemeConfigCertificate and link\nthem automatically.\n","x-go-name":"MTLSCredentialID","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.mtlsCredentialId","typeLabel":"string"},"pkce":{"type":"boolean","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2.pkce","typeLabel":"boolean"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth2","typeLabel":"OAuth 2.0 · object"},"oauth1":{"type":"object","title":"OAuth 2.0","required":["consumerKey","consumerSecret","signatureMethod","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.description","typeLabel":"string"},"consumerKey":{"type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.consumerKey","typeLabel":"string"},"consumerSecret":{"type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.consumerSecret","typeLabel":"string"},"signatureMethod":{"type":"string","description":"One of 'sha256', 'sha1'","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.signatureMethod","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.validationMessages","typeLabel":"object[]"},"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.\nIf 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.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenAuth","typeLabel":"boolean"},"tempCredentialEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"URL of the endpoint, may contain templated values in curly braces","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.url","typeLabel":"string"},"additionalParamConfigs":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string","description":"Key of the additional parameter to insert","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].parameterName","typeLabel":"string"},"location":{"type":"string","enum":["LOCATION_IGNORE","LOCATION_BODY","LOCATION_HEADER","LOCATION_QUERY","LOCATION_ENDPOINT","LOCATION_HEADER_PARAMETER"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether parameter is required in requests","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].required","typeLabel":"boolean"},"modifiable":{"type":"boolean","description":"Whether parameter can be modified by user","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].modifiable","typeLabel":"boolean"},"targetName":{"type":"string","description":"Override name for the parameter in endpoint requests","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].targetName","typeLabel":"string"},"usages":{"type":"string","enum":["USAGE_UNKNOWN","USAGE_TEMP_CREDENTIAL_ENDPOINT","USAGE_TOKEN_REQUEST_ENDPOINT"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX].usages","typeLabel":"enum\u003cstring>"}},"required":["location","usage","required","modifiable","parameterName"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.additionalParamConfigs","typeLabel":"object[]"},"parameterTransmission":{"type":"string","enum":["AUTH_STYLE_AUTHORIZATION_HEADER","AUTH_STYLE_FORM","AUTH_STYLE_QUERY"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint.parameterTransmission","typeLabel":"enum\u003cstring>"}},"required":["url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tempCredentialEndpoint","typeLabel":"object"},"resourceOwnerAuthorizationEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"URL of the endpoint, may contain templated values in curly braces","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.url","typeLabel":"string"},"additionalParamConfigs":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string","description":"Key of the additional parameter to insert","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].parameterName","typeLabel":"string"},"location":{"type":"string","enum":["LOCATION_IGNORE","LOCATION_BODY","LOCATION_HEADER","LOCATION_QUERY","LOCATION_ENDPOINT","LOCATION_HEADER_PARAMETER"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether parameter is required in requests","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].required","typeLabel":"boolean"},"modifiable":{"type":"boolean","description":"Whether parameter can be modified by user","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].modifiable","typeLabel":"boolean"},"targetName":{"type":"string","description":"Override name for the parameter in endpoint requests","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].targetName","typeLabel":"string"},"usages":{"type":"string","enum":["USAGE_UNKNOWN","USAGE_TEMP_CREDENTIAL_ENDPOINT","USAGE_TOKEN_REQUEST_ENDPOINT"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX].usages","typeLabel":"enum\u003cstring>"}},"required":["location","usage","required","modifiable","parameterName"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.additionalParamConfigs","typeLabel":"object[]"},"parameterTransmission":{"type":"string","enum":["AUTH_STYLE_AUTHORIZATION_HEADER","AUTH_STYLE_FORM","AUTH_STYLE_QUERY"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint.parameterTransmission","typeLabel":"enum\u003cstring>"}},"required":["url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.resourceOwnerAuthorizationEndpoint","typeLabel":"object"},"tokenEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"URL of the endpoint, may contain templated values in curly braces","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.url","typeLabel":"string"},"additionalParamConfigs":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string","description":"Key of the additional parameter to insert","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].parameterName","typeLabel":"string"},"location":{"type":"string","enum":["LOCATION_IGNORE","LOCATION_BODY","LOCATION_HEADER","LOCATION_QUERY","LOCATION_ENDPOINT","LOCATION_HEADER_PARAMETER"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether parameter is required in requests","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].required","typeLabel":"boolean"},"modifiable":{"type":"boolean","description":"Whether parameter can be modified by user","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].modifiable","typeLabel":"boolean"},"targetName":{"type":"string","description":"Override name for the parameter in endpoint requests","x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].targetName","typeLabel":"string"},"usages":{"type":"string","enum":["USAGE_UNKNOWN","USAGE_TEMP_CREDENTIAL_ENDPOINT","USAGE_TOKEN_REQUEST_ENDPOINT"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX].usages","typeLabel":"enum\u003cstring>"}},"required":["location","usage","required","modifiable","parameterName"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.additionalParamConfigs","typeLabel":"object[]"},"parameterTransmission":{"type":"string","enum":["AUTH_STYLE_AUTHORIZATION_HEADER","AUTH_STYLE_FORM","AUTH_STYLE_QUERY"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint.parameterTransmission","typeLabel":"enum\u003cstring>"}},"required":["url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.tokenEndpoint","typeLabel":"object"},"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,"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1.credentialId","typeLabel":"string\u003culid>"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].oauth1","typeLabel":"OAuth 2.0 · object"},"hmac":{"type":"object","title":"HMAC","description":"AuthSchemeConfigHMAC defines how a Connector uses an HMAC credential to authenticate with the system.\n\nThis may be used on outbound requests to sign the request body, however it is more commonly used on inbound\nrequests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger.\n","required":["name","in","algorithm","digestInputs","encoding","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.description","typeLabel":"string"},"name":{"type":"string","description":"Name is the query parameter/header/cookie name which will be used to send the signature.","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigHMACIn defines where the signature should be set on requests.","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.in","typeLabel":"enum\u003cstring>"},"algorithm":{"description":"AuthSchemeConfigHMACAlgorithm defines the hashing algorithm to use when generating the HMAC signature.","type":"string","enum":["sha1","sha256","sha512"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.algorithm","typeLabel":"enum\u003cstring>"},"digestInputs":{"description":"AuthSchemeConfigHMACInputs defines what parts of a HTTP request are consumed to generate the HMAC signature. Some systems\nonly generate the signature from the request body, others may include the URL. The order of this array\ndefines the order in which the input is fed into the hashing function.\n","type":"array","items":{"type":"string","enum":["body","url"],"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.digestInputs.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.digestInputs","typeLabel":"enum\u003cstring>[]"},"encoding":{"description":"Encoding defines how the HMAC signature was encoded. This can be one of `hex`, `base64` or `base64url`.\n","type":"string","enum":["hex","base64","base64url"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.encoding","typeLabel":"enum\u003cstring>"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].hmac","typeLabel":"HMAC · object"},"certificate":{"type":"object","title":"TLS Certificate","description":"AuthSchemeConfigCertificate is a placeholder object with the schemeType set to `certificate`.\nThere is no other config required\n","required":["id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same\nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.description","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig\nis validated. This is typically used to provide feedback to the user when they are\ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate.validationMessages","typeLabel":"object[]"}},"uniqueKey":"authSchemeConfigs.items.[INDEX].certificate","typeLabel":"TLS Certificate · object"}},"required":["type"],"uniqueKey":"authSchemeConfigs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"authSchemeConfigs","typeLabel":"object[]"},"templateBaseUrl":{"type":"string","isRequired":true,"uniqueKey":"templateBaseUrl","typeLabel":"string"}},"required":["name","domain","templateBaseUrl","authSchemeConfigs","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","domain":"\u003cstring>","authSchemeConfigs":[{"type":"none","none":{"id":"\u003cstring>","description":"\u003cstring>","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"apiKey":{"id":"\u003cstring>","description":"\u003cstring>","name":"\u003cstring>","in":"query","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"basicAuth":{"id":"\u003cstring>","description":"\u003cstring>","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"oauth2":{"id":"\u003cstring>","description":"\u003cstring>","tokenUrl":"\u003cstring>","scopes":[{"name":"\u003cstring>","description":"\u003cstring>"}],"defaultScopes":["\u003cstring>"],"grant":{"type":"authorizationCode","authorizationCode":{"credentialId":"\u003cstring>","organisationId":"\u003cstring>","clientId":"\u003cstring>","clientSecret":"\u003cstring>"},"clientCredentials":{},"password":{"credentialId":"\u003cstring>","organisationId":"\u003cstring>","clientId":"\u003cstring>","clientSecret":"\u003cstring>"}},"validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}],"authorizeUrl":"\u003cstring>","additionalAuthorizeParams":"\u003cstring>","additionalTokenParams":"\u003cstring>","mtlsEnabled":true,"mtlsCredentialId":"\u003cstring>","pkce":true},"oauth1":{"id":"\u003cstring>","description":"\u003cstring>","consumerKey":"\u003cstring>","consumerSecret":"\u003cstring>","signatureMethod":"\u003cstring>","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}],"tokenAuth":true,"tempCredentialEndpoint":{"url":"\u003cstring>","additionalParamConfigs":[{"parameterName":"\u003cstring>","location":"LOCATION_IGNORE","required":true,"modifiable":true,"targetName":"\u003cstring>","usages":"USAGE_UNKNOWN"}],"parameterTransmission":"AUTH_STYLE_AUTHORIZATION_HEADER"},"resourceOwnerAuthorizationEndpoint":{"url":"\u003cstring>","additionalParamConfigs":[{"parameterName":"\u003cstring>","location":"LOCATION_IGNORE","required":true,"modifiable":true,"targetName":"\u003cstring>","usages":"USAGE_UNKNOWN"}],"parameterTransmission":"AUTH_STYLE_AUTHORIZATION_HEADER"},"tokenEndpoint":{"url":"\u003cstring>","additionalParamConfigs":[{"parameterName":"\u003cstring>","location":"LOCATION_IGNORE","required":true,"modifiable":true,"targetName":"\u003cstring>","usages":"USAGE_UNKNOWN"}],"parameterTransmission":"AUTH_STYLE_AUTHORIZATION_HEADER"},"credentialId":"\u003cstring>"},"hmac":{"id":"\u003cstring>","description":"\u003cstring>","name":"\u003cstring>","in":"query","algorithm":"sha1","digestInputs":["body"],"encoding":"hex","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"certificate":{"id":"\u003cstring>","description":"\u003cstring>","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]}}],"templateBaseUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"75c069ad-b136-4106-ad09-1d6d23e01220":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a machine-readable error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Message is a human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"fields":{"type":"array","items":{"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\nelements. The format of this field is of the form: \"field1.field2[0].field3\"\n","isRequired":true,"uniqueKey":"fields.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Message is the error message for this specific field.","isRequired":true,"uniqueKey":"fields.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"fields","typeLabel":"object[]"},"details":{"type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"details","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","fields":[{"field":"\u003cstring>","message":"\u003cstring>"}],"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ad977c79-c846-4804-9548-4d09cb6f8f14":{"bearerToken":{"description":"Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however\ninternal consumers must provide a JWT id_token issued by our IdP.\n","type":"http","scheme":"bearer","scopes":[]}},"b1012d3e-47bf-44f7-b929-7fdf4592103d":{"cookie":{"description":"Cookie authentication used by the Versori Platform.","type":"apiKey","in":"cookie","name":"cookie","scopes":[]}}},"servers":{"d0eac863-e307-4ad7-a239-2c447e8ba4c0":{"description":"Production","url":"https://platform.versori.com/api/v2"},"0bedeed1-5e05-4d49-a0f1-0acdda0da1fe":{"description":"Staging","url":"https://platform-staging.versori.com/api/v2"},"731967af-8899-446e-b2cf-c9e6c5801b84":{"description":"Development","url":"http://localhost:8901"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however\ninternal consumers must provide a JWT id_token issued by our IdP.\n","type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however\ninternal consumers must provide a JWT id_token issued by our IdP.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerToken","name":"Authorization"}],"title":"bearerToken"},{"schemes":[{"scheme":{"description":"Cookie authentication used by the Versori Platform.","type":"apiKey","in":"cookie","name":"cookie","scopes":[]},"schema":{"title":"cookie","type":"string","description":"Cookie authentication used by the Versori Platform.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"cookie","name":"cookie"}],"title":"cookie"}]},"originalFileLocation":"openapi/platform-api.yaml"},"subdomain":"versori","siteName":"Versori User Documentation","title":"Create a new system. - Versori User Documentation","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/latest/home","matchLevel":4},"Legacy":{"href":"/legacy/welcome","matchLevel":4},"v2":{"href":"/v2/api-reference/systems/create-a-new-system","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T11:02:54.582Z","originalFileLocation":"v2/api-reference/systems/create-a-new-system.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new system. - Versori User Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Systems\u0026amp;title=Create+a+new+system.\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=bbfc70b0690d8ea8f68e9d66832ffc78d2cfe4186eab38e2a59a7d0be98e36df\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a new system. - Versori User Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Systems\u0026amp;title=Create+a+new+system.\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=bbfc70b0690d8ea8f68e9d66832ffc78d2cfe4186eab38e2a59a7d0be98e36df\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6EB0D8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/systems/create-a-new-system.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.versori.com/#organization\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.versori.com#website\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system#webpage\",\"url\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system\",\"name\":\"Create a new system.\",\"dateModified\":\"2026-10-14T11:02:54.582Z\",\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Systems\",\"item\":\"https://docs.versori.com/v2/api-reference/systems/add-a-system-to-a-project-environment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a new system.\",\"item\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system#apireference\",\"headline\":\"Create a new system.\",\"name\":\"Create a new system.\",\"url\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system\",\"mainEntityOfPage\":{\"@id\":\"https://docs.versori.com/v2/api-reference/systems/create-a-new-system#webpage\"},\"dateModified\":\"2026-10-14T11:02:54.582Z\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Versori User Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Versori User Documentation","nav":{"global":null,"versions":[{"version":"Latest","pages":[{"title":"Latest","href":"/latest/home"}]},{"version":"Legacy","pages":[{"title":"Legacy","href":"/legacy/welcome"}]},{"version":"v2","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/v2/introduction"}]},{"anchor":"API Reference","icon":"terminal","groups":[{"group":"Activations","pages":[{"openapi":"delete /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}","title":"Delete an Activation","href":"/v2/api-reference/activations/delete-an-activation"},{"openapi":"get /o/{organisation_id}/environment/{environment_id}/users/{external_user_id}/activations","title":"List Activations for User","href":"/v2/api-reference/activations/list-activations-for-user"},{"openapi":"get /o/{organisation_id}/environments/{environment_id}/activations","title":"List Activations","href":"/v2/api-reference/activations/list-activations"},{"openapi":"get /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}","title":"Retrieve an Activation by ID","href":"/v2/api-reference/activations/retrieve-an-activation-by-id"},{"openapi":"put /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables/{variable_name}","title":"Set a dynamic variable by name","href":"/v2/api-reference/activations/set-a-dynamic-variable-by-name"},{"openapi":"patch /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables","title":"Set dynamic variables for an activation","href":"/v2/api-reference/activations/set-dynamic-variables-for-an-activation"},{"openapi":"patch /o/{organisation_id}/environments/{environment_id}/variables","title":"Set static variables for the static activation","href":"/v2/api-reference/activations/set-static-variables-for-the-static-activation"}]},{"group":"Connections","pages":[{"openapi":"post /o/{organisation_id}/connections","title":"Create a new connection.","href":"/v2/api-reference/connections/create-a-new-connection"},{"openapi":"get /o/{organisation_id}/connections/{connection_id}","title":"Get a Connection by ID","href":"/v2/api-reference/connections/get-a-connection-by-id"},{"openapi":"post /o/{organisation_id}/systems/{system_id}/oauth2/initialise","title":"Initialise OAuth 2.0 Connection","href":"/v2/api-reference/connections/initialise-oauth-20-connection"},{"openapi":"post /o/{organisation_id}/connections/{connection_id}/link","title":"Link an existing connection to an environment","href":"/v2/api-reference/connections/link-an-existing-connection-to-an-environment"},{"openapi":"get /o/{organisation_id}/connections","title":"List Connections","href":"/v2/api-reference/connections/list-connections"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/connections","title":"List static connections for project environment","href":"/v2/api-reference/connections/list-static-connections-for-project-environment"},{"openapi":"get /o/{organisation_id}/environment-systems/{env_system_id}/activations/{activation_id}","title":"Retrieve the connection for the activations.","href":"/v2/api-reference/connections/retrieve-the-connection-for-the-activations"},{"openapi":"put /o/{organisation_id}/connections/{connection_id}","title":"Update a Connection by ID","href":"/v2/api-reference/connections/update-a-connection-by-id"}]},{"group":"End Users","pages":[{"openapi":"post /o/{organisation_id}/users","title":"Create an End User","href":"/v2/api-reference/end_users/create-an-end-user"},{"openapi":"delete /o/{organisation_id}/users/{user_id}","title":"Delete an End User","href":"/v2/api-reference/end_users/delete-an-end-user"},{"openapi":"get /o/{organisation_id}/users","title":"List End Users","href":"/v2/api-reference/end_users/list-end-users"},{"openapi":"get /o/{organisation_id}/users/{user_id}","title":"Retrieve an End User","href":"/v2/api-reference/end_users/retrieve-an-end-user"}]},{"group":"Projects","pages":[{"openapi":"post /o/{organisation_id}/activations","title":"Activates a User on an Environment.","href":"/v2/api-reference/projects/activates-a-user-on-an-environment"},{"openapi":"post /o/{organisation_id}/projects","title":"Create new project","href":"/v2/api-reference/projects/create-new-project"},{"openapi":"delete /o/{organisation_id}/projects/{project_id}","title":"Delete Project","href":"/v2/api-reference/projects/delete-project"},{"openapi":"put /o/{organisation_id}/projects/{project_id}/deploy","title":"Deploy Project","href":"/v2/api-reference/projects/deploy-project"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/files","title":"Get Files","href":"/v2/api-reference/projects/get-files"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/logs","title":"Get Project Logs","href":"/v2/api-reference/projects/get-project-logs"},{"openapi":"get /o/{organisation_id}/projects/{project_id}","title":"Get Project","href":"/v2/api-reference/projects/get-project"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/traces/{trace_id}","title":"Get Trace","href":"/v2/api-reference/projects/get-trace"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/traces","title":"List project traces","href":"/v2/api-reference/projects/list-project-traces"},{"openapi":"get /o/{organisation_id}/projects","title":"List projects for organisation","href":"/v2/api-reference/projects/list-projects-for-organisation"},{"openapi":"patch /o/{organisation_id}/projects/{project_id}/variables","title":"Patch the schema for the project's dynamic variables","href":"/v2/api-reference/projects/patch-the-schema-for-the-projects-dynamic-variables"},{"openapi":"put /o/{organisation_id}/projects/{project_id}/variables","title":"Set the schema for the project variables","href":"/v2/api-reference/projects/set-the-schema-for-the-project-variables"},{"openapi":"post /o/{organisation_id}/projects/{project_id}/suspend","title":"Suspend Project","href":"/v2/api-reference/projects/suspend-project"},{"openapi":"put /o/{organisation_id}/projects/{project_id}/files","title":"Update Files","href":"/v2/api-reference/projects/update-files"},{"openapi":"put /o/{organisation_id}/projects/{project_id}","title":"Update Project","href":"/v2/api-reference/projects/update-project"}]},{"group":"Systems","pages":[{"openapi":"post /o/{organisation_id}/projects/{project_id}/systems","title":null,"href":"/v2/api-reference/systems/add-a-system-to-a-project-environment"},{"openapi":"put /o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}","title":"Adds or updates an auth scheme for the system.","href":"/v2/api-reference/systems/adds-or-updates-an-auth-scheme-for-the-system"},{"openapi":"post /o/{organisation_id}/projects/{project_id}/connection-templates","title":"Create a new connection template","description":null,"href":"/v2/api-reference/systems/create-a-new-connection-template"},{"openapi":"post /o/{organisation_id}/systems","title":"Create a new system.","href":"/v2/api-reference/systems/create-a-new-system"},{"openapi":"delete /o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}","title":"Deletes an auth scheme for the system.","description":null,"href":"/v2/api-reference/systems/deletes-an-auth-scheme-for-the-system"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/connection-templates","title":"List project environment connection templates","href":"/v2/api-reference/systems/list-project-environment-connection-templates"},{"openapi":"get /o/{organisation_id}/projects/{project_id}/systems","title":null,"href":"/v2/api-reference/systems/list-the-systems-linked-to-the-project-environment"},{"openapi":"get /o/{organisation_id}/systems","title":"Lists the systems for the organisation.","href":"/v2/api-reference/systems/lists-the-systems-for-the-organisation"},{"openapi":"delete /o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}","title":"Remove a connection template","href":"/v2/api-reference/systems/remove-a-connection-template"},{"openapi":"put /o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}","title":"Remove a system from a project environment","href":"/v2/api-reference/systems/remove-a-system-from-a-project-environment-1"},{"openapi":"delete /o/{organisation_id}/projects/{project_id}/systems","title":null,"href":"/v2/api-reference/systems/remove-a-system-from-a-project-environment"},{"openapi":"put /o/{organisation_id}/systems/{system_id}","title":"Update system.","href":"/v2/api-reference/systems/update-system"}]}]}]}]},"title":"Create a new system. - Versori User Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}