EndUserIntegration represents an integration that is available to an end user.
This object is only a summary of the integration and does not contain all the information to enable the user
to activate it. The GetEmbeddedIntegration endpoint should be used to retrieve the full integration details.
Show child attributes
⌘I
{"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":"legacy/api-reference/embedded-api/activations/retrieve-an-activation","slug":"/legacy/api-reference/embedded-api/activations/retrieve-an-activation","pageMetadata":{"openapi":"get /activations/{activation_id}","title":"Retrieve an Activation","description":"GetActivation returns the Activation for the given ID.\n","href":"/legacy/api-reference/embedded-api/activations/retrieve-an-activation"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"GetActivation returns the Activation for the given ID.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"get /activations/{activation_id}","title":"Retrieve an Activation","description":"GetActivation returns the Activation for the given ID.\n","href":"/legacy/api-reference/embedded-api/activations/retrieve-an-activation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"GetActivation","summary":"Retrieve an Activation","description":"GetActivation returns the Activation for the given ID.\n","tags":["Activations"],"responses":{"200":"545d7bd7-1817-4c99-ba11-2c92a20fdd74","default":"44ae92e9-00d4-4564-bc6c-1f4c7c947870"},"method":"get","type":"path","servers":["662036c2-097e-4f5a-88fa-262b3a3c9120","a0760f0f-7ce5-4f74-8ab0-ca1b64ebe4f7","b811851b-92c2-4bbe-a9ef-52523f52d451"],"security":[],"path":"/activations/{activation_id}","baseUrlOptions":["https://platform.versori.com/api/embedded/v1","https://platform-staging.versori.com/api/embedded/v1/","http://localhost:8950/embedded/v1"],"title":"Retrieve an Activation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"5a01a5ae-cba5-4a75-8af4-1838b32f1110":{"name":"activation_id","in":"path","required":true,"schema":{"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"},"isRequired":true,"uniqueKey":"","typeLabel":"string\u003culid>"}}},"responses":{"545d7bd7-1817-4c99-ba11-2c92a20fdd74":{"description":"OK","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>"},"user":{"type":"object","properties":{"id":{"description":"ID is the Versori identifier for the user. Most APIs will not use this field but instead reference\nusers by their externalId.\n","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":"user.id","typeLabel":"string\u003culid>"},"externalId":{"description":"ExternalID is the identifier for the user as determined by the organisation. This typically should\nbe the same as the user's ID on the Primary Connector for the Hub. Regardless of the value, it must \nbe unique within the Hub.\n","type":"string","x-go-name":"ExternalID","isRequired":true,"uniqueKey":"user.externalId","typeLabel":"string"},"displayName":{"description":"DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.\n","type":"string","isRequired":true,"uniqueKey":"user.displayName","typeLabel":"string"},"hubId":{"description":"The hub ID to which the user belongs to.","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":"HubID","isRequired":true,"uniqueKey":"user.hubId","typeLabel":"string\u003culid>"},"primaryConnection":{"description":"PrimaryConnection is the connection that the user will use to authenticate to the primary connector.\n","type":"object","properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)\npublic-facing APIs will use the `name` in combination with the Connector's `id` instead.\n","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.id","typeLabel":"string\u003culid>"},"name":{"type":"string","description":"Name is the name of the Connection. This must be unique within the owning Connector.","isRequired":true,"uniqueKey":"user.primaryConnection.name","typeLabel":"string"},"credentials":{"description":"ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple\ncredentials are defined for each type, they are applied to the request in the order they are defined. This is to\nenable Connectors which require both a user session token and an API key to be provided in the request.\n","type":"object","properties":{"action":{"type":"array","items":{"description":"ConnectionCredential contains the a Credential and the AuthSchemeConfig to define how the Credential should be used against the Connection's Connector.","type":"object","properties":{"id":{"type":"string","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].id","typeLabel":"string\u003culid>"},"authSchemeConfig":{"oneOf":[{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.description","typeLabel":"string"},"schemeType":{"type":"string","const":"none","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.0","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.description","typeLabel":"string"},"schemeType":{"type":"string","const":"api-key","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.1","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.description","typeLabel":"string"},"schemeType":{"type":"string","const":"basic-auth","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.2","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","authorizeUrl","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.description","typeLabel":"string"},"schemeType":{"type":"string","const":"oauth2","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.schemeType","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.authorizeUrl","typeLabel":"string\u003curi>"},"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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.scopes.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.scopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.defaultScopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.defaultScopes","typeLabel":"string[]"},"grant":{"oneOf":[{"type":"object","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","required":["grantType"],"properties":{"grantType":{"type":"string","const":"authorization_code","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.grantType","typeLabel":"string"},"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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.clientSecret","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0","typeLabel":"object"},{"type":"object","required":["grantType"],"properties":{"grantType":{"type":"string","const":"client_credentials","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.1.grantType","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.1","typeLabel":"object"},{"type":"object","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","required":["grantType"],"properties":{"grantType":{"type":"string","const":"password","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.grantType","typeLabel":"string"},"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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.clientSecret","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages","typeLabel":"object[]"},"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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3.mtlsCredentialId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.3","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","name","in","algorithm","digestInputs","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.description","typeLabel":"string"},"schemeType":{"type":"string","const":"hmac","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigHMACIn defines where the signature should be set on requests.","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.digestInputs.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.digestInputs","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.4","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.description","typeLabel":"string"},"schemeType":{"type":"string","const":"certificate","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.schemeType","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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.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":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig.oneOf.5","typeLabel":"object"}],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].authSchemeConfig","typeLabel":"object"},"credential":{"description":"CredentialBase is the base type for all credentials. It contains the common properties which are shared across\nall credential types.\n","type":"object","properties":{"id":{"description":"ID is the unique identifier of the Credential.","type":"string","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.id","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation which owns the Credential.","type":"string","format":"ulid","x-go-name":"OrganisationID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.organisationId","typeLabel":"string\u003culid>"},"type":{"description":"CredentialType denotes the type of the credential which determines what the Credential's `data` property will\ncontain.\n\n- none: No credential is required to authenticate with the Connector.\n- string: The credential is a string value, such as an API key or password.\n- binary: The credential is a binary value, such as a private key, certificate or other file.\n- basic-auth: The credential is a username and password to be used for basic authentication.\n- oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.\n- oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.\n- oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.\n- oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.\n- custom-function: The credential is a custom function which will be called to authenticate with the Connector.\n- jwt-bearer: The credential is the JWT setup values to be used for generating a bearer token.\n- certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.\n","type":"string","enum":["none","string","binary","basic-auth","oauth2-client","oauth2-code","oauth2-password","oauth2-token","custom-function","certificate","jwt-bearer"],"x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.type","typeLabel":"enum\u003cstring>"},"name":{"description":"Name is the name of the Credential.","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.name","typeLabel":"string"},"data":{"oneOf":[{"type":"object","description":"CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used\npurely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.\n","additionalProperties":false,"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.0","typeLabel":"object"},{"type":"object","description":"CredentialDataString contains a string value and nothing else and is commonly used for API keys. This value \nwill be redacted when returned in a response.\n","required":["value"],"properties":{"value":{"type":"string","description":"Value is a UTF-8 string containing the credential data. When read from the API this field will be redacted.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.1.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.1","typeLabel":"object"},{"type":"object","description":"CredentialDataBinary is commonly used to store non-string data such as binary files or encryption keys. This \nvalue will be redacted when returned in a response.\n","required":["valueBase64"],"properties":{"valueBase64":{"type":"string","description":"Value is a base64 encoded string containing the credential data. This could decode to a valid utf-8 string,\nor it could decode to a binary file such as a private key etc. When read from the API this field will be \nredacted.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.2.valueBase64","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.2","typeLabel":"object"},{"type":"object","description":"CredentialDataBasicAuth contains the username and password required to authenticate with the Connector. The\n`password` property will be redacted when returned in a response.\n","required":["username","password"],"properties":{"username":{"type":"string","description":"Username is the username used to authenticate with the Connector.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.3.username","typeLabel":"string"},"password":{"type":"string","description":"Password is the password used to authenticate with the Connector. Will be redacted when returned in a\nresponse.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.3.password","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.3","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Client contains the OAuth2 client credentials required to either issue an access token from\na refresh_token, or via the `client_credentials` and `authorization_code` grant types. The `clientSecret` property will be redacted when\nreturned in a response.\n","required":["clientId","clientSecret","authorizeUrl","tokenUrl"],"properties":{"clientId":{"type":"string","description":"ClientID is the OAuth2 client ID used to authenticate with the Connector.\n","x-go-name":"ClientID","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.clientId","typeLabel":"string"},"clientSecret":{"type":"string","description":"ClientSecret is the OAuth2 client secret used to authenticate with the Connector. Will be redacted when\nreturned in a response.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.clientSecret","typeLabel":"string"},"authorizeUrl":{"type":"string","format":"uri","description":"AuthorizeURL is the URL which the user will be redirected to in order to authorize the application. If\nthe client is being used for a `client_credentials` grant type, this field should be set to an empty \nstring.\n","x-go-name":"AuthorizeURL","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.authorizeUrl","typeLabel":"string\u003curi>"},"tokenUrl":{"type":"string","format":"uri","description":"TokenURL is the URL which the application will use to issue an access token.","x-go-name":"TokenURL","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.tokenUrl","typeLabel":"string\u003curi>"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes is a list of scopes which should be requested when issuing an access token. This is only required if\nthis credential is being used on a `client_credentials` grant type, for `authorization_code` grant types the\nrequested scopes come from the `CredentialDataOAuth2Token` credential.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.scopes","typeLabel":"string[]"},"additionalParams":{"description":"AdditionalParams is a URL-encoded query string which can be used to pass additional \nparameters to the OAuth 2.0 token endpoint. These parameters are attached to the body\nin the formatted as the `application/x-www-form-urlencoded` content-type.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.additionalParams","typeLabel":"string"},"mTLSEnabled":{"type":"boolean","description":"MTLSEnabled is a boolean flag which determines whether the client should use mutual TLS authentication when \ncommunicating with the OAuth2 provider. If enabled, the `mTLSCredentialId` field must be set, or it must be \ncreated via the `CreateConnection` endpoint with an associated mTLS credential defined beforehand, in which\ncase the mTLSCredentialID field will be populated upon saving by the API.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.mTLSEnabled","typeLabel":"boolean"},"mTLSCredentialId":{"type":"string","description":"MTLSCredentialID is an optional reference to another credential being created. \nIf set the certificate credential will be used when making a request to the tokenUrl.\n","x-go-name":"MTLSCredentialID","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4.mTLSCredentialId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.4","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Token is primarily used to store the refresh_token for an user who has authorized an OAuth2\nApplication to access their data. However, this information is not exposed publicly and the only data visible\nvia the API are the `scopes` which the user has granted consent for. This can be used to determine whether\nthe user should be prompted to re-authorize the application with additional scopes in the event they choose to\nuse a new endpoint which requires additional scopes to what they've already consented to.\n","required":["scopes","refreshToken"],"properties":{"scopes":{"type":"array","items":{"type":"string","uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes is a list of scopes which the user has granted consent for.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5.scopes","typeLabel":"string[]"},"refreshToken":{"type":"string","description":"RefreshToken is the OAuth2 refresh token which can be used to issue new access tokens. This information is\nredacted when read from the API.\n\nThis is a required field as it is used to refresh the access token when it expires. If users are providing\nan access token which does not expire using this credential type, then the same functionality may be \nachieved by using a simple API key and OAuth 2.0 need not be used.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5.refreshToken","typeLabel":"string"},"accessToken":{"type":"string","description":"AccessToken is the OAuth2 access token which can be used to authenticate with the Connector. This \ninformation is redacted when read from the API.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5.accessToken","typeLabel":"string"},"tokenType":{"type":"string","description":"TokenType is the type of token which is being issued. Defaults to \"Bearer\" if not set.\n","default":"Bearer","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5.tokenType","typeLabel":"string"},"expiresAt":{"type":"string","format":"date-time","description":"ExpiresAt is the time at which the access token will expire. If not defined, the accessToken will be \nreused until a 401 response is received from the Connector, at which point the token should be refreshed\nwith the provided `refreshToken`. Ideally this should be provided so that erroneous failures can be \navoided.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5.expiresAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.5","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Code is used to exchange an authorization code for an access token and\nis denoted by the `oauth2-code` type. \nThis is only used when creating or updating an OAuth 2.0 connection using the \n`authorization_code` grant type. Retrieving this credential will return a payload of\ntype `oauth2-token` in the shape of a `CredentialDataOAuth2Token` object.\n","required":["code","state"],"properties":{"code":{"description":"Code is the authorization code which will be exchanged for an access token.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.6.code","typeLabel":"string"},"state":{"description":"State is the state value which is propagated through the OAuth2 flow.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.6.state","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.6","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Password contains the username and password of a Resource Owner within an OAuth 2.0\napplication. The `password` property will be redacted when returned in a response.\n","required":["username","password"],"properties":{"username":{"type":"string","description":"Username is the username used to authenticate with the Connector.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.7.username","typeLabel":"string"},"password":{"type":"string","description":"Password is the password used to authenticate with the Connector. Will be redacted when returned in a\nresponse.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.7.password","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.7","typeLabel":"object"},{"type":"object","description":"CredentialDataCertificate contains the Certificate, Certificate key and CA(Certificate authority).\n","required":["certificate","key","ca"],"properties":{"certificate":{"type":"string","description":"Certificate is the certificate that will be send to the connection.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.8.certificate","typeLabel":"string"},"key":{"type":"string","description":"Key is the accompanying key for the certificate.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.8.key","typeLabel":"string"},"ca":{"type":"string","description":"CA is the Certificate Authority to verify the server certificates against.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.8.ca","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data.oneOf.8","typeLabel":"object"}],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.data","typeLabel":"object"},"usages":{"description":"CredentialUsages is a list of references to the Connectors which are using this Credential. To aid performance,\nthis field will only be defined for specific endpoints. An undefined property means that the usages have not\nbeen loaded, whereas an empty array indicates that the credential is not used by any connectors.\n","type":"array","items":{"description":"CredentialUsage contains the information about a Connector which is using a Credential. This object currently\nonly supports tracking usage by other connections, but in the future new fields may be added to track usage\nby other entities such as, but not limited to, Boards, Hubs and Users.\n","type":"object","properties":{"connection":{"description":"CredentialUsageConnection contains the information about an Connection which is using a Credential. This also\nincludes a summary of the Connector it belongs to.\n","type":"object","properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)\npublic-facing APIs will use the `name` in combination with the Connector's `id` instead.\n","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.id","typeLabel":"string\u003culid>"},"name":{"type":"string","description":"Name is the name of the Connection.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.name","typeLabel":"string"},"connector":{"description":"ConnectorSummaryBase exposes a summary of a Connector irrespective of protocol.","type":"object","properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the Connector.","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector.id","typeLabel":"string\u003culid>"},"organisationId":{"type":"string","format":"ulid","description":"OrganisationID is the unique identifier of the Organisation that owns the Connector.","x-go-name":"OrganisationID","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector.organisationId","typeLabel":"string\u003culid>"},"name":{"type":"string","description":"Name is the user-provided name of the Connector","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector.name","typeLabel":"string"},"protocol":{"description":"ProtocolType denotes the set of all valid connector types.","type":"string","enum":["http","bigquery"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector.protocol","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"CreatedAt is the time at which the ConnectorVersion was created.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child\nresources.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","organisationId","name","protocol","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.connector","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"CreatedAt is the time the Connection was created.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UpdatedAt is the time the Connection was last updated.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","name","connector","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX].connection","typeLabel":"object"}},"required":["connection"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.usages","typeLabel":"object[]"},"errors":{"description":"Errors is a list of errors which occurred when attempting to validate the credential. This field may be\nundefined, which implies that validation has not occurred and the consumer cannot assume whether this\nCredential is valid or not. An empty array indicates that the Credential is valid.\n","type":"array","items":{"type":"string","uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.errors.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.errors","typeLabel":"string[]"},"expiresAt":{"type":"string","format":"date-time","description":"ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe \nto deletion events and if the reason is \"expired\", can trigger the correct notifications to interested\nparties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).\n","uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential.expiresAt","typeLabel":"string\u003cdate-time>"}},"required":["id","organisationId","type","name","data"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX].credential","typeLabel":"object"}},"required":["id","authSchemeConfig","credential"],"uniqueKey":"user.primaryConnection.credentials.action.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.action","typeLabel":"object[]"},"trigger":{"type":"array","items":{"description":"ConnectionCredential contains the a Credential and the AuthSchemeConfig to define how the Credential should be used against the Connection's Connector.","type":"object","properties":{"id":{"type":"string","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].id","typeLabel":"string\u003culid>"},"authSchemeConfig":{"oneOf":[{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.description","typeLabel":"string"},"schemeType":{"type":"string","const":"none","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.0","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.description","typeLabel":"string"},"schemeType":{"type":"string","const":"api-key","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.1","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.description","typeLabel":"string"},"schemeType":{"type":"string","const":"basic-auth","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.2","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","authorizeUrl","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.description","typeLabel":"string"},"schemeType":{"type":"string","const":"oauth2","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.schemeType","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.authorizeUrl","typeLabel":"string\u003curi>"},"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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.scopes.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.scopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.defaultScopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.defaultScopes","typeLabel":"string[]"},"grant":{"oneOf":[{"type":"object","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","required":["grantType"],"properties":{"grantType":{"type":"string","const":"authorization_code","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.grantType","typeLabel":"string"},"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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0.clientSecret","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.0","typeLabel":"object"},{"type":"object","required":["grantType"],"properties":{"grantType":{"type":"string","const":"client_credentials","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.1.grantType","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.1","typeLabel":"object"},{"type":"object","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","required":["grantType"],"properties":{"grantType":{"type":"string","const":"password","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.grantType","typeLabel":"string"},"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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2.clientSecret","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.grant.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.validationMessages","typeLabel":"object[]"},"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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3.mtlsCredentialId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.3","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","name","in","algorithm","digestInputs","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.description","typeLabel":"string"},"schemeType":{"type":"string","const":"hmac","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigHMACIn defines where the signature should be set on requests.","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.digestInputs.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.digestInputs","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.4","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.description","typeLabel":"string"},"schemeType":{"type":"string","const":"certificate","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.schemeType","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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.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":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig.oneOf.5","typeLabel":"object"}],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].authSchemeConfig","typeLabel":"object"},"credential":{"description":"CredentialBase is the base type for all credentials. It contains the common properties which are shared across\nall credential types.\n","type":"object","properties":{"id":{"description":"ID is the unique identifier of the Credential.","type":"string","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.id","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation which owns the Credential.","type":"string","format":"ulid","x-go-name":"OrganisationID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.organisationId","typeLabel":"string\u003culid>"},"type":{"description":"CredentialType denotes the type of the credential which determines what the Credential's `data` property will\ncontain.\n\n- none: No credential is required to authenticate with the Connector.\n- string: The credential is a string value, such as an API key or password.\n- binary: The credential is a binary value, such as a private key, certificate or other file.\n- basic-auth: The credential is a username and password to be used for basic authentication.\n- oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.\n- oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.\n- oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.\n- oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.\n- custom-function: The credential is a custom function which will be called to authenticate with the Connector.\n- jwt-bearer: The credential is the JWT setup values to be used for generating a bearer token.\n- certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.\n","type":"string","enum":["none","string","binary","basic-auth","oauth2-client","oauth2-code","oauth2-password","oauth2-token","custom-function","certificate","jwt-bearer"],"x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.type","typeLabel":"enum\u003cstring>"},"name":{"description":"Name is the name of the Credential.","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.name","typeLabel":"string"},"data":{"oneOf":[{"type":"object","description":"CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used\npurely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.\n","additionalProperties":false,"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.0","typeLabel":"object"},{"type":"object","description":"CredentialDataString contains a string value and nothing else and is commonly used for API keys. This value \nwill be redacted when returned in a response.\n","required":["value"],"properties":{"value":{"type":"string","description":"Value is a UTF-8 string containing the credential data. When read from the API this field will be redacted.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.1.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.1","typeLabel":"object"},{"type":"object","description":"CredentialDataBinary is commonly used to store non-string data such as binary files or encryption keys. This \nvalue will be redacted when returned in a response.\n","required":["valueBase64"],"properties":{"valueBase64":{"type":"string","description":"Value is a base64 encoded string containing the credential data. This could decode to a valid utf-8 string,\nor it could decode to a binary file such as a private key etc. When read from the API this field will be \nredacted.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.2.valueBase64","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.2","typeLabel":"object"},{"type":"object","description":"CredentialDataBasicAuth contains the username and password required to authenticate with the Connector. The\n`password` property will be redacted when returned in a response.\n","required":["username","password"],"properties":{"username":{"type":"string","description":"Username is the username used to authenticate with the Connector.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.3.username","typeLabel":"string"},"password":{"type":"string","description":"Password is the password used to authenticate with the Connector. Will be redacted when returned in a\nresponse.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.3.password","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.3","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Client contains the OAuth2 client credentials required to either issue an access token from\na refresh_token, or via the `client_credentials` and `authorization_code` grant types. The `clientSecret` property will be redacted when\nreturned in a response.\n","required":["clientId","clientSecret","authorizeUrl","tokenUrl"],"properties":{"clientId":{"type":"string","description":"ClientID is the OAuth2 client ID used to authenticate with the Connector.\n","x-go-name":"ClientID","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.clientId","typeLabel":"string"},"clientSecret":{"type":"string","description":"ClientSecret is the OAuth2 client secret used to authenticate with the Connector. Will be redacted when\nreturned in a response.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.clientSecret","typeLabel":"string"},"authorizeUrl":{"type":"string","format":"uri","description":"AuthorizeURL is the URL which the user will be redirected to in order to authorize the application. If\nthe client is being used for a `client_credentials` grant type, this field should be set to an empty \nstring.\n","x-go-name":"AuthorizeURL","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.authorizeUrl","typeLabel":"string\u003curi>"},"tokenUrl":{"type":"string","format":"uri","description":"TokenURL is the URL which the application will use to issue an access token.","x-go-name":"TokenURL","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.tokenUrl","typeLabel":"string\u003curi>"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes is a list of scopes which should be requested when issuing an access token. This is only required if\nthis credential is being used on a `client_credentials` grant type, for `authorization_code` grant types the\nrequested scopes come from the `CredentialDataOAuth2Token` credential.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.scopes","typeLabel":"string[]"},"additionalParams":{"description":"AdditionalParams is a URL-encoded query string which can be used to pass additional \nparameters to the OAuth 2.0 token endpoint. These parameters are attached to the body\nin the formatted as the `application/x-www-form-urlencoded` content-type.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.additionalParams","typeLabel":"string"},"mTLSEnabled":{"type":"boolean","description":"MTLSEnabled is a boolean flag which determines whether the client should use mutual TLS authentication when \ncommunicating with the OAuth2 provider. If enabled, the `mTLSCredentialId` field must be set, or it must be \ncreated via the `CreateConnection` endpoint with an associated mTLS credential defined beforehand, in which\ncase the mTLSCredentialID field will be populated upon saving by the API.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.mTLSEnabled","typeLabel":"boolean"},"mTLSCredentialId":{"type":"string","description":"MTLSCredentialID is an optional reference to another credential being created. \nIf set the certificate credential will be used when making a request to the tokenUrl.\n","x-go-name":"MTLSCredentialID","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4.mTLSCredentialId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.4","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Token is primarily used to store the refresh_token for an user who has authorized an OAuth2\nApplication to access their data. However, this information is not exposed publicly and the only data visible\nvia the API are the `scopes` which the user has granted consent for. This can be used to determine whether\nthe user should be prompted to re-authorize the application with additional scopes in the event they choose to\nuse a new endpoint which requires additional scopes to what they've already consented to.\n","required":["scopes","refreshToken"],"properties":{"scopes":{"type":"array","items":{"type":"string","uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes is a list of scopes which the user has granted consent for.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5.scopes","typeLabel":"string[]"},"refreshToken":{"type":"string","description":"RefreshToken is the OAuth2 refresh token which can be used to issue new access tokens. This information is\nredacted when read from the API.\n\nThis is a required field as it is used to refresh the access token when it expires. If users are providing\nan access token which does not expire using this credential type, then the same functionality may be \nachieved by using a simple API key and OAuth 2.0 need not be used.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5.refreshToken","typeLabel":"string"},"accessToken":{"type":"string","description":"AccessToken is the OAuth2 access token which can be used to authenticate with the Connector. This \ninformation is redacted when read from the API.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5.accessToken","typeLabel":"string"},"tokenType":{"type":"string","description":"TokenType is the type of token which is being issued. Defaults to \"Bearer\" if not set.\n","default":"Bearer","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5.tokenType","typeLabel":"string"},"expiresAt":{"type":"string","format":"date-time","description":"ExpiresAt is the time at which the access token will expire. If not defined, the accessToken will be \nreused until a 401 response is received from the Connector, at which point the token should be refreshed\nwith the provided `refreshToken`. Ideally this should be provided so that erroneous failures can be \navoided.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5.expiresAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.5","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Code is used to exchange an authorization code for an access token and\nis denoted by the `oauth2-code` type. \nThis is only used when creating or updating an OAuth 2.0 connection using the \n`authorization_code` grant type. Retrieving this credential will return a payload of\ntype `oauth2-token` in the shape of a `CredentialDataOAuth2Token` object.\n","required":["code","state"],"properties":{"code":{"description":"Code is the authorization code which will be exchanged for an access token.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.6.code","typeLabel":"string"},"state":{"description":"State is the state value which is propagated through the OAuth2 flow.\n","type":"string","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.6.state","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.6","typeLabel":"object"},{"type":"object","description":"CredentialDataOAuth2Password contains the username and password of a Resource Owner within an OAuth 2.0\napplication. The `password` property will be redacted when returned in a response.\n","required":["username","password"],"properties":{"username":{"type":"string","description":"Username is the username used to authenticate with the Connector.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.7.username","typeLabel":"string"},"password":{"type":"string","description":"Password is the password used to authenticate with the Connector. Will be redacted when returned in a\nresponse.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.7.password","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.7","typeLabel":"object"},{"type":"object","description":"CredentialDataCertificate contains the Certificate, Certificate key and CA(Certificate authority).\n","required":["certificate","key","ca"],"properties":{"certificate":{"type":"string","description":"Certificate is the certificate that will be send to the connection.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.8.certificate","typeLabel":"string"},"key":{"type":"string","description":"Key is the accompanying key for the certificate.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.8.key","typeLabel":"string"},"ca":{"type":"string","description":"CA is the Certificate Authority to verify the server certificates against.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.8.ca","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data.oneOf.8","typeLabel":"object"}],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.data","typeLabel":"object"},"usages":{"description":"CredentialUsages is a list of references to the Connectors which are using this Credential. To aid performance,\nthis field will only be defined for specific endpoints. An undefined property means that the usages have not\nbeen loaded, whereas an empty array indicates that the credential is not used by any connectors.\n","type":"array","items":{"description":"CredentialUsage contains the information about a Connector which is using a Credential. This object currently\nonly supports tracking usage by other connections, but in the future new fields may be added to track usage\nby other entities such as, but not limited to, Boards, Hubs and Users.\n","type":"object","properties":{"connection":{"description":"CredentialUsageConnection contains the information about an Connection which is using a Credential. This also\nincludes a summary of the Connector it belongs to.\n","type":"object","properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)\npublic-facing APIs will use the `name` in combination with the Connector's `id` instead.\n","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.id","typeLabel":"string\u003culid>"},"name":{"type":"string","description":"Name is the name of the Connection.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.name","typeLabel":"string"},"connector":{"description":"ConnectorSummaryBase exposes a summary of a Connector irrespective of protocol.","type":"object","properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the Connector.","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector.id","typeLabel":"string\u003culid>"},"organisationId":{"type":"string","format":"ulid","description":"OrganisationID is the unique identifier of the Organisation that owns the Connector.","x-go-name":"OrganisationID","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector.organisationId","typeLabel":"string\u003culid>"},"name":{"type":"string","description":"Name is the user-provided name of the Connector","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector.name","typeLabel":"string"},"protocol":{"description":"ProtocolType denotes the set of all valid connector types.","type":"string","enum":["http","bigquery"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector.protocol","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"CreatedAt is the time at which the ConnectorVersion was created.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child\nresources.\n","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","organisationId","name","protocol","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.connector","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"CreatedAt is the time the Connection was created.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UpdatedAt is the time the Connection was last updated.","isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","name","connector","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX].connection","typeLabel":"object"}},"required":["connection"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.usages","typeLabel":"object[]"},"errors":{"description":"Errors is a list of errors which occurred when attempting to validate the credential. This field may be\nundefined, which implies that validation has not occurred and the consumer cannot assume whether this\nCredential is valid or not. An empty array indicates that the Credential is valid.\n","type":"array","items":{"type":"string","uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.errors.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.errors","typeLabel":"string[]"},"expiresAt":{"type":"string","format":"date-time","description":"ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe \nto deletion events and if the reason is \"expired\", can trigger the correct notifications to interested\nparties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).\n","uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential.expiresAt","typeLabel":"string\u003cdate-time>"}},"required":["id","organisationId","type","name","data"],"isRequired":true,"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX].credential","typeLabel":"object"}},"required":["id","authSchemeConfig","credential"],"uniqueKey":"user.primaryConnection.credentials.trigger.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"user.primaryConnection.credentials.trigger","typeLabel":"object[]"}},"minProperties":1,"isRequired":true,"uniqueKey":"user.primaryConnection.credentials","typeLabel":"object"},"variables":{"type":"array","items":{"description":"ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.","type":"object","properties":{"name":{"type":"string","description":"Name is the name of the connection variable.","isRequired":true,"uniqueKey":"user.primaryConnection.variables.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Value is the value of the connection variable.","isRequired":true,"uniqueKey":"user.primaryConnection.variables.items.[INDEX].value","typeLabel":"string"}},"required":["name","value"],"uniqueKey":"user.primaryConnection.variables.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"user.primaryConnection.variables","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","description":"CreatedAt is the time the Connection was created.","isRequired":true,"uniqueKey":"user.primaryConnection.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UpdatedAt is the time the Connection was last updated.","isRequired":true,"uniqueKey":"user.primaryConnection.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","name","credentials","variables","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"user.primaryConnection","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"CreatedAt is the time the user was created.","x-go-type":"time.Time","isRequired":true,"uniqueKey":"user.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UpdatedAt is the time the user was last updated.","x-go-type":"time.Time","isRequired":true,"uniqueKey":"user.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","externalId","displayName","hubId","primaryConnection","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"user","typeLabel":"object"},"hubId":{"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":"HubID","isRequired":true,"uniqueKey":"hubId","typeLabel":"string\u003culid>"},"integration":{"description":"EndUserIntegration represents an integration that is available to an end user.\n\nThis object is only a summary of the integration and does not contain all the information to enable the user\nto activate it. The GetEmbeddedIntegration endpoint should be used to retrieve the full integration details.\n","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"},"isRequired":true,"uniqueKey":"integration.id","typeLabel":"string\u003culid>"},"name":{"description":"Name is a short name for the integration, this is typically the name of the Connector being integrated to.\n","type":"string","isRequired":true,"uniqueKey":"integration.name","typeLabel":"string"},"imageUrl":{"description":"ImageURL is a URL to an image/icon that represents the integration. This image is used within the \nintegration tile displayed in the embedded UI.\n","type":"string","format":"uri","x-go-name":"ImageURL","isRequired":true,"uniqueKey":"integration.imageUrl","typeLabel":"string\u003curi>"},"description":{"description":"Description can be used to provide a longer description of the integration. This can be shown to end users\nin the embedded integration hub UI.\n","type":"string","isRequired":true,"uniqueKey":"integration.description","typeLabel":"string"},"isDeployed":{"description":"IsDeployed indicates whether the integration is deployed and available to end users. If not deployed, the\nintegration cannot be activated.\n","type":"boolean","isRequired":true,"uniqueKey":"integration.isDeployed","typeLabel":"boolean"},"isActivated":{"description":"IsActivated indicates whether the integration is activated for the end user. If the integration is not\nactivated, the user can activate it from the embedded integration hub.\n","type":"boolean","isRequired":true,"uniqueKey":"integration.isActivated","typeLabel":"boolean"},"variablesSchema":{"description":"VariablesSchema is the JSON schema for the variables defined for this integration.\n","type":"object","x-go-type-skip-optional-pointer":true,"x-go-type":"json.RawMessage","uniqueKey":"integration.variablesSchema","typeLabel":"object"}},"required":["id","name","imageUrl","description","isDeployed","isActivated"],"isRequired":true,"uniqueKey":"integration","typeLabel":"object"}},"required":["id","user","hubId","integration"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","user":{"id":"\u003cstring>","externalId":"\u003cstring>","displayName":"\u003cstring>","hubId":"\u003cstring>","primaryConnection":{"id":"\u003cstring>","name":"\u003cstring>","credentials":{"action":[{"id":"\u003cstring>","authSchemeConfig":{"id":"\u003cstring>","description":"\u003cstring>","schemeType":"none","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"credential":{"id":"\u003cstring>","organisationId":"\u003cstring>","type":"none","name":"\u003cstring>","data":{},"usages":[{"connection":{"id":"\u003cstring>","name":"\u003cstring>","connector":{"id":"\u003cstring>","organisationId":"\u003cstring>","name":"\u003cstring>","protocol":"http","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}],"errors":["\u003cstring>"],"expiresAt":"2023-11-07T05:31:56Z"}}],"trigger":[{"id":"\u003cstring>","authSchemeConfig":{"id":"\u003cstring>","description":"\u003cstring>","schemeType":"none","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"credential":{"id":"\u003cstring>","organisationId":"\u003cstring>","type":"none","name":"\u003cstring>","data":{},"usages":[{"connection":{"id":"\u003cstring>","name":"\u003cstring>","connector":{"id":"\u003cstring>","organisationId":"\u003cstring>","name":"\u003cstring>","protocol":"http","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}],"errors":["\u003cstring>"],"expiresAt":"2023-11-07T05:31:56Z"}}]},"variables":[{"name":"\u003cstring>","value":"\u003cstring>"}],"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"},"hubId":"\u003cstring>","integration":{"id":"\u003cstring>","name":"\u003cstring>","imageUrl":"\u003cstring>","description":"\u003cstring>","isDeployed":true,"isActivated":true,"variablesSchema":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"44ae92e9-00d4-4564-bc6c-1f4c7c947870":{"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":{"b963811b-1c44-4945-91bd-2684e3df6f90":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}}},"servers":{"662036c2-097e-4f5a-88fa-262b3a3c9120":{"description":"Production","url":"https://platform.versori.com/api/embedded/v1"},"a0760f0f-7ce5-4f74-8ab0-ca1b64ebe4f7":{"description":"Staging","url":"https://platform-staging.versori.com/api/embedded/v1/"},"b811851b-92c2-4bbe-a9ef-52523f52d451":{"description":"Development","url":"http://localhost:8950/embedded/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi/embedded-api-v1.yaml"},"subdomain":"versori","siteName":"Versori User Documentation","title":"Retrieve an Activation - Versori User Documentation","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/latest/home","matchLevel":4},"Legacy":{"href":"/legacy/api-reference/embedded-api/activations/retrieve-an-activation","matchLevel":0},"v2":{"href":"/v2/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T11:43:55.857Z","originalFileLocation":"legacy/api-reference/embedded-api/activations/retrieve-an-activation.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=\"description\" content=\"GetActivation returns the Activation for the given ID.\">\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=\"Retrieve an Activation - Versori User Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"GetActivation returns the Activation for the given ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation\">\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=Activations\u0026amp;title=Retrieve+an+Activation\u0026amp;description=GetActivation+returns+the+Activation+for+the+given+ID.%0A\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=ae74bd3bf7e2f6c1893b713080c1a78e0bd30997c8e3ed0adbfbab3eed0f1799\">\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=\"Retrieve an Activation - Versori User Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GetActivation returns the Activation for the given ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Activations\u0026amp;title=Retrieve+an+Activation\u0026amp;description=GetActivation+returns+the+Activation+for+the+given+ID.%0A\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=ae74bd3bf7e2f6c1893b713080c1a78e0bd30997c8e3ed0adbfbab3eed0f1799\">\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/legacy/api-reference/embedded-api/activations/retrieve-an-activation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/legacy/api-reference/embedded-api/activations/retrieve-an-activation.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/legacy/api-reference/embedded-api/activations/retrieve-an-activation#webpage\",\"url\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation\",\"name\":\"Retrieve an Activation\",\"description\":\"GetActivation returns the Activation for the given ID.\",\"dateModified\":\"2026-01-23T11:43:55.857Z\",\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/list-hubs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Activations\",\"item\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/activate-integration\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve an Activation\",\"item\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation#apireference\",\"headline\":\"Retrieve an Activation\",\"name\":\"Retrieve an Activation\",\"description\":\"GetActivation returns the Activation for the given ID.\",\"url\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation#webpage\"},\"dateModified\":\"2026-01-23T11:43:55.857Z\",\"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","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/legacy/welcome"}]},{"tab":"Integrate","pages":[{"title":"Integrate","href":"/legacy/integrate/intro"}]},{"tab":"Embedded","pages":[{"title":"Embedded","href":"/legacy/embedded/intro"}]},{"tab":"Switchboard (old)","pages":[{"title":"Switchboard (old)","href":"/legacy/switchboard/introduction"}]},{"tab":"API Reference","anchors":[{"anchor":"Authentication","pages":[{"title":"Authentication","href":"/legacy/api-reference/authentication"}]},{"anchor":"Connect API","pages":[{"title":"Connect API","href":"/legacy/api-reference/connect"}]},{"anchor":"Embedded API","pages":[{"title":"Introduction","href":"/legacy/api-reference/embedded"},{"group":"Endpoints","pages":[{"group":"Hubs","pages":[{"openapi":"get /o/{organisation_id}/hubs","title":"List Hubs","href":"/legacy/api-reference/embedded-api/hubs/list-hubs"},{"openapi":"post /hubs","title":"Create a new Hub","href":"/legacy/api-reference/embedded-api/hubs/create-a-new-hub"},{"openapi":"get /hubs/{hub_id}","title":"Retrieve a Hub","href":"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub"},{"openapi":"post /hubs/{hub_id}/integrations","title":"Create Integration","href":"/legacy/api-reference/embedded-api/hubs/create-integration"},{"openapi":"patch /integrations/{integration_id}","title":"Update integration information","href":"/legacy/api-reference/embedded-api/hubs/update-integration-information"}]},{"group":"End Users","pages":[{"openapi":"get /hubs/{hub_id}/users","title":"List End Users","href":"/legacy/api-reference/embedded-api/end-users/list-end-users"},{"openapi":"post /hubs/{hub_id}/users","title":"Create an End User","href":"/legacy/api-reference/embedded-api/end-users/create-an-end-user"},{"openapi":"get /hubs/{hub_id}/users/{user_id}","title":"Retrieve an End User","href":"/legacy/api-reference/embedded-api/end-users/retrieve-an-end-user"}]},{"group":"Connections","pages":[{"openapi":"get /hubs/{hub_id}/users/{user_id}/connections","title":"List End User Connections","href":"/legacy/api-reference/embedded-api/connections/list-end-user-connections"},{"openapi":"post /hubs/{hub_id}/users/{user_id}/connections","title":"Create End User Connection","href":"/legacy/api-reference/embedded-api/connections/create-end-user-connection"},{"openapi":"post /embed/{hub_id}/connector/{connector_id}/oauth2/initialise","title":"Initialise OAuth 2.0 Connection","href":"/legacy/api-reference/embedded-api/connections/initialise-oauth-20-connection"}]},{"group":"Integrations","pages":[{"openapi":"get /hubs/{hub_id}/integrations","title":"List Integrations","href":"/legacy/api-reference/embedded-api/integrations/list-integrations"},{"openapi":"delete /integrations/{integration_id}","title":"Delete an integration.","href":"/legacy/api-reference/embedded-api/integrations/delete-an-integration"}]},{"group":"Connectors","pages":[{"openapi":"get /integrations/{integration_id}/connection-templates","title":"List Hub Connectors","href":"/legacy/api-reference/embedded-api/connectors/list-hub-connectors"},{"openapi":"post /integrations/{integration_id}/connection-templates","title":"Create a Hub Connector","href":"/legacy/api-reference/embedded-api/connectors/create-a-hub-connector"}]},{"group":"Embed","pages":[{"openapi":"get /embed/{hub_id}/users/{user_id}/integrations","title":"List End User Integrations","href":"/legacy/api-reference/embedded-api/embedded/list-end-user-integrations"},{"openapi":"get /embed/{hub_id}/users/{user_id}/integrations/{integration_id}","title":"Retrieve an Embedded Integration","href":"/legacy/api-reference/embedded-api/embedded/retrieve-an-embedded-integration"},{"openapi":"get /embed/{hub_id}/users/{user_id}/activations","title":"List End User Activations","href":"/legacy/api-reference/embedded-api/embedded/list-end-user-activations"}]},{"group":"Activations","pages":[{"openapi":"post /activations","title":"Activate Integration","description":"ActivateIntegration activates an Integration for an End User. This is the final step in the activation\nprocess and will create the necessary connections and configurations to allow the Integration to run.\n\nThis endpoint can either reference existing connections or create new ones. Once these connections are \nresolved/created, if there are any missing connections to what the integration requires, an error will be \nreturned.\n","href":"/legacy/api-reference/embedded-api/activations/activate-integration"},{"openapi":"get /activations/{activation_id}","title":"Retrieve an Activation","href":"/legacy/api-reference/embedded-api/activations/retrieve-an-activation"},{"openapi":"delete /activations/{activation_id}","title":"Delete an Activation","description":"DeleteActivation deletes the Activation for the given ID.\n","href":"/legacy/api-reference/embedded-api/activations/delete-an-activation"}]},{"group":"Miscellaneous","pages":[{"openapi":"get /healthz","title":"Health Check","href":"/legacy/api-reference/embedded-api/miscellaneous/health-check"}]}]}]},{"anchor":"Organisations API","pages":[{"title":"Organisations API","href":"/legacy/api-reference/organisations-api"}]},{"anchor":"Proxy API","pages":[{"title":"Proxy API","href":"/legacy/api-reference/proxy-api"}]},{"anchor":"Switchboard API","pages":[{"title":"Switchboard API","href":"/legacy/api-reference/switchboard-api/preview-the-output-of-a-transformer"}]}]}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction"}]}]},"title":"Retrieve an Activation - 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"]}