{"items":[{"type":"link","label":"Management API","link":"/api-reference/management","routeSlug":"/api-reference/management","content":{"contentType":"overview","meta":{"name":"Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"management.json","url":"/_bundle/api-reference/management.json?download"},{"kind":"download","label":"management.yaml","url":"/_bundle/api-reference/management.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Management API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Synqly Management APIs enable you to manage the resources within your Synqly organization, such as setting up Accounts for your customers and creating Integrations to connect your product to the different service Providers supported by Synqly."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more information see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/guides/getting-started/overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Accounts","link":"/api-reference/management/accounts","routeSlug":"/api-reference/management/accounts","items":[{"label":"List Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/accounts/accounts_list","routeSlug":"/api-reference/management/accounts/accounts_list","metadata":{"seo":{"title":"List Accounts","description":"Returns a list of all Account objects. For more information onOrganizations and Accounts, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accounts_list","name":"List Accounts","isWebhook":false,"pointer":"/paths/~1v1~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects. For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organizations and Accounts, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accounts_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"total","in":"query","schemaId":"schema_3","description":"Return total number of accounts in the system, respecting all applied filters. This is expensive, use sparingly."}],"pointer":"/paths/~1v1~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"total","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/accounts","href":"accounts/accounts_list","openApiOperationId":"accounts_list","summary":"List Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountsResponse"}},"schemaId":"components/schemas/ListAccountsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAccountsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/accounts_list"}],"panels":[]}]},"httpPath":"/v1/accounts"},{"label":"Create Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/accounts/accounts_create","routeSlug":"/api-reference/management/accounts/accounts_create","metadata":{"seo":{"title":"Create Account","description":"Creates an Account object. For more information on Organizations andAccounts, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accounts_create","name":"Create Account","isWebhook":false,"pointer":"/paths/~1v1~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object. For more information on Organizations and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Accounts, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the request carries a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" block, a token scoped to the new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"created in the same transaction and returned in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"result.token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The token secret"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"is returned exactly once and cannot be retrieved again; if the response is lost,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"an organization administrator must issue a replacement token with"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/tokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accounts_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountRequest"}},"schemaId":"components/schemas/CreateAccountRequest","pointer":"/paths/~1v1~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounts","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAccountRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/accounts","href":"accounts/accounts_create","openApiOperationId":"accounts_create","summary":"Create Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAccountResponse"}},"schemaId":"components/schemas/CreateAccountResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAccountResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/accounts_create"}],"panels":[]}]},"httpPath":"/v1/accounts"},{"label":"Get Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/accounts/accounts_get","routeSlug":"/api-reference/management/accounts/accounts_get","metadata":{"seo":{"title":"Get Account","description":"Returns the Account object matching {accountId}. For more information onOrganizations and Accounts, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accounts_get","name":"Get Account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organizations and Accounts, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accounts_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1accounts~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/accounts/{accountId}","href":"accounts/accounts_get","openApiOperationId":"accounts_get","summary":"Get Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAccountResponse"}},"schemaId":"components/schemas/GetAccountResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1accounts~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAccountResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/accounts_get"}],"panels":[]}]},"httpPath":"/v1/accounts/{accountId}"},{"label":"Update Account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/accounts/accounts_update","routeSlug":"/api-reference/management/accounts/accounts_update","metadata":{"seo":{"title":"Update Account","description":"Updates the Account object matching {accountId}. For more information onOrganizations and Accounts, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accounts_update","name":"Update Account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{accountId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organizations and Accounts, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accounts_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1accounts~1{accountId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6"}},"schemaId":"schema_6","pointer":"/paths/~1v1~1accounts~1{accountId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounts/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_6"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/accounts/{accountId}","href":"accounts/accounts_update","openApiOperationId":"accounts_update","summary":"Update Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_6","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateAccountResponse"}},"schemaId":"components/schemas/UpdateAccountResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1accounts~1{accountId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateAccountResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/accounts_update"}],"panels":[]}]},"httpPath":"/v1/accounts/{accountId}"},{"label":"Patch Account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/accounts/accounts_patch","routeSlug":"/api-reference/management/accounts/accounts_patch","metadata":{"seo":{"title":"Patch Account","description":"Patches the Account object matching {accountId}. For more information onOrganizations and Accounts, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accounts_patch","name":"Patch Account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{accountId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organizations and Accounts, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accounts_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1accounts~1{accountId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1accounts~1{accountId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounts/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/accounts/{accountId}","href":"accounts/accounts_patch","openApiOperationId":"accounts_patch","summary":"Patch Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchAccountResponse"}},"schemaId":"components/schemas/PatchAccountResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1accounts~1{accountId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchAccountResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/accounts_patch"}],"panels":[]}]},"httpPath":"/v1/accounts/{accountId}"},{"label":"Delete Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/accounts/accounts_delete","routeSlug":"/api-reference/management/accounts/accounts_delete","metadata":{"seo":{"title":"Delete Account","description":"Deletes the Account matching {accountId}. Deleting an Account also deletesits Integrations and Credentials. Tokens scoped to the Account are notrevoked; they remain listed under GET /v1/tokens and should be deleted by anorganization administrator."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accounts_delete","name":"Delete Account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{accountId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Deleting an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" also deletes"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integrations"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credentials"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" scoped to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"revoked; they remain listed under "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/tokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and should be deleted by an"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organization administrator."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accounts_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1accounts~1{accountId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounts/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/accounts/{accountId}","href":"accounts/accounts_delete","openApiOperationId":"accounts_delete","summary":"Delete Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1accounts~1{accountId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/accounts_delete"}],"panels":[]}]},"httpPath":"/v1/accounts/{accountId}"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Accounts under your Organization are used to manage Integrations, Credentials, and other account specific resources. Accounts are secure containers and may be used to represent tenants in your system. Data is never shared across accounts."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more information on Accounts, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/guides/getting-started/overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounts","summary":"List Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/accounts_list","deprecated":false},{"title":"/v1/accounts","summary":"Create Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/accounts_create","deprecated":false},{"title":"/v1/accounts/{accountId}","summary":"Get Account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/accounts_get","deprecated":false},{"title":"/v1/accounts/{accountId}","summary":"Update Account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounts/accounts_update","deprecated":false},{"title":"/v1/accounts/{accountId}","summary":"Patch Account","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/accounts/accounts_patch","deprecated":false},{"title":"/v1/accounts/{accountId}","summary":"Delete Account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounts/accounts_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit","link":"/api-reference/management/audit","routeSlug":"/api-reference/management/audit","items":[{"label":"List Audit Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/audit/audit_list","routeSlug":"/api-reference/management/audit/audit_list","metadata":{"seo":{"title":"List Audit Events","description":"Returns a list of all Synqly Audit events for the Organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"audit_list","name":"List Audit Events","isWebhook":false,"pointer":"/paths/~1v1~1audit~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Audit Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all Synqly "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Audit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" events for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"audit_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Audit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Audit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"created_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The order defaults to created_at[asc] and can changed to descending order by specifying created_at[desc]."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1audit~1organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/audit/organizations","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_1"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/audit/organizations","href":"audit/audit_list","openApiOperationId":"audit_list","summary":"List Audit Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAuditEventsResponse"}},"schemaId":"components/schemas/ListAuditEventsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1audit~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAuditEventsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAuditEventsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/audit_list"}],"panels":[]}]},"httpPath":"/v1/audit/organizations"}],"content":{"contentType":"group","meta":{"name":"Audit"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/audit/organizations","summary":"List Audit Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/audit_list","deprecated":false}]}]}]}]}},{"type":"group","label":"Auth","link":"/api-reference/management/auth","routeSlug":"/api-reference/management/auth","items":[{"label":"Logon Organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_logon","routeSlug":"/api-reference/management/auth/auth_logon","metadata":{"seo":{"title":"Logon Organization","description":"Initiates a new session for the given member in specified Synqly organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_logon","name":"Logon Organization","isWebhook":false,"pointer":"/paths/~1v1~1auth~1logon~1{organizationId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logon Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Initiates a new session for the given member in specified Synqly organization."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_logon"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1v1~1auth~1logon~1{organizationId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LogonRequest"}},"schemaId":"components/schemas/LogonRequest","pointer":"/paths/~1v1~1auth~1logon~1{organizationId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/logon/{organizationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LogonRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/auth/logon/{organizationId}","href":"auth/auth_logon","openApiOperationId":"auth_logon","summary":"Logon Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/LogonRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LogonRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LogonResponse"}},"schemaId":"components/schemas/LogonResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1logon~1{organizationId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LogonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LogonResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_logon"}],"panels":[]}]},"httpPath":"/v1/auth/logon/{organizationId}"},{"label":"Change Member Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_change_password","routeSlug":"/api-reference/management/auth/auth_change_password","metadata":{"seo":{"title":"Change Member Password","description":"Change member password."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_change_password","name":"Change Member Password","isWebhook":false,"pointer":"/paths/~1v1~1auth~1change_password/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Member Password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Change member password."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_change_password"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChangePasswordRequest"}},"schemaId":"components/schemas/ChangePasswordRequest","pointer":"/paths/~1v1~1auth~1change_password/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/change_password","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChangePasswordRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/auth/change_password","href":"auth/auth_change_password","openApiOperationId":"auth_change_password","summary":"Change Member Password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/ChangePasswordRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChangePasswordRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangePasswordResponse"}},"schemaId":"components/schemas/ChangePasswordResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1change_password/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChangePasswordResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangePasswordResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_change_password"}],"panels":[]}]},"httpPath":"/v1/auth/change_password"},{"label":"Logoff","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_logoff","routeSlug":"/api-reference/management/auth/auth_logoff","metadata":{"seo":{"title":"Logoff","description":"Terminates the session identified by the given logon token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_logoff","name":"Logoff","isWebhook":false,"pointer":"/paths/~1v1~1auth~1logoff/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logoff","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Terminates the session identified by the given logon token."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_logoff"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/logoff","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/auth/logoff","href":"auth/auth_logoff","openApiOperationId":"auth_logoff","summary":"Logoff"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1logoff/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_logoff"}],"panels":[]}]},"httpPath":"/v1/auth/logoff"},{"label":"Create Authentication Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_create_configuration","routeSlug":"/api-reference/management/auth/auth_create_configuration","metadata":{"seo":{"title":"Create Authentication Configuration","description":"Configure an authentication method for the organization — an external IdentityProvider (OIDC or SAML) or built-in (password-based) authentication.Returns the created resource with its assigned authentication configuration ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_create_configuration","name":"Create Authentication Configuration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1configurations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Authentication Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configure an authentication method for the organization — an external Identity"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Provider (OIDC or SAML) or built-in (password-based) authentication."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the created resource with its assigned authentication configuration ID."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_create_configuration"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAuthConfigurationRequest"}},"schemaId":"components/schemas/CreateAuthConfigurationRequest","pointer":"/paths/~1v1~1auth~1configurations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/configurations","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAuthConfigurationRequest"}},"responseCodes":["200","400","401","402","403","409","415","429","500"],"pointer":"/v1/auth/configurations","href":"auth/auth_create_configuration","openApiOperationId":"auth_create_configuration","summary":"Create Authentication Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateAuthConfigurationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAuthConfigurationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAuthConfigurationResponse"}},"schemaId":"components/schemas/CreateAuthConfigurationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1configurations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateAuthConfigurationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAuthConfigurationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_create_configuration"}],"panels":[]}]},"httpPath":"/v1/auth/configurations"},{"label":"List Authentication Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_list_configurations","routeSlug":"/api-reference/management/auth/auth_list_configurations","metadata":{"seo":{"title":"List Authentication Configurations","description":"List all authentication configurations for the organization.Client secrets are not included."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_list_configurations","name":"List Authentication Configurations","isWebhook":false,"pointer":"/paths/~1v1~1auth~1configurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Authentication Configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List all authentication configurations for the organization."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Client secrets are not included."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_list_configurations"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/configurations","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","402","403","429","500"],"pointer":"/v1/auth/configurations","href":"auth/auth_list_configurations","openApiOperationId":"auth_list_configurations","summary":"List Authentication Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAuthConfigurationsResponse"}},"schemaId":"components/schemas/ListAuthConfigurationsResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1configurations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAuthConfigurationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAuthConfigurationsResponse"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_list_configurations"}],"panels":[]}]},"httpPath":"/v1/auth/configurations"},{"label":"Get Authentication Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_get_configuration","routeSlug":"/api-reference/management/auth/auth_get_configuration","metadata":{"seo":{"title":"Get Authentication Configuration","description":"Retrieve a specific authentication configuration. The client secret is not included."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_get_configuration","name":"Get Authentication Configuration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Authentication Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a specific authentication configuration. The client secret is not included."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_get_configuration"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_10","required":true}],"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/configurations/{configurationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","402","403","404","429","500"],"pointer":"/v1/auth/configurations/{configurationId}","href":"auth/auth_get_configuration","openApiOperationId":"auth_get_configuration","summary":"Get Authentication Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuthConfigurationResponse"}},"schemaId":"components/schemas/GetAuthConfigurationResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAuthConfigurationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuthConfigurationResponse"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_get_configuration"}],"panels":[]}]},"httpPath":"/v1/auth/configurations/{configurationId}"},{"label":"Update Authentication Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_update_configuration","routeSlug":"/api-reference/management/auth/auth_update_configuration","metadata":{"seo":{"title":"Update Authentication Configuration","description":"Update the authentication configuration by ID. This is a full replacement of theconfiguration. The updated_at field is used for optimistic lockingto prevent concurrent updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_update_configuration","name":"Update Authentication Configuration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Authentication Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update the authentication configuration by ID. This is a full replacement of the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"configuration. The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"updated_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field is used for optimistic locking"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"to prevent concurrent updates."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_update_configuration"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_10","required":true}],"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAuthConfigurationRequest"}},"schemaId":"components/schemas/UpdateAuthConfigurationRequest","pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/auth/configurations/{configurationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAuthConfigurationRequest"}},"responseCodes":["200","400","401","402","403","404","409","415","429","500"],"pointer":"/v1/auth/configurations/{configurationId}","href":"auth/auth_update_configuration","openApiOperationId":"auth_update_configuration","summary":"Update Authentication Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/UpdateAuthConfigurationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAuthConfigurationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateAuthConfigurationResponse"}},"schemaId":"components/schemas/UpdateAuthConfigurationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateAuthConfigurationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateAuthConfigurationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_update_configuration"}],"panels":[]}]},"httpPath":"/v1/auth/configurations/{configurationId}"},{"label":"Delete Authentication Configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_delete_configuration","routeSlug":"/api-reference/management/auth/auth_delete_configuration","metadata":{"seo":{"title":"Delete Authentication Configuration","description":"Remove a specific authentication configuration. This may disable signing onwith the identity provider defined in the configuration, and can result in memberslinked to that identity provider no longer being able to access the Organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_delete_configuration","name":"Delete Authentication Configuration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Authentication Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove a specific authentication configuration. This may disable signing on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"with the identity provider defined in the configuration, and can result in members"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"linked to that identity provider no longer being able to access the Organization."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_delete_configuration"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_10","required":true}],"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/auth/configurations/{configurationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","402","403","404","429","500"],"pointer":"/v1/auth/configurations/{configurationId}","href":"auth/auth_delete_configuration","openApiOperationId":"auth_delete_configuration","summary":"Delete Authentication Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1configurations~1{configurationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_delete_configuration"}],"panels":[]}]},"httpPath":"/v1/auth/configurations/{configurationId}"},{"label":"Get Authentication Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/auth/auth_get_metadata","routeSlug":"/api-reference/management/auth/auth_get_metadata","metadata":{"seo":{"title":"Get Authentication Metadata","description":"Returns configuration that must be used when configuring IdentityProviders, such as the OIDC redirect URI or SAML ACS URL and SPentity ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_get_metadata","name":"Get Authentication Metadata","isWebhook":false,"pointer":"/paths/~1v1~1auth~1meta/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Authentication Metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns configuration that must be used when configuring Identity"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Providers, such as the OIDC redirect URI or SAML ACS URL and SP"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"entity ID."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auth_get_metadata"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/meta","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","402","403","429","500"],"pointer":"/v1/auth/meta","href":"auth/auth_get_metadata","openApiOperationId":"auth_get_metadata","summary":"Get Authentication Metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuthMetadataResponse"}},"schemaId":"components/schemas/GetAuthMetadataResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1auth~1meta/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAuthMetadataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuthMetadataResponse"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/auth_get_metadata"}],"panels":[]}]},"httpPath":"/v1/auth/meta"}],"content":{"contentType":"group","meta":{"name":"Auth"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/auth/logon/{organizationId}","summary":"Logon Organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/auth_logon","deprecated":false},{"title":"/v1/auth/change_password","summary":"Change Member Password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/auth_change_password","deprecated":false},{"title":"/v1/auth/logoff","summary":"Logoff","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/auth_logoff","deprecated":false},{"title":"/v1/auth/configurations","summary":"Create Authentication Configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/auth_create_configuration","deprecated":false},{"title":"/v1/auth/configurations","summary":"List Authentication Configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/auth_list_configurations","deprecated":false},{"title":"/v1/auth/configurations/{configurationId}","summary":"Get Authentication Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/auth_get_configuration","deprecated":false},{"title":"/v1/auth/configurations/{configurationId}","summary":"Update Authentication Configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/auth/auth_update_configuration","deprecated":false},{"title":"/v1/auth/configurations/{configurationId}","summary":"Delete Authentication Configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/auth/auth_delete_configuration","deprecated":false},{"title":"/v1/auth/meta","summary":"Get Authentication Metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/auth_get_metadata","deprecated":false}]}]}]}]}},{"type":"group","label":"Bridges","link":"/api-reference/management/bridges","routeSlug":"/api-reference/management/bridges","items":[{"label":"List Bridge Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_list","routeSlug":"/api-reference/management/bridges/bridges_list","metadata":{"seo":{"title":"List Bridge Groups","description":"Returns a list of all Bridge Group objects that match the query params."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_list","name":"List Bridge Groups","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Bridge Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects that match the query params."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1bridges~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bridges/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}","href":"bridges/bridges_list","openApiOperationId":"bridges_list","summary":"List Bridge Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBridgesResponse"}},"schemaId":"components/schemas/ListBridgesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBridgesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBridgesResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_list"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}"},{"label":"Create Bridge Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_create","routeSlug":"/api-reference/management/bridges/bridges_create","metadata":{"seo":{"title":"Create Bridge Group","description":"Creates a Bridge Group with a unique identifier and authenticationcredentials. This allows for Bridge Agents to connect to Synqly. Formore information on Bridges, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_create","name":"Create Bridge Group","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Bridge Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with a unique identifier and authentication"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials. This allows for Bridge Agents to connect to Synqly. For"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"more information on Bridges, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBridgeRequest"}},"schemaId":"components/schemas/CreateBridgeRequest","pointer":"/paths/~1v1~1bridges~1{accountId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/bridges/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBridgeRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}","href":"bridges/bridges_create","openApiOperationId":"bridges_create","summary":"Create Bridge Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateBridgeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBridgeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBridgeResponse"}},"schemaId":"components/schemas/CreateBridgeResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateBridgeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBridgeResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_create"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}"},{"label":"Get Bridge Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_get","routeSlug":"/api-reference/management/bridges/bridges_get","metadata":{"seo":{"title":"Get Bridge Groups","description":"Returns the Bridge Group object matching {bridgeId}. For more information on Bridges, refer to theBridge Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_get","name":"Get Bridge Groups","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Bridge Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the Bridge Group object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{bridgeId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on Bridges, refer to the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"bridgeId","in":"path","schemaId":"schema_12","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bridges/{accountId}/{bridgeId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"bridgeId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}/{bridgeId}","href":"bridges/bridges_get","openApiOperationId":"bridges_get","summary":"Get Bridge Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBridgeResponse"}},"schemaId":"components/schemas/GetBridgeResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBridgeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBridgeResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_get"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}/{bridgeId}"},{"label":"Update Bridge Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_update","routeSlug":"/api-reference/management/bridges/bridges_update","metadata":{"seo":{"title":"Update Bridge Group","description":"Updates the Bridge Group object matching {bridgeId}. For more information on Bridges, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_update","name":"Update Bridge Group","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Bridge Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{bridgeId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on Bridges, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"bridgeId","in":"path","schemaId":"schema_12","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14","pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/bridges/{accountId}/{bridgeId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"bridgeId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_14"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}/{bridgeId}","href":"bridges/bridges_update","openApiOperationId":"bridges_update","summary":"Update Bridge Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateBridgeResponse"}},"schemaId":"components/schemas/UpdateBridgeResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateBridgeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateBridgeResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_update"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}/{bridgeId}"},{"label":"Patch Bridge Group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_patch","routeSlug":"/api-reference/management/bridges/bridges_patch","metadata":{"seo":{"title":"Patch Bridge Group","description":"Patches the Bridge Group object matching {bridgeId}. For more information on Bridges, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_patch","name":"Patch Bridge Group","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Bridge Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{bridgeId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on Bridges, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"bridgeId","in":"path","schemaId":"schema_12","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/bridges/{accountId}/{bridgeId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"bridgeId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}/{bridgeId}","href":"bridges/bridges_patch","openApiOperationId":"bridges_patch","summary":"Patch Bridge Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchBridgeResponse"}},"schemaId":"components/schemas/PatchBridgeResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchBridgeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchBridgeResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_patch"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}/{bridgeId}"},{"label":"Delete Bridge Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_delete","routeSlug":"/api-reference/management/bridges/bridges_delete","metadata":{"seo":{"title":"Delete Bridge Group","description":"Deletes the Bridge Group matching {bridgeId}. Deleting an Bridge Group also deleteaall Tokens and Credentials belonging to the Bridge Group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_delete","name":"Delete Bridge Group","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Bridge Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{bridgeId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Deleting an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" also deletea"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credentials"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belonging to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bridge Group"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"bridgeId","in":"path","schemaId":"schema_12","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/bridges/{accountId}/{bridgeId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"bridgeId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}/{bridgeId}","href":"bridges/bridges_delete","openApiOperationId":"bridges_delete","summary":"Delete Bridge Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_delete"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}/{bridgeId}"},{"label":"Get Bridge Agent Statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/bridges/bridges_get_status","routeSlug":"/api-reference/management/bridges/bridges_get_status","metadata":{"seo":{"title":"Get Bridge Agent Statuses","description":"Returns the status and local configuration of running Bridges Agents in the Bridge Group {bridgeId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bridges_get_status","name":"Get Bridge Agent Statuses","isWebhook":false,"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Bridge Agent Statuses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the status and local configuration of running Bridges Agents in the Bridge Group "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{bridgeId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bridges_get_status"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"bridgeId","in":"path","schemaId":"schema_12","required":true}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bridges/{accountId}/{bridgeId}/status","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"bridgeId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/bridges/{accountId}/{bridgeId}/status","href":"bridges/bridges_get_status","openApiOperationId":"bridges_get_status","summary":"Get Bridge Agent Statuses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBridgeStatusResponse"}},"schemaId":"components/schemas/GetBridgeStatusResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1bridges~1{accountId}~1{bridgeId}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBridgeStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBridgeStatusResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bridges/bridges_get_status"}],"panels":[]}]},"httpPath":"/v1/bridges/{accountId}/{bridgeId}/status"}],"content":{"contentType":"group","meta":{"name":"Bridges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bridges","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/bridges/{accountId}","summary":"List Bridge Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bridges/bridges_list","deprecated":false},{"title":"/v1/bridges/{accountId}","summary":"Create Bridge Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bridges/bridges_create","deprecated":false},{"title":"/v1/bridges/{accountId}/{bridgeId}","summary":"Get Bridge Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bridges/bridges_get","deprecated":false},{"title":"/v1/bridges/{accountId}/{bridgeId}","summary":"Update Bridge Group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bridges/bridges_update","deprecated":false},{"title":"/v1/bridges/{accountId}/{bridgeId}","summary":"Patch Bridge Group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/bridges/bridges_patch","deprecated":false},{"title":"/v1/bridges/{accountId}/{bridgeId}","summary":"Delete Bridge Group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bridges/bridges_delete","deprecated":false},{"title":"/v1/bridges/{accountId}/{bridgeId}/status","summary":"Get Bridge Agent Statuses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bridges/bridges_get_status","deprecated":false}]}]}]}]}},{"type":"group","label":"Capabilities","link":"/api-reference/management/capabilities","routeSlug":"/api-reference/management/capabilities","items":[{"label":"List Connectors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/capabilities/capabilities_list_connectors","routeSlug":"/api-reference/management/capabilities/capabilities_list_connectors","metadata":{"seo":{"title":"List Connectors","description":"Returns a list of all Connectors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"capabilities_list_connectors","name":"List Connectors","isWebhook":false,"pointer":"/paths/~1v1~1capabilities~1connectors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Connectors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connectors"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"capabilities_list_connectors"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_15","description":"Expand the capabilities result fields that are otherwise\nomitted or returned as references to OpenAPI spec components.\nNOTE: This can yield very big response objects."}],"pointer":"/paths/~1v1~1capabilities~1connectors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/capabilities/connectors","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"expand","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/capabilities/connectors","href":"capabilities/capabilities_list_connectors","openApiOperationId":"capabilities_list_connectors","summary":"List Connectors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConnectorsCapabilitiesResponse"}},"schemaId":"components/schemas/ListConnectorsCapabilitiesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1capabilities~1connectors/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListConnectorsCapabilitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConnectorsCapabilitiesResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/capabilities/capabilities_list_connectors"}],"panels":[]}]},"httpPath":"/v1/capabilities/connectors"},{"label":"List Providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/capabilities/capabilities_list_providers","routeSlug":"/api-reference/management/capabilities/capabilities_list_providers","metadata":{"seo":{"title":"List Providers","description":"Returns a list of all Provider capabilities and their configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"capabilities_list_providers","name":"List Providers","isWebhook":false,"pointer":"/paths/~1v1~1capabilities~1providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all Provider capabilities and their configurations."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"capabilities_list_providers"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_16","description":"Expand the capabilities result fields that are otherwise\nomitted or returned as references to OpenAPI spec components.\nNOTE: This can yield very big response objects."}],"pointer":"/paths/~1v1~1capabilities~1providers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/capabilities/providers","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"expand","in":"query","required":false,"schemaId":"schema_16"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/capabilities/providers","href":"capabilities/capabilities_list_providers","openApiOperationId":"capabilities_list_providers","summary":"List Providers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProvidersCapabilitiesResponse"}},"schemaId":"components/schemas/ListProvidersCapabilitiesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1capabilities~1providers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListProvidersCapabilitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProvidersCapabilitiesResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/capabilities/capabilities_list_providers"}],"panels":[]}]},"httpPath":"/v1/capabilities/providers"},{"label":"Get Provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/capabilities/capabilities_get_provider","routeSlug":"/api-reference/management/capabilities/capabilities_get_provider","metadata":{"seo":{"title":"Get Provider","description":"Returns the capabilities and configurations for a specific Provider type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"capabilities_get_provider","name":"Get Provider","isWebhook":false,"pointer":"/paths/~1v1~1capabilities~1providers~1{providerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the capabilities and configurations for a specific Provider type"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"capabilities_get_provider"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_17","required":true}],"pointer":"/paths/~1v1~1capabilities~1providers~1{providerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_18","description":"Expand the capabilities result fields that are otherwise\nomitted or returned as references to OpenAPI spec components.\nNOTE: This can yield very big response objects."}],"pointer":"/paths/~1v1~1capabilities~1providers~1{providerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/capabilities/providers/{providerId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"schemaId":"components/schemas/ProviderConfigId"}],"query":[{"name":"expand","in":"query","required":false,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","415","429","500"],"pointer":"/v1/capabilities/providers/{providerId}","href":"capabilities/capabilities_get_provider","openApiOperationId":"capabilities_get_provider","summary":"Get Provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderCapabilitiesResponse"}},"schemaId":"components/schemas/ProviderCapabilitiesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1capabilities~1providers~1{providerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderCapabilitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderCapabilitiesResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/capabilities/capabilities_get_provider"}],"panels":[]}]},"httpPath":"/v1/capabilities/providers/{providerId}"}],"content":{"contentType":"group","meta":{"name":"Capabilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capabilities","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/capabilities/connectors","summary":"List Connectors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/capabilities/capabilities_list_connectors","deprecated":false},{"title":"/v1/capabilities/providers","summary":"List Providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/capabilities/capabilities_list_providers","deprecated":false},{"title":"/v1/capabilities/providers/{providerId}","summary":"Get Provider","prefix":{"name":"get","color":"get"},"badges":[],"link":"/capabilities/capabilities_get_provider","deprecated":false}]}]}]}]}},{"type":"group","label":"Credentials","link":"/api-reference/management/credentials","routeSlug":"/api-reference/management/credentials","items":[{"label":"List Credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_list","routeSlug":"/api-reference/management/credentials/credentials_list","metadata":{"seo":{"title":"List Credentials","description":"Returns a list of all Credential objects belonging to the Account, Integration, or IntegrationPoint, or OrganizationWebhook matching{ownerId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_list","name":"List Credentials","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1{ownerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects belonging to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1v1~1credentials~1{ownerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1credentials~1{ownerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credentials/{ownerId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/{ownerId}","href":"credentials/credentials_list","openApiOperationId":"credentials_list","summary":"List Credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCredentialsResponse"}},"schemaId":"components/schemas/ListCredentialsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1{ownerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCredentialsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCredentialsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_list"}],"panels":[]}]},"httpPath":"/v1/credentials/{ownerId}"},{"label":"Create Credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_create","routeSlug":"/api-reference/management/credentials/credentials_create","metadata":{"seo":{"title":"Create Credential","description":"Creates a Credential object in the Account, IntegrationPoint, or OrganizationWebhook matching matching{ownerId}. A Credential may only by used by a single Account, Integration, IntegrationPoint or OrganizationWebhook;however, Credential objects can be shared by multiple Integrations within an Account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_create","name":"Create Credential","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1{ownerId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching matching"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". A "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" may only by used by a single "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":";"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"however, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects can be shared by multiple "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integrations"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" within an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1v1~1credentials~1{ownerId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCredentialRequest"}},"schemaId":"components/schemas/CreateCredentialRequest","pointer":"/paths/~1v1~1credentials~1{ownerId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credentials/{ownerId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCredentialRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/{ownerId}","href":"credentials/credentials_create","openApiOperationId":"credentials_create","summary":"Create Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateCredentialRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCredentialRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCredentialResponse"}},"schemaId":"components/schemas/CreateCredentialResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1{ownerId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateCredentialResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCredentialResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_create"}],"panels":[]}]},"httpPath":"/v1/credentials/{ownerId}"},{"label":"Get Credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_get","routeSlug":"/api-reference/management/credentials/credentials_get","metadata":{"seo":{"title":"Get Credential","description":"Returns the Credential object matching {credentialId} where theCredential belongs to the Account, Integration, IntegrationPoint or OrganizationWebhook matching {ownerId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_get","name":"Get Credential","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{credentialId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" where the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true},{"name":"credentialId","in":"path","schemaId":"schema_20","required":true}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credentials/{ownerId}/{credentialId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"},{"name":"credentialId","in":"path","required":true,"schemaId":"components/schemas/AwsCredentialId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/{ownerId}/{credentialId}","href":"credentials/credentials_get","openApiOperationId":"credentials_get","summary":"Get Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCredentialResponse"}},"schemaId":"components/schemas/GetCredentialResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCredentialResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCredentialResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_get"}],"panels":[]}]},"httpPath":"/v1/credentials/{ownerId}/{credentialId}"},{"label":"Update Credential","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_update","routeSlug":"/api-reference/management/credentials/credentials_update","metadata":{"seo":{"title":"Update Credential","description":"Updates the Credential object matching {credentialId}, where theCredential belongs to the Account, Integration,IntegrationPoint or OrganizationWebhook matching {ownerId}. Theowner of a Credential cannot be changed. {ownerId} must be thecredential's owner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_update","name":"Update Credential","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{credentialId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", where the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"owner of a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" cannot be changed. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must be the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credential's owner."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true},{"name":"credentialId","in":"path","schemaId":"schema_20","required":true}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21","pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credentials/{ownerId}/{credentialId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"},{"name":"credentialId","in":"path","required":true,"schemaId":"components/schemas/AwsCredentialId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/{ownerId}/{credentialId}","href":"credentials/credentials_update","openApiOperationId":"credentials_update","summary":"Update Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateCredentialResponse"}},"schemaId":"components/schemas/UpdateCredentialResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateCredentialResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateCredentialResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_update"}],"panels":[]}]},"httpPath":"/v1/credentials/{ownerId}/{credentialId}"},{"label":"Patch Credential","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_patch","routeSlug":"/api-reference/management/credentials/credentials_patch","metadata":{"seo":{"title":"Patch Credential","description":"Patches the Credential object matching {credentialId}, where theCredential belongs to the Account, Integration, IntegrationPoint or OrganizationWebhook matching {ownerId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_patch","name":"Patch Credential","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{credentialId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", where the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This endpoint accepts only a restricted set of patch shapes:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"add"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"remove"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"replace"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" operations, targeting "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/fullname"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/expires"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/config"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field. The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"copy"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"move"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"test"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" operations are not accepted. Any other operation or path is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"rejected with a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The owner of a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" cannot be changed. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must be the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credential's owner."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true},{"name":"credentialId","in":"path","schemaId":"schema_20","required":true}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/credentials/{ownerId}/{credentialId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"},{"name":"credentialId","in":"path","required":true,"schemaId":"components/schemas/AwsCredentialId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/{ownerId}/{credentialId}","href":"credentials/credentials_patch","openApiOperationId":"credentials_patch","summary":"Patch Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchCredentialResponse"}},"schemaId":"components/schemas/PatchCredentialResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchCredentialResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchCredentialResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_patch"}],"panels":[]}]},"httpPath":"/v1/credentials/{ownerId}/{credentialId}"},{"label":"Delete Credential","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_delete","routeSlug":"/api-reference/management/credentials/credentials_delete","metadata":{"seo":{"title":"Delete Credential","description":"Deletes the Credential object matching {credentialId}, where theCredential belongs to the Account, Integration, IntegrationPoint or OrganizationWebhook matching {ownerId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_delete","name":"Delete Credential","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{credentialId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", where the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OrganizationWebhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true},{"name":"credentialId","in":"path","schemaId":"schema_20","required":true}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/credentials/{ownerId}/{credentialId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"},{"name":"credentialId","in":"path","required":true,"schemaId":"components/schemas/AwsCredentialId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/{ownerId}/{credentialId}","href":"credentials/credentials_delete","openApiOperationId":"credentials_delete","summary":"Delete Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1{ownerId}~1{credentialId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_delete"}],"panels":[]}]},"httpPath":"/v1/credentials/{ownerId}/{credentialId}"},{"label":"Lookup Credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/credentials/credentials_lookup","routeSlug":"/api-reference/management/credentials/credentials_lookup","metadata":{"seo":{"title":"Lookup Credential","description":"Returns the Credential object matching {credentialId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credentials_lookup","name":"Lookup Credential","isWebhook":false,"pointer":"/paths/~1v1~1credentials~1lookup~1{credentialId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credential"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{credentialId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"credentials_lookup"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credentialId","in":"path","schemaId":"schema_20","required":true}],"pointer":"/paths/~1v1~1credentials~1lookup~1{credentialId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credentials/lookup/{credentialId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"credentialId","in":"path","required":true,"schemaId":"components/schemas/AwsCredentialId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/credentials/lookup/{credentialId}","href":"credentials/credentials_lookup","openApiOperationId":"credentials_lookup","summary":"Lookup Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LookupCredentialResponse"}},"schemaId":"components/schemas/LookupCredentialResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1credentials~1lookup~1{credentialId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LookupCredentialResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LookupCredentialResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/credentials_lookup"}],"panels":[]}]},"httpPath":"/v1/credentials/lookup/{credentialId}"}],"content":{"contentType":"group","meta":{"name":"Credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credentials","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/credentials/{ownerId}","summary":"List Credentials","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credentials/credentials_list","deprecated":false},{"title":"/v1/credentials/{ownerId}","summary":"Create Credential","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credentials/credentials_create","deprecated":false},{"title":"/v1/credentials/{ownerId}/{credentialId}","summary":"Get Credential","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credentials/credentials_get","deprecated":false},{"title":"/v1/credentials/{ownerId}/{credentialId}","summary":"Update Credential","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credentials/credentials_update","deprecated":false},{"title":"/v1/credentials/{ownerId}/{credentialId}","summary":"Patch Credential","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credentials/credentials_patch","deprecated":false},{"title":"/v1/credentials/{ownerId}/{credentialId}","summary":"Delete Credential","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credentials/credentials_delete","deprecated":false},{"title":"/v1/credentials/lookup/{credentialId}","summary":"Lookup Credential","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credentials/credentials_lookup","deprecated":false}]}]}]}]}},{"type":"group","label":"Integration Points","link":"/api-reference/management/integrationpoints","routeSlug":"/api-reference/management/integrationpoints","items":[{"label":"List Integration Points","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrationpoints/integrationpoints_list","routeSlug":"/api-reference/management/integrationpoints/integrationpoints_list","metadata":{"seo":{"title":"List Integration Points","description":"Returns a list of all IntegrationPoint objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrationPoints_list","name":"List Integration Points","isWebhook":false,"pointer":"/paths/~1v1~1integration-points/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Integration Points","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationPoints_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"total","in":"query","schemaId":"schema_3","description":"Return total number of integration points in the system, respecting all applied filters. This is expensive, use sparingly."}],"pointer":"/paths/~1v1~1integration-points/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/integration-points","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"total","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integration-points","href":"integrationpoints/integrationpoints_list","openApiOperationId":"integrationPoints_list","summary":"List Integration Points"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListIntegrationPointsResponse"}},"schemaId":"components/schemas/ListIntegrationPointsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integration-points/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListIntegrationPointsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListIntegrationPointsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrationpoints/integrationpoints_list"}],"panels":[]}]},"httpPath":"/v1/integration-points"},{"label":"Create Integration Point","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrationpoints/integrationpoints_create","routeSlug":"/api-reference/management/integrationpoints/integrationpoints_create","metadata":{"seo":{"title":"Create Integration Point","description":"Create a IntegrationPoint object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrationPoints_create","name":"Create Integration Point","isWebhook":false,"pointer":"/paths/~1v1~1integration-points/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Integration Point","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationPoints_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateIntegrationPointRequest"}},"schemaId":"components/schemas/CreateIntegrationPointRequest","pointer":"/paths/~1v1~1integration-points/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/integration-points","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateIntegrationPointRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integration-points","href":"integrationpoints/integrationpoints_create","openApiOperationId":"integrationPoints_create","summary":"Create Integration Point"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateIntegrationPointRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateIntegrationPointRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateIntegrationPointResponse"}},"schemaId":"components/schemas/CreateIntegrationPointResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integration-points/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateIntegrationPointResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateIntegrationPointResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrationpoints/integrationpoints_create"}],"panels":[]}]},"httpPath":"/v1/integration-points"},{"label":"Get Integration Point","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrationpoints/integrationpoints_get","routeSlug":"/api-reference/management/integrationpoints/integrationpoints_get","metadata":{"seo":{"title":"Get Integration Point","description":"Returns the IntegrationPoint object matching {integrationPointId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrationPoints_get","name":"Get Integration Point","isWebhook":false,"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Integration Point","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationPointId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationPoints_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"integrationPointId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/integration-points/{integrationPointId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"integrationPointId","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integration-points/{integrationPointId}","href":"integrationpoints/integrationpoints_get","openApiOperationId":"integrationPoints_get","summary":"Get Integration Point"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIntegrationPointResponse"}},"schemaId":"components/schemas/GetIntegrationPointResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetIntegrationPointResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIntegrationPointResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrationpoints/integrationpoints_get"}],"panels":[]}]},"httpPath":"/v1/integration-points/{integrationPointId}"},{"label":"Update Integration Point","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrationpoints/integrationpoints_update","routeSlug":"/api-reference/management/integrationpoints/integrationpoints_update","metadata":{"seo":{"title":"Update Integration Point","description":"Updates the IntegrationPoint object matching {integrationPointId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrationPoints_update","name":"Update Integration Point","isWebhook":false,"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Integration Point","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationPointId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationPoints_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"integrationPointId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/integration-points/{integrationPointId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"integrationPointId","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integration-points/{integrationPointId}","href":"integrationpoints/integrationpoints_update","openApiOperationId":"integrationPoints_update","summary":"Update Integration Point"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateIntegrationPointResponse"}},"schemaId":"components/schemas/UpdateIntegrationPointResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateIntegrationPointResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateIntegrationPointResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrationpoints/integrationpoints_update"}],"panels":[]}]},"httpPath":"/v1/integration-points/{integrationPointId}"},{"label":"Patch Integration Point","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrationpoints/integrationpoints_patch","routeSlug":"/api-reference/management/integrationpoints/integrationpoints_patch","metadata":{"seo":{"title":"Patch Integration Point","description":"Patches the IntegrationPoint object matching {integrationPointId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrationPoints_patch","name":"Patch Integration Point","isWebhook":false,"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Integration Point","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationPointId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationPoints_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"integrationPointId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/integration-points/{integrationPointId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"integrationPointId","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integration-points/{integrationPointId}","href":"integrationpoints/integrationpoints_patch","openApiOperationId":"integrationPoints_patch","summary":"Patch Integration Point"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchIntegrationPointResponse"}},"schemaId":"components/schemas/PatchIntegrationPointResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchIntegrationPointResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchIntegrationPointResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrationpoints/integrationpoints_patch"}],"panels":[]}]},"httpPath":"/v1/integration-points/{integrationPointId}"},{"label":"Delete Integration Point","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrationpoints/integrationpoints_delete","routeSlug":"/api-reference/management/integrationpoints/integrationpoints_delete","metadata":{"seo":{"title":"Delete Integration Point","description":"Deletes the IntegrationPoint object matching {integrationPointId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrationPoints_delete","name":"Delete Integration Point","isWebhook":false,"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Integration Point","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"IntegrationPoint"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationPointId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationPoints_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"integrationPointId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/integration-points/{integrationPointId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"integrationPointId","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integration-points/{integrationPointId}","href":"integrationpoints/integrationpoints_delete","openApiOperationId":"integrationPoints_delete","summary":"Delete Integration Point"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integration-points~1{integrationPointId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrationpoints/integrationpoints_delete"}],"panels":[]}]},"httpPath":"/v1/integration-points/{integrationPointId}"}],"content":{"contentType":"group","meta":{"name":"IntegrationPoints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Integration Points","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An Integration Point describes a class of Integrations, and lets you describe names, allowed providers and other configuration that should apply to integrations associated with the Integration Point."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"While an Integration can be created without associating it with an Integration Point, some Synqly features require the use of Integration Points, such as:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://synqly.com/synqly-connector-ui/"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connect UI"},"children":[],"type":"text"}],"type":"link"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Validating allowed providers"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom data mapping (coming soon)"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration Points belong to the Organization, and can be associated with Integrations belonging to different Accounts."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more information on Integration Points, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/guides/getting-started/overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/integration-points","summary":"List Integration Points","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrationpoints/integrationpoints_list","deprecated":false},{"title":"/v1/integration-points","summary":"Create Integration Point","prefix":{"name":"post","color":"post"},"badges":[],"link":"/integrationpoints/integrationpoints_create","deprecated":false},{"title":"/v1/integration-points/{integrationPointId}","summary":"Get Integration Point","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrationpoints/integrationpoints_get","deprecated":false},{"title":"/v1/integration-points/{integrationPointId}","summary":"Update Integration Point","prefix":{"name":"put","color":"put"},"badges":[],"link":"/integrationpoints/integrationpoints_update","deprecated":false},{"title":"/v1/integration-points/{integrationPointId}","summary":"Patch Integration Point","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/integrationpoints/integrationpoints_patch","deprecated":false},{"title":"/v1/integration-points/{integrationPointId}","summary":"Delete Integration Point","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/integrationpoints/integrationpoints_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Integrations","link":"/api-reference/management/integrations","routeSlug":"/api-reference/management/integrations","items":[{"label":"List Integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_list","routeSlug":"/api-reference/management/integrations/integrations_list","metadata":{"seo":{"title":"List Integrations","description":"Returns a list of all Integration objects that match the query params."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_list","name":"List Integrations","isWebhook":false,"pointer":"/paths/~1v1~1integrations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Integrations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects that match the query params."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"expand","in":"query","schemaId":"schema_25","description":"Expand the integration result with the related integration point and/or account information."},{"name":"total","in":"query","schemaId":"schema_3","description":"Return total number of all integrations in the system, respecting all applied filters. This is expensive, use sparingly."}],"pointer":"/paths/~1v1~1integrations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/integrations","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"expand","in":"query","required":false,"schemaId":"schema_25"},{"name":"total","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integrations","href":"integrations/integrations_list","openApiOperationId":"integrations_list","summary":"List Integrations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListIntegrationsResponse"}},"schemaId":"components/schemas/ListIntegrationsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListIntegrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListIntegrationsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_list"}],"panels":[]}]},"httpPath":"/v1/integrations"},{"label":"List Account Integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_list_account","routeSlug":"/api-reference/management/integrations/integrations_list_account","metadata":{"seo":{"title":"List Account Integrations","description":"Returns a list of all Integration objects belonging to theAccount matching {accountId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_list_account","name":"List Account Integrations","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Integrations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects belonging to the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_list_account"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"expand","in":"query","schemaId":"schema_25","description":"Expand the integration result with the related integration point and/or account information."},{"name":"total","in":"query","schemaId":"schema_3","description":"Return total number of integrations for a particular account. This is expensive, use sparingly."}],"pointer":"/paths/~1v1~1integrations~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/integrations/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"expand","in":"query","required":false,"schemaId":"schema_25"},{"name":"total","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integrations/{accountId}","href":"integrations/integrations_list_account","openApiOperationId":"integrations_list_account","summary":"List Account Integrations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountIntegrationsResponse"}},"schemaId":"components/schemas/ListAccountIntegrationsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAccountIntegrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountIntegrationsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_list_account"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}"},{"label":"Create Integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_create","routeSlug":"/api-reference/management/integrations/integrations_create","metadata":{"seo":{"title":"Create Integration","description":"Creates an Integration object belonging to the Account matching{accountId}. Configures the Integration with the Provider specifiedin the request. Returns an Integration token for use with Integration APIs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_create","name":"Create Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object belonging to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Configures the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the Provider specified"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"in the request. Returns an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" token for use with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateIntegrationRequest"}},"schemaId":"components/schemas/CreateIntegrationRequest","pointer":"/paths/~1v1~1integrations~1{accountId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/integrations/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateIntegrationRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500","501","502","503","504"],"pointer":"/v1/integrations/{accountId}","href":"integrations/integrations_create","openApiOperationId":"integrations_create","summary":"Create Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateIntegrationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateIntegrationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateIntegrationResponse"}},"schemaId":"components/schemas/CreateIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"501","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"504","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"501","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_create"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}"},{"label":"Get Integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_get","routeSlug":"/api-reference/management/integrations/integrations_get","metadata":{"seo":{"title":"Get Integration","description":"Returns the Integration object matching {integrationId} wherethe Integration belongs to the Account matching {accountId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_get","name":"Get Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" where"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/integrations/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integrations/{accountId}/{integrationId}","href":"integrations/integrations_get","openApiOperationId":"integrations_get","summary":"Get Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIntegrationResponse"}},"schemaId":"components/schemas/GetIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_get"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/{integrationId}"},{"label":"Update Integration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_update","routeSlug":"/api-reference/management/integrations/integrations_update","metadata":{"seo":{"title":"Update Integration","description":"Updates the Integration object matching {integrationId}, where theIntegration belongs to the Account matching {accountId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_update","name":"Update Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", where the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28","pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/integrations/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_28"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integrations/{accountId}/{integrationId}","href":"integrations/integrations_update","openApiOperationId":"integrations_update","summary":"Update Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_28"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateIntegrationResponse"}},"schemaId":"components/schemas/UpdateIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_update"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/{integrationId}"},{"label":"Patch Integration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_patch","routeSlug":"/api-reference/management/integrations/integrations_patch","metadata":{"seo":{"title":"Patch Integration","description":"Patches the Integration object matching {integrationId}, where theIntegration belongs to the Account matching {accountId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_patch","name":"Patch Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", where the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belongs to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/integrations/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integrations/{accountId}/{integrationId}","href":"integrations/integrations_patch","openApiOperationId":"integrations_patch","summary":"Patch Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchIntegrationResponse"}},"schemaId":"components/schemas/PatchIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_patch"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/{integrationId}"},{"label":"Delete Integration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_delete","routeSlug":"/api-reference/management/integrations/integrations_delete","metadata":{"seo":{"title":"Delete Integration","description":"Deletes the Integration object matching {integrationId}, where the Integrationbelongs to theAccountmatching{accountId}. Deleting an Integration` also deletes any tokens that belong to it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_delete","name":"Delete Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationId}, where the "},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"belongs to the"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"matching"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Deleting an "},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration` also deletes any tokens that belong to it."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/integrations/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/integrations/{accountId}/{integrationId}","href":"integrations/integrations_delete","openApiOperationId":"integrations_delete","summary":"Delete Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_delete"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/{integrationId}"},{"label":"Verify Integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_verify","routeSlug":"/api-reference/management/integrations/integrations_verify","metadata":{"seo":{"title":"Verify Integration","description":"Verifies an ephemeral Integration and provider configuration and tests the authentication and provider connectivity.The provider config credential IDs can utilize persistent IDs or use \"#/n\" reference IDs;where (n) is the zero based offset in the optional credentials list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_verify","name":"Verify Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Verifies an ephemeral "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and provider configuration and tests the authentication and provider connectivity."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The provider config credential IDs can utilize persistent IDs or use \"#/n\" reference IDs;"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"where (n) is the zero based offset in the optional credentials list."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_verify"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationRequest"}},"schemaId":"components/schemas/VerifyIntegrationRequest","pointer":"/paths/~1v1~1integrations~1{accountId}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/integrations/{accountId}/verify","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500","501","502","503","504"],"pointer":"/v1/integrations/{accountId}/verify","href":"integrations/integrations_verify","openApiOperationId":"integrations_verify","summary":"Verify Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/VerifyIntegrationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationResponse"}},"schemaId":"components/schemas/VerifyIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"501","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"504","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerifyIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"501","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_verify"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/verify"},{"label":"Verify Existing Integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_verify_existing","routeSlug":"/api-reference/management/integrations/integrations_verify_existing","metadata":{"seo":{"title":"Verify Existing Integration","description":"Verifies the Integration matching {integrationId} and tests authenticationand provider connectivity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_verify_existing","name":"Verify Existing Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify Existing Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Verifies the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and tests authentication"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and provider connectivity."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When called without a request body, the stored integration configuration is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"verified. When a request body is provided, it uses the same shape as the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update Integration API; the integration is verified as if that update were"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"applied, without persisting changes."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_verify_existing"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28","pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/integrations/{accountId}/{integrationId}/verify","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_28"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500","501","502","503","504"],"pointer":"/v1/integrations/{accountId}/{integrationId}/verify","href":"integrations/integrations_verify_existing","openApiOperationId":"integrations_verify_existing","summary":"Verify Existing Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_28"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationResponse"}},"schemaId":"components/schemas/VerifyIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"501","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"502","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"504","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerifyIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"501","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"502","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"504","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_verify_existing"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/{integrationId}/verify"},{"label":"Authorize Integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/integrations/integrations_authorize","routeSlug":"/api-reference/management/integrations/integrations_authorize","metadata":{"seo":{"title":"Authorize Integration","description":"Returns a new single-use link to installthe OAuth app of the Integration matching {integrationId}. Onlyintegrations whose provider config uses an o_auth_code credential can beauthorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"integrations_authorize","name":"Authorize Integration","isWebhook":false,"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1authorize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorize Integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a new single-use link to install"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the OAuth app of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{integrationId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Only"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations whose provider config uses an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credential can be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"authorized."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Issuing a link replaces any earlier link for the integration. It does not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"change an installed integration: the integration keeps running until the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"new consent completes, and then runs with the install that consent"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"completed."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use it to finish a pending install, to re-consent after the app's"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"permissions changed, or to reinstall after the app was removed."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The link is short-lived: issue it when the administrator asks to install,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and send their browser to it straight away."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations_authorize"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1authorize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthorizeIntegrationRequest"}},"schemaId":"components/schemas/AuthorizeIntegrationRequest","pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1authorize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/integrations/{accountId}/{integrationId}/authorize","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuthorizeIntegrationRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500","503"],"pointer":"/v1/integrations/{accountId}/{integrationId}/authorize","href":"integrations/integrations_authorize","openApiOperationId":"integrations_authorize","summary":"Authorize Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/AuthorizeIntegrationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthorizeIntegrationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthorizeIntegrationResponse"}},"schemaId":"components/schemas/AuthorizeIntegrationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"503","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1integrations~1{accountId}~1{integrationId}~1authorize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthorizeIntegrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthorizeIntegrationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"503","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrations/integrations_authorize"}],"panels":[]}]},"httpPath":"/v1/integrations/{accountId}/{integrationId}/authorize"}],"content":{"contentType":"group","meta":{"name":"Integrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Integrations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An Integration represents the connection to a specific Provider. Once configured, an Integration enables interaction with the target Provider via our unified and normalized "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/api-reference/connectors"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connector APIs"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Each Integration belongs to an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/api-reference/management/accounts"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and may be associated with an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/api-reference/management/integrationpoints"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration Point"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to provide additional features and configuration."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more information on Integrations, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/guides/getting-started/overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/integrations","summary":"List Integrations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrations/integrations_list","deprecated":false},{"title":"/v1/integrations/{accountId}","summary":"List Account Integrations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrations/integrations_list_account","deprecated":false},{"title":"/v1/integrations/{accountId}","summary":"Create Integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/integrations/integrations_create","deprecated":false},{"title":"/v1/integrations/{accountId}/{integrationId}","summary":"Get Integration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrations/integrations_get","deprecated":false},{"title":"/v1/integrations/{accountId}/{integrationId}","summary":"Update Integration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/integrations/integrations_update","deprecated":false},{"title":"/v1/integrations/{accountId}/{integrationId}","summary":"Patch Integration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/integrations/integrations_patch","deprecated":false},{"title":"/v1/integrations/{accountId}/{integrationId}","summary":"Delete Integration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/integrations/integrations_delete","deprecated":false},{"title":"/v1/integrations/{accountId}/verify","summary":"Verify Integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/integrations/integrations_verify","deprecated":false},{"title":"/v1/integrations/{accountId}/{integrationId}/verify","summary":"Verify Existing Integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/integrations/integrations_verify_existing","deprecated":false},{"title":"/v1/integrations/{accountId}/{integrationId}/authorize","summary":"Authorize Integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/integrations/integrations_authorize","deprecated":false}]}]}]}]}},{"type":"group","label":"Mappings (In Development)","link":"/api-reference/management/mappings","routeSlug":"/api-reference/management/mappings","items":[{"label":"List Mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_list","routeSlug":"/api-reference/management/mappings/mappings_list","metadata":{"seo":{"title":"List Mappings","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_list","name":"List Mappings","isWebhook":false,"pointer":"/paths/~1v1~1mappings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Mappings","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Mapping"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of mapping objects to return in this page. Defaults to 100. Items listed will not include the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return mapping objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"total","in":"query","schemaId":"schema_3","description":"Return total number of mappings in the system, respecting all applied filters. This is expensive, use sparingly."}],"pointer":"/paths/~1v1~1mappings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/mappings","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"total","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings","href":"mappings/mappings_list","openApiOperationId":"mappings_list","summary":"List Mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMappingsResponse"}},"schemaId":"components/schemas/ListMappingsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMappingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMappingsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_list"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings"},{"label":"Create Mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_create","routeSlug":"/api-reference/management/mappings/mappings_create","metadata":{"seo":{"title":"Create Mapping","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_create","name":"Create Mapping","isWebhook":false,"pointer":"/paths/~1v1~1mappings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Mapping","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates an mapping object."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMappingRequest"}},"schemaId":"components/schemas/CreateMappingRequest","pointer":"/paths/~1v1~1mappings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/mappings","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateMappingRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings","href":"mappings/mappings_create","openApiOperationId":"mappings_create","summary":"Create Mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateMappingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMappingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMappingResponse"}},"schemaId":"components/schemas/CreateMappingResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMappingResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_create"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings"},{"label":"Get Mapping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_get","routeSlug":"/api-reference/management/mappings/mappings_get","metadata":{"seo":{"title":"Get Mapping","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_get","name":"Get Mapping","isWebhook":false,"pointer":"/paths/~1v1~1mappings~1{mappingId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Mapping","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Mapping"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{mappingId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". This response will include the full "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"mappingId","in":"path","schemaId":"schema_29","required":true}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/mappings/{mappingId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"mappingId","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings/{mappingId}","href":"mappings/mappings_get","openApiOperationId":"mappings_get","summary":"Get Mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMappingResponse"}},"schemaId":"components/schemas/GetMappingResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMappingResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_get"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings/{mappingId}"},{"label":"Update Mapping","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_update","routeSlug":"/api-reference/management/mappings/mappings_update","metadata":{"seo":{"title":"Update Mapping","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_update","name":"Update Mapping","isWebhook":false,"pointer":"/paths/~1v1~1mappings~1{mappingId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Mapping","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the mapping object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{mappingId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"mappingId","in":"path","schemaId":"schema_29","required":true}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31","pointer":"/paths/~1v1~1mappings~1{mappingId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/mappings/{mappingId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"mappingId","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_31"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings/{mappingId}","href":"mappings/mappings_update","openApiOperationId":"mappings_update","summary":"Update Mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateMappingResponse"}},"schemaId":"components/schemas/UpdateMappingResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateMappingResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_update"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings/{mappingId}"},{"label":"Patch Mapping","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_patch","routeSlug":"/api-reference/management/mappings/mappings_patch","metadata":{"seo":{"title":"Patch Mapping","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_patch","name":"Patch Mapping","isWebhook":false,"pointer":"/paths/~1v1~1mappings~1{mappingId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Mapping","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the mapping object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{mappingId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"mappingId","in":"path","schemaId":"schema_29","required":true}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1mappings~1{mappingId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/mappings/{mappingId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"mappingId","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings/{mappingId}","href":"mappings/mappings_patch","openApiOperationId":"mappings_patch","summary":"Patch Mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchMappingResponse"}},"schemaId":"components/schemas/PatchMappingResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchMappingResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_patch"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings/{mappingId}"},{"label":"Delete Mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_delete","routeSlug":"/api-reference/management/mappings/mappings_delete","metadata":{"seo":{"title":"Delete Mapping","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_delete","name":"Delete Mapping","isWebhook":false,"pointer":"/paths/~1v1~1mappings~1{mappingId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Mapping","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the mapping object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{mappingId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"mappingId","in":"path","schemaId":"schema_29","required":true}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/mappings/{mappingId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"mappingId","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings/{mappingId}","href":"mappings/mappings_delete","openApiOperationId":"mappings_delete","summary":"Delete Mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings~1{mappingId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_delete"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings/{mappingId}"},{"label":"Apply Mappings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/mappings/mappings_apply","routeSlug":"/api-reference/management/mappings/mappings_apply","metadata":{"seo":{"title":"Apply Mappings","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mappings_apply","name":"Apply Mappings","isWebhook":false,"pointer":"/paths/~1v1~1mappings~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply Mappings","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Apply a list of mapping transforms against the JSON input."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"mappings_apply"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_raw_data","in":"query","schemaId":"schema_3","description":"Include the raw data from the input in the response"}],"pointer":"/paths/~1v1~1mappings~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyMappingRequestBody"}},"schemaId":"components/schemas/ApplyMappingRequestBody","pointer":"/paths/~1v1~1mappings~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/mappings/apply","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"include_raw_data","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyMappingRequestBody"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/mappings/apply","href":"mappings/mappings_apply","openApiOperationId":"mappings_apply","summary":"Apply Mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/ApplyMappingRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyMappingRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyMappingResponse"}},"schemaId":"components/schemas/ApplyMappingResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1mappings~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyMappingResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mappings/mappings_apply"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings/apply"}],"content":{"contentType":"group","meta":{"name":"Mappings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mappings (In Development)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This feature is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this feature."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/mappings","summary":"List Mappings","prefix":{"name":"get","color":"get"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_list","deprecated":false},{"title":"/v1/mappings","summary":"Create Mapping","prefix":{"name":"post","color":"post"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_create","deprecated":false},{"title":"/v1/mappings/{mappingId}","summary":"Get Mapping","prefix":{"name":"get","color":"get"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_get","deprecated":false},{"title":"/v1/mappings/{mappingId}","summary":"Update Mapping","prefix":{"name":"put","color":"put"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_update","deprecated":false},{"title":"/v1/mappings/{mappingId}","summary":"Patch Mapping","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_patch","deprecated":false},{"title":"/v1/mappings/{mappingId}","summary":"Delete Mapping","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_delete","deprecated":false},{"title":"/v1/mappings/apply","summary":"Apply Mappings","prefix":{"name":"post","color":"post"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/mappings/mappings_apply","deprecated":false}]}]}]}]}},{"type":"group","label":"Members","link":"/api-reference/management/members","routeSlug":"/api-reference/management/members","items":[{"label":"List Members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/members/members_list","routeSlug":"/api-reference/management/members/members_list","metadata":{"seo":{"title":"List Members","description":"List all members"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"members_list","name":"List Members","isWebhook":false,"pointer":"/paths/~1v1~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List all members"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"members_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Member"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Member"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/members","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/members","href":"members/members_list","openApiOperationId":"members_list","summary":"List Members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMembersResponse"}},"schemaId":"components/schemas/ListMembersResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1members/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMembersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMembersResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_list"}],"panels":[]}]},"httpPath":"/v1/members"},{"label":"Create Member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/members/members_create","routeSlug":"/api-reference/management/members/members_create","metadata":{"seo":{"title":"Create Member","description":"Add a new member for this Organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"members_create","name":"Create Member","isWebhook":false,"pointer":"/paths/~1v1~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a new member for this Organization."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"members_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMemberRequest"}},"schemaId":"components/schemas/CreateMemberRequest","pointer":"/paths/~1v1~1members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/members","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateMemberRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/members","href":"members/members_create","openApiOperationId":"members_create","summary":"Create Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateMemberRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMemberRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMemberResponse"}},"schemaId":"components/schemas/CreateMemberResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1members/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateMemberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMemberResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_create"}],"panels":[]}]},"httpPath":"/v1/members"},{"label":"Get Member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/members/members_get","routeSlug":"/api-reference/management/members/members_get","metadata":{"seo":{"title":"Get Member","description":"Retrieve a Member by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"members_get","name":"Get Member","isWebhook":false,"pointer":"/paths/~1v1~1members~1{memberId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a Member by ID"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"members_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberId","in":"path","schemaId":"schema_32","required":true}],"pointer":"/paths/~1v1~1members~1{memberId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/members/{memberId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"memberId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/members/{memberId}","href":"members/members_get","openApiOperationId":"members_get","summary":"Get Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMemberResponse"}},"schemaId":"components/schemas/GetMemberResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1members~1{memberId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMemberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMemberResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_get"}],"panels":[]}]},"httpPath":"/v1/members/{memberId}"},{"label":"Update Member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/members/members_update","routeSlug":"/api-reference/management/members/members_update","metadata":{"seo":{"title":"Update Member","description":"Update a Member by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"members_update","name":"Update Member","isWebhook":false,"pointer":"/paths/~1v1~1members~1{memberId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update a Member by ID"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"members_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberId","in":"path","schemaId":"schema_32","required":true}],"pointer":"/paths/~1v1~1members~1{memberId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34","pointer":"/paths/~1v1~1members~1{memberId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/members/{memberId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"memberId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_34"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/members/{memberId}","href":"members/members_update","openApiOperationId":"members_update","summary":"Update Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_34"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateMemberResponse"}},"schemaId":"components/schemas/UpdateMemberResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1members~1{memberId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateMemberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateMemberResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_update"}],"panels":[]}]},"httpPath":"/v1/members/{memberId}"},{"label":"Patch Member","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/members/members_patch","routeSlug":"/api-reference/management/members/members_patch","metadata":{"seo":{"title":"Patch Member","description":"Update a Member by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"members_patch","name":"Patch Member","isWebhook":false,"pointer":"/paths/~1v1~1members~1{memberId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update a Member by ID"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"members_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberId","in":"path","schemaId":"schema_32","required":true}],"pointer":"/paths/~1v1~1members~1{memberId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1members~1{memberId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/members/{memberId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"memberId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/members/{memberId}","href":"members/members_patch","openApiOperationId":"members_patch","summary":"Patch Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchMemberResponse"}},"schemaId":"components/schemas/PatchMemberResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1members~1{memberId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchMemberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchMemberResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_patch"}],"panels":[]}]},"httpPath":"/v1/members/{memberId}"},{"label":"Delete Member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/members/members_delete","routeSlug":"/api-reference/management/members/members_delete","metadata":{"seo":{"title":"Delete Member","description":"Delete a Member by ID. Also deletes all Tokens for the Member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"members_delete","name":"Delete Member","isWebhook":false,"pointer":"/paths/~1v1~1members~1{memberId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delete a Member by ID. Also deletes all Tokens for the Member."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"members_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberId","in":"path","schemaId":"schema_32","required":true}],"pointer":"/paths/~1v1~1members~1{memberId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/members/{memberId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"memberId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/members/{memberId}","href":"members/members_delete","openApiOperationId":"members_delete","summary":"Delete Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1members~1{memberId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_delete"}],"panels":[]}]},"httpPath":"/v1/members/{memberId}"}],"content":{"contentType":"group","meta":{"name":"Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Members","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/members","summary":"List Members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/members_list","deprecated":false},{"title":"/v1/members","summary":"Create Member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/members_create","deprecated":false},{"title":"/v1/members/{memberId}","summary":"Get Member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/members_get","deprecated":false},{"title":"/v1/members/{memberId}","summary":"Update Member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/members_update","deprecated":false},{"title":"/v1/members/{memberId}","summary":"Patch Member","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/members/members_patch","deprecated":false},{"title":"/v1/members/{memberId}","summary":"Delete Member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/members/members_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Meta","link":"/api-reference/management/meta","routeSlug":"/api-reference/management/meta","items":[{"label":"Get Management OpenAPI Spec","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/meta/meta_managementopenapispec","routeSlug":"/api-reference/management/meta/meta_managementopenapispec","metadata":{"seo":{"title":"Get Management OpenAPI Spec","description":"Retrieve the OpenAPI spec for the Management API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"meta_managementOpenapiSpec","name":"Get Management OpenAPI Spec","isWebhook":false,"pointer":"/paths/~1v1~1meta~1openapi~1management/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Management OpenAPI Spec","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve the OpenAPI spec for the Management API"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"meta_managementOpenapiSpec"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/meta/openapi/management","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","402","403","405","409","415","429","500"],"pointer":"/v1/meta/openapi/management","href":"meta/meta_managementopenapispec","openApiOperationId":"meta_managementOpenapiSpec","summary":"Get Management OpenAPI Spec"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOpenApiSpecResponse"}},"schemaId":"components/schemas/GetOpenApiSpecResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1meta~1openapi~1management/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOpenApiSpecResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOpenApiSpecResponse"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meta/meta_managementopenapispec"}],"panels":[]}]},"httpPath":"/v1/meta/openapi/management"},{"label":"Get Engine OpenAPI Spec","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/meta/meta_engineopenapispec","routeSlug":"/api-reference/management/meta/meta_engineopenapispec","metadata":{"seo":{"title":"Get Engine OpenAPI Spec","description":"Retrieve the OpenAPI spec for the Engine APIs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"meta_engineOpenapiSpec","name":"Get Engine OpenAPI Spec","isWebhook":false,"pointer":"/paths/~1v1~1meta~1openapi~1engine/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Engine OpenAPI Spec","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve the OpenAPI spec for the Engine APIs"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"meta_engineOpenapiSpec"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/meta/openapi/engine","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","402","403","405","409","415","429","500"],"pointer":"/v1/meta/openapi/engine","href":"meta/meta_engineopenapispec","openApiOperationId":"meta_engineOpenapiSpec","summary":"Get Engine OpenAPI Spec"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOpenApiSpecResponse"}},"schemaId":"components/schemas/GetOpenApiSpecResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1meta~1openapi~1engine/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOpenApiSpecResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOpenApiSpecResponse"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meta/meta_engineopenapispec"}],"panels":[]}]},"httpPath":"/v1/meta/openapi/engine"}],"content":{"contentType":"group","meta":{"name":"Meta"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Meta","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/meta/openapi/management","summary":"Get Management OpenAPI Spec","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meta/meta_managementopenapispec","deprecated":false},{"title":"/v1/meta/openapi/engine","summary":"Get Engine OpenAPI Spec","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meta/meta_engineopenapispec","deprecated":false}]}]}]}]}},{"type":"group","label":"Oauth Apps","link":"/api-reference/management/oauthapps","routeSlug":"/api-reference/management/oauthapps","items":[{"label":"List OAuth App Installs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/oauthapps/oauthapps_list_installs","routeSlug":"/api-reference/management/oauthapps/oauthapps_list_installs","metadata":{"seo":{"title":"List OAuth App Installs","description":"Returns the OAuth apps installed in vendor instances for the Accountmatching {accountId}, each with the integrations that run on it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"oauthApps_list_installs","name":"List OAuth App Installs","isWebhook":false,"pointer":"/paths/~1v1~1oauth-apps~1installs~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List OAuth App Installs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the OAuth apps installed in vendor instances for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{accountId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", each with the integrations that run on it."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"oauthApps_list_installs"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v1~1oauth-apps~1installs~1{accountId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"app_id","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Only installs of the app with this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"vendor_instance_id","in":"query","schemaId":"schema_1","description":"Only installs in this vendor instance."}],"pointer":"/paths/~1v1~1oauth-apps~1installs~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/oauth-apps/installs/{accountId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"app_id","in":"query","required":false,"schemaId":"components/schemas/OAuthAppId"},{"name":"vendor_instance_id","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/oauth-apps/installs/{accountId}","href":"oauthapps/oauthapps_list_installs","openApiOperationId":"oauthApps_list_installs","summary":"List OAuth App Installs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOAuthAppInstallsResponse"}},"schemaId":"components/schemas/ListOAuthAppInstallsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1oauth-apps~1installs~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOAuthAppInstallsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOAuthAppInstallsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauthapps/oauthapps_list_installs"}],"panels":[]}]},"httpPath":"/v1/oauth-apps/installs/{accountId}"}],"content":{"contentType":"group","meta":{"name":"OauthApps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Oauth Apps","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/oauth-apps/installs/{accountId}","summary":"List OAuth App Installs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/oauthapps/oauthapps_list_installs","deprecated":false}]}]}]}]}},{"type":"group","label":"Operations (In Development)","link":"/api-reference/management/operations","routeSlug":"/api-reference/management/operations","items":[{"label":"List Asynchronous Operations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/operations/operations_list","routeSlug":"/api-reference/management/operations/operations_list","metadata":{"seo":{"title":"List Asynchronous Operations","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"operations_list","name":"List Asynchronous Operations","isWebhook":false,"pointer":"/paths/~1v1~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Asynchronous Operations","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Asynchronous Operations"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"operations_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Asynchronous Operations"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Asynchronous Operations"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field id. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/jobs","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/jobs","href":"operations/operations_list","openApiOperationId":"operations_list","summary":"List Asynchronous Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOperationsResponse"}},"schemaId":"components/schemas/ListOperationsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOperationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOperationsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/operations_list"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/jobs"},{"label":"List Operation Execution History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/operations/operations_list_execution_history","routeSlug":"/api-reference/management/operations/operations_list_execution_history","metadata":{"seo":{"title":"List Operation Execution History","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"operations_list_execution_history","name":"List Operation Execution History","isWebhook":false,"pointer":"/paths/~1v1~1jobs~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Operation Execution History","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the execution history for all operations."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"History is stored for the configured retention period (default 4 weeks)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"operations_list_execution_history"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter operation execution history by this query."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Available filters:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"id[eq]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter by specific operation ID"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_id[eq]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter by specific integration ID"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"account_id[eq]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter by specific account ID"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"execution_id[eq]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter by specific execution ID"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at[gte]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter executions started at or after a specific datetime (RFC3339 format)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at[lte]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter executions started at or before a specific datetime (RFC3339 format)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at[gt]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter executions started after a specific datetime"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at[lt]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter executions started before a specific datetime"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"operation_id[eq]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Filter by operation name (e.g., \"assets_query_devices\")"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field id. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"started_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in ascending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"desc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"limit","in":"query","schemaId":"schema_0","description":"Number of results to return (default 100, max 500)"},{"name":"start_after","in":"query","schemaId":"schema_1","description":"Return execution history starting after this cursor."}],"pointer":"/paths/~1v1~1jobs~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/jobs/history","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/v1/jobs/history","href":"operations/operations_list_execution_history","openApiOperationId":"operations_list_execution_history","summary":"List Operation Execution History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExecutionHistoryResponse"}},"schemaId":"components/schemas/ListExecutionHistoryResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1jobs~1history/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExecutionHistoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExecutionHistoryResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/operations_list_execution_history"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/jobs/history"}],"content":{"contentType":"group","meta":{"name":"Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operations (In Development)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This feature is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this feature."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/jobs","summary":"List Asynchronous Operations","prefix":{"name":"get","color":"get"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/operations/operations_list","deprecated":false},{"title":"/v1/jobs/history","summary":"List Operation Execution History","prefix":{"name":"get","color":"get"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/operations/operations_list_execution_history","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Webhooks","link":"/api-reference/management/organizationwebhooks","routeSlug":"/api-reference/management/organizationwebhooks","items":[{"label":"List Organization Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organizationwebhooks/organizationwebhooks_list","routeSlug":"/api-reference/management/organizationwebhooks/organizationwebhooks_list","metadata":{"seo":{"title":"List Organization Webhooks","description":"List webhooks for the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizationWebhooks_list","name":"List Organization Webhooks","isWebhook":false,"pointer":"/paths/~1v1~1organization~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Organization Webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List webhooks for the organization"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationWebhooks_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1organization~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organization/webhooks","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization/webhooks","href":"organizationwebhooks/organizationwebhooks_list","openApiOperationId":"organizationWebhooks_list","summary":"List Organization Webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrganizationWebhooksResponse"}},"schemaId":"components/schemas/ListOrganizationWebhooksResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrganizationWebhooksResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrganizationWebhooksResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizationwebhooks/organizationwebhooks_list"}],"panels":[]}]},"httpPath":"/v1/organization/webhooks"},{"label":"Create Organization Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organizationwebhooks/organizationwebhooks_create","routeSlug":"/api-reference/management/organizationwebhooks/organizationwebhooks_create","metadata":{"seo":{"title":"Create Organization Webhook","description":"Create a new webhook for the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizationWebhooks_create","name":"Create Organization Webhook","isWebhook":false,"pointer":"/paths/~1v1~1organization~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Organization Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a new webhook for the organization"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationWebhooks_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookRequest"}},"schemaId":"components/schemas/CreateOrganizationWebhookRequest","pointer":"/paths/~1v1~1organization~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organization/webhooks","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization/webhooks","href":"organizationwebhooks/organizationwebhooks_create","openApiOperationId":"organizationWebhooks_create","summary":"Create Organization Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateOrganizationWebhookRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookResponse"}},"schemaId":"components/schemas/CreateOrganizationWebhookResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOrganizationWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizationwebhooks/organizationwebhooks_create"}],"panels":[]}]},"httpPath":"/v1/organization/webhooks"},{"label":"Get Organization Webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organizationwebhooks/organizationwebhooks_get","routeSlug":"/api-reference/management/organizationwebhooks/organizationwebhooks_get","metadata":{"seo":{"title":"Get Organization Webhook","description":"Returns the Webhook object matching {webhookId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizationWebhooks_get","name":"Get Organization Webhook","isWebhook":false,"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Organization Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{webhookId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationWebhooks_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_36","required":true}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organization/webhooks/{webhookId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_37"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization/webhooks/{webhookId}","href":"organizationwebhooks/organizationwebhooks_get","openApiOperationId":"organizationWebhooks_get","summary":"Get Organization Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationWebhookResponse"}},"schemaId":"components/schemas/GetOrganizationWebhookResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrganizationWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizationwebhooks/organizationwebhooks_get"}],"panels":[]}]},"httpPath":"/v1/organization/webhooks/{webhookId}"},{"label":"Update Organization Webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organizationwebhooks/organizationwebhooks_update","routeSlug":"/api-reference/management/organizationwebhooks/organizationwebhooks_update","metadata":{"seo":{"title":"Update Organization Webhook","description":"Updates the Webhook object matching {webhookId}. For more information onOrganizations and Webhooks, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizationWebhooks_update","name":"Update Organization Webhook","isWebhook":false,"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Organization Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{webhookId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organizations and Webhooks, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationWebhooks_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_36","required":true}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38","pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organization/webhooks/{webhookId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_37"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_38"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization/webhooks/{webhookId}","href":"organizationwebhooks/organizationwebhooks_update","openApiOperationId":"organizationWebhooks_update","summary":"Update Organization Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_38"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationWebhookResponse"}},"schemaId":"components/schemas/UpdateOrganizationWebhookResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateOrganizationWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizationwebhooks/organizationwebhooks_update"}],"panels":[]}]},"httpPath":"/v1/organization/webhooks/{webhookId}"},{"label":"Patch Organization Webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organizationwebhooks/organizationwebhooks_patch","routeSlug":"/api-reference/management/organizationwebhooks/organizationwebhooks_patch","metadata":{"seo":{"title":"Patch Organization Webhook","description":"Patches the Webhook object matching {webhookId}. For more information onOrganizations and Webhooks, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizationWebhooks_patch","name":"Patch Organization Webhook","isWebhook":false,"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Organization Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhook"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{webhookId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organizations and Webhooks, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationWebhooks_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_36","required":true}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/organization/webhooks/{webhookId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_37"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization/webhooks/{webhookId}","href":"organizationwebhooks/organizationwebhooks_patch","openApiOperationId":"organizationWebhooks_patch","summary":"Patch Organization Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchOrganizationWebhookResponse"}},"schemaId":"components/schemas/PatchOrganizationWebhookResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchOrganizationWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchOrganizationWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizationwebhooks/organizationwebhooks_patch"}],"panels":[]}]},"httpPath":"/v1/organization/webhooks/{webhookId}"},{"label":"Delete Organization Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organizationwebhooks/organizationwebhooks_delete","routeSlug":"/api-reference/management/organizationwebhooks/organizationwebhooks_delete","metadata":{"seo":{"title":"Delete Organization Webhook","description":"Delete a webhook for the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizationWebhooks_delete","name":"Delete Organization Webhook","isWebhook":false,"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Organization Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delete a webhook for the organization"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationWebhooks_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_36","required":true}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organization/webhooks/{webhookId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_37"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization/webhooks/{webhookId}","href":"organizationwebhooks/organizationwebhooks_delete","openApiOperationId":"organizationWebhooks_delete","summary":"Delete Organization Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizationwebhooks/organizationwebhooks_delete"}],"panels":[]}]},"httpPath":"/v1/organization/webhooks/{webhookId}"}],"content":{"contentType":"group","meta":{"name":"OrganizationWebhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organization/webhooks","summary":"List Organization Webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizationwebhooks/organizationwebhooks_list","deprecated":false},{"title":"/v1/organization/webhooks","summary":"Create Organization Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizationwebhooks/organizationwebhooks_create","deprecated":false},{"title":"/v1/organization/webhooks/{webhookId}","summary":"Get Organization Webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizationwebhooks/organizationwebhooks_get","deprecated":false},{"title":"/v1/organization/webhooks/{webhookId}","summary":"Update Organization Webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organizationwebhooks/organizationwebhooks_update","deprecated":false},{"title":"/v1/organization/webhooks/{webhookId}","summary":"Patch Organization Webhook","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organizationwebhooks/organizationwebhooks_patch","deprecated":false},{"title":"/v1/organization/webhooks/{webhookId}","summary":"Delete Organization Webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organizationwebhooks/organizationwebhooks_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization","link":"/api-reference/management/organization","routeSlug":"/api-reference/management/organization","items":[{"label":"Get Organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organization/organization_get","routeSlug":"/api-reference/management/organization/organization_get","metadata":{"seo":{"title":"Get Organization","description":"Retrieve Organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organization_get","name":"Get Organization","isWebhook":false,"pointer":"/paths/~1v1~1organization/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve Organization"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organization_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organization","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization","href":"organization/organization_get","openApiOperationId":"organization_get","summary":"Get Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationResponse"}},"schemaId":"components/schemas/GetOrganizationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrganizationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization/organization_get"}],"panels":[]}]},"httpPath":"/v1/organization"},{"label":"Update Organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organization/organization_update","routeSlug":"/api-reference/management/organization/organization_update","metadata":{"seo":{"title":"Update Organization","description":"Update Organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organization_update","name":"Update Organization","isWebhook":false,"pointer":"/paths/~1v1~1organization/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update Organization"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organization_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39","pointer":"/paths/~1v1~1organization/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organization","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_39"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization","href":"organization/organization_update","openApiOperationId":"organization_update","summary":"Update Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationResponse"}},"schemaId":"components/schemas/UpdateOrganizationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateOrganizationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization/organization_update"}],"panels":[]}]},"httpPath":"/v1/organization"},{"label":"Patch Organization","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/organization/organization_patch","routeSlug":"/api-reference/management/organization/organization_patch","metadata":{"seo":{"title":"Patch Organization","description":"Patch Organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organization_patch","name":"Patch Organization","isWebhook":false,"pointer":"/paths/~1v1~1organization/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patch Organization"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organization_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1organization/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/organization","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/organization","href":"organization/organization_patch","openApiOperationId":"organization_patch","summary":"Patch Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchOrganizationResponse"}},"schemaId":"components/schemas/PatchOrganizationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1organization/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchOrganizationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchOrganizationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization/organization_patch"}],"panels":[]}]},"httpPath":"/v1/organization"}],"content":{"contentType":"group","meta":{"name":"Organization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organization","summary":"Get Organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization/organization_get","deprecated":false},{"title":"/v1/organization","summary":"Update Organization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization/organization_update","deprecated":false},{"title":"/v1/organization","summary":"Patch Organization","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization/organization_patch","deprecated":false}]}]}]}]}},{"type":"group","label":"Permissionset","link":"/api-reference/management/permissionset","routeSlug":"/api-reference/management/permissionset","items":[{"label":"List PermissionSets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/permissionset/permissionset_list","routeSlug":"/api-reference/management/permissionset/permissionset_list","metadata":{"seo":{"title":"List PermissionSets","description":"Returns a list of all PermissionSets objects that match the query params."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"permissionset_list","name":"List PermissionSets","isWebhook":false,"pointer":"/paths/~1v1~1permissionsets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List PermissionSets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PermissionSets"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects that match the query params."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"permissionset_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/permissionsets","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/permissionsets","href":"permissionset/permissionset_list","openApiOperationId":"permissionset_list","summary":"List PermissionSets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPermissionSetsResponse"}},"schemaId":"components/schemas/ListPermissionSetsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1permissionsets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPermissionSetsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPermissionSetsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissionset/permissionset_list"}],"panels":[]}]},"httpPath":"/v1/permissionsets"},{"label":"Get PermissionSet","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/permissionset/permissionset_get","routeSlug":"/api-reference/management/permissionset/permissionset_get","metadata":{"seo":{"title":"Get PermissionSet","description":"Returns the PermissionSet object matching {permissionsetId}. For more information on PermissionSets, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"permissionset_get","name":"Get PermissionSet","isWebhook":false,"pointer":"/paths/~1v1~1permissionsets~1{permissionsetId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get PermissionSet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PermissionSet"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{permissionsetId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on PermissionSets, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"permissionset_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"permissionsetId","in":"path","schemaId":"schema_40","required":true}],"pointer":"/paths/~1v1~1permissionsets~1{permissionsetId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/permissionsets/{permissionsetId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"permissionsetId","in":"path","required":true,"schemaId":"components/schemas/Permissions"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/permissionsets/{permissionsetId}","href":"permissionset/permissionset_get","openApiOperationId":"permissionset_get","summary":"Get PermissionSet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPermissionSetResponse"}},"schemaId":"components/schemas/GetPermissionSetResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1permissionsets~1{permissionsetId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPermissionSetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPermissionSetResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissionset/permissionset_get"}],"panels":[]}]},"httpPath":"/v1/permissionsets/{permissionsetId}"}],"content":{"contentType":"group","meta":{"name":"Permissionset"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permissionset","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/permissionsets","summary":"List PermissionSets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/permissionset/permissionset_list","deprecated":false},{"title":"/v1/permissionsets/{permissionsetId}","summary":"Get PermissionSet","prefix":{"name":"get","color":"get"},"badges":[],"link":"/permissionset/permissionset_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/api-reference/management/roles","routeSlug":"/api-reference/management/roles","items":[{"label":"List Roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/roles/roles_list","routeSlug":"/api-reference/management/roles/roles_list","metadata":{"seo":{"title":"List Roles","description":"Returns a list of all Roles objects that match the query params."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roles_list","name":"List Roles","isWebhook":false,"pointer":"/paths/~1v1~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Roles"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects that match the query params."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"roles_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/roles","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/roles","href":"roles/roles_list","openApiOperationId":"roles_list","summary":"List Roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRolesResponse"}},"schemaId":"components/schemas/ListRolesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRolesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRolesResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/roles_list"}],"panels":[]}]},"httpPath":"/v1/roles"},{"label":"Create Role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/roles/roles_create","routeSlug":"/api-reference/management/roles/roles_create","metadata":{"seo":{"title":"Create Role","description":"Creates an Role object. For more information on Roles, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roles_create","name":"Create Role","isWebhook":false,"pointer":"/paths/~1v1~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object. For more information on Roles, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"roles_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRoleRequest"}},"schemaId":"components/schemas/CreateRoleRequest","pointer":"/paths/~1v1~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/roles","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRoleRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/roles","href":"roles/roles_create","openApiOperationId":"roles_create","summary":"Create Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateRoleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRoleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRoleResponse"}},"schemaId":"components/schemas/CreateRoleResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRoleResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/roles_create"}],"panels":[]}]},"httpPath":"/v1/roles"},{"label":"Get Role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/roles/roles_get","routeSlug":"/api-reference/management/roles/roles_get","metadata":{"seo":{"title":"Get Role","description":"Returns the Role object matching {roleId}. For more information on Roles, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roles_get","name":"Get Role","isWebhook":false,"pointer":"/paths/~1v1~1roles~1{roleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{roleId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on Roles, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"roles_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_41","required":true}],"pointer":"/paths/~1v1~1roles~1{roleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/roles/{roleId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/roles/{roleId}","href":"roles/roles_get","openApiOperationId":"roles_get","summary":"Get Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoleResponse"}},"schemaId":"components/schemas/GetRoleResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1roles~1{roleId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoleResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/roles_get"}],"panels":[]}]},"httpPath":"/v1/roles/{roleId}"},{"label":"Update Role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/roles/roles_update","routeSlug":"/api-reference/management/roles/roles_update","metadata":{"seo":{"title":"Update Role","description":"Updates the Role object matching {roleId}. For more information on Roles, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roles_update","name":"Update Role","isWebhook":false,"pointer":"/paths/~1v1~1roles~1{roleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{roleId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on Roles, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"roles_update"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_41","required":true}],"pointer":"/paths/~1v1~1roles~1{roleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43","pointer":"/paths/~1v1~1roles~1{roleId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/roles/{roleId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/roles/{roleId}","href":"roles/roles_update","openApiOperationId":"roles_update","summary":"Update Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateRoleResponse"}},"schemaId":"components/schemas/UpdateRoleResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1roles~1{roleId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateRoleResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/roles_update"}],"panels":[]}]},"httpPath":"/v1/roles/{roleId}"},{"label":"Patch Role","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/roles/roles_patch","routeSlug":"/api-reference/management/roles/roles_patch","metadata":{"seo":{"title":"Patch Role","description":"Patches the Role object matching {roleId}. For more information on Roles, refer to ourSynqly Overview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roles_patch","name":"Patch Role","isWebhook":false,"pointer":"/paths/~1v1~1roles~1{roleId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Patches the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{roleId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on Roles, refer to our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/docs/synqly-overview"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Overview"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"roles_patch"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_41","required":true}],"pointer":"/paths/~1v1~1roles~1{roleId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v1~1roles~1{roleId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/roles/{roleId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/roles/{roleId}","href":"roles/roles_patch","openApiOperationId":"roles_patch","summary":"Patch Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchRoleResponse"}},"schemaId":"components/schemas/PatchRoleResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1roles~1{roleId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchRoleResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/roles_patch"}],"panels":[]}]},"httpPath":"/v1/roles/{roleId}"},{"label":"Delete Role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/roles/roles_delete","routeSlug":"/api-reference/management/roles/roles_delete","metadata":{"seo":{"title":"Delete Role","description":"Deletes the Role matching {roleId}. Deleting an Role also deleteaall Tokens and Credentials belonging to the Role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roles_delete","name":"Delete Role","isWebhook":false,"pointer":"/paths/~1v1~1roles~1{roleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{roleId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Deleting an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" also deletea"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Credentials"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" belonging to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"roles_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_41","required":true}],"pointer":"/paths/~1v1~1roles~1{roleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/roles/{roleId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/roles/{roleId}","href":"roles/roles_delete","openApiOperationId":"roles_delete","summary":"Delete Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1roles~1{roleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/roles_delete"}],"panels":[]}]},"httpPath":"/v1/roles/{roleId}"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/roles","summary":"List Roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/roles_list","deprecated":false},{"title":"/v1/roles","summary":"Create Role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/roles_create","deprecated":false},{"title":"/v1/roles/{roleId}","summary":"Get Role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/roles_get","deprecated":false},{"title":"/v1/roles/{roleId}","summary":"Update Role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/roles/roles_update","deprecated":false},{"title":"/v1/roles/{roleId}","summary":"Patch Role","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/roles/roles_patch","deprecated":false},{"title":"/v1/roles/{roleId}","summary":"Delete Role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/roles/roles_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Status","link":"/api-reference/management/status","routeSlug":"/api-reference/management/status","items":[{"label":"List Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/status/status_list","routeSlug":"/api-reference/management/status/status_list","metadata":{"seo":{"title":"List Status","description":"Returns all matching Status objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_list","name":"List Status","isWebhook":false,"pointer":"/paths/~1v1~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns all matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account_id,integration_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account_id,integration_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"expand","in":"query","schemaId":"schema_44","description":"Expand the status result with the related integration and/or account information."}],"pointer":"/paths/~1v1~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/status","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"},{"name":"expand","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/status","href":"status/status_list","openApiOperationId":"status_list","summary":"List Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatusResponse"}},"schemaId":"components/schemas/ListStatusResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatusResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status_list"}],"panels":[]}]},"httpPath":"/v1/status"},{"label":"Get Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/status/status_get","routeSlug":"/api-reference/management/status/status_get","metadata":{"seo":{"title":"Get Status","description":"Returns the integration Status object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_get","name":"Get Status","isWebhook":false,"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the integration "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/status/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/status/{accountId}/{integrationId}","href":"status/status_get","openApiOperationId":"status_get","summary":"Get Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetStatusResponse"}},"schemaId":"components/schemas/GetStatusResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetStatusResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status_get"}],"panels":[]}]},"httpPath":"/v1/status/{accountId}/{integrationId}"},{"label":"Reset Status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/status/status_reset","routeSlug":"/api-reference/management/status/status_reset","metadata":{"seo":{"title":"Reset Status","description":"Resets the integration Status object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_reset","name":"Reset Status","isWebhook":false,"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Resets the integration "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status_reset"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/status/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/status/{accountId}/{integrationId}","href":"status/status_reset","openApiOperationId":"status_reset","summary":"Reset Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status_reset"}],"panels":[]}]},"httpPath":"/v1/status/{accountId}/{integrationId}"},{"label":"List Status Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/status/status_list_events","routeSlug":"/api-reference/management/status/status_list_events","metadata":{"seo":{"title":"List Status Events","description":"Returns integration Status object list of StatusEvent objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_list_events","name":"List Status Events","isWebhook":false,"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Status Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns integration "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object list of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"StatusEvent"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status_list_events"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"StatusEvent"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"StatusEvent"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"created_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The order defaults to created_at[asc] and can changed to descending order by specifying created_at[desc]."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/status/{accountId}/{integrationId}/events","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_1"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/status/{accountId}/{integrationId}/events","href":"status/status_list_events","openApiOperationId":"status_list_events","summary":"List Status Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatusEventsResponse"}},"schemaId":"components/schemas/ListStatusEventsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStatusEventsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatusEventsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status_list_events"}],"panels":[]}]},"httpPath":"/v1/status/{accountId}/{integrationId}/events"},{"label":"Get Status Timeseries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/status/status_get_timeseries","routeSlug":"/api-reference/management/status/status_get_timeseries","metadata":{"seo":{"title":"Get Status Timeseries","description":"Returns organization last hour usage timeseries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_get_timeseries","name":"Get Status Timeseries","isWebhook":false,"pointer":"/paths/~1v1~1status~1timeseries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Status Timeseries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns organization last hour usage timeseries."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status_get_timeseries"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/status/timeseries","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/status/timeseries","href":"status/status_get_timeseries","openApiOperationId":"status_get_timeseries","summary":"Get Status Timeseries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetStatusTimeseries"}},"schemaId":"components/schemas/GetStatusTimeseries"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1status~1timeseries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetStatusTimeseries","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetStatusTimeseries"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status_get_timeseries"}],"panels":[]}]},"httpPath":"/v1/status/timeseries"},{"label":"Get Integration Timeseries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/status/status_get_integration_timeseries","routeSlug":"/api-reference/management/status/status_get_integration_timeseries","metadata":{"seo":{"title":"Get Integration Timeseries","description":"Returns organization last hour usage timeseries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_get_integration_timeseries","name":"Get Integration Timeseries","isWebhook":false,"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1timeseries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Integration Timeseries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns organization last hour usage timeseries."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status_get_integration_timeseries"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1timeseries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"interval","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"[hour] provide most recent 24 hour timeseries. default: hour"},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1timeseries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/status/{accountId}/{integrationId}/timeseries","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[{"name":"interval","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/status/{accountId}/{integrationId}/timeseries","href":"status/status_get_integration_timeseries","openApiOperationId":"status_get_integration_timeseries","summary":"Get Integration Timeseries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIntegrationTimeseries"}},"schemaId":"components/schemas/GetIntegrationTimeseries"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1status~1{accountId}~1{integrationId}~1timeseries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetIntegrationTimeseries","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIntegrationTimeseries"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status_get_integration_timeseries"}],"panels":[]}]},"httpPath":"/v1/status/{accountId}/{integrationId}/timeseries"}],"content":{"contentType":"group","meta":{"name":"Status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Status","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/status","summary":"List Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/status_list","deprecated":false},{"title":"/v1/status/{accountId}/{integrationId}","summary":"Get Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/status_get","deprecated":false},{"title":"/v1/status/{accountId}/{integrationId}","summary":"Reset Status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/status/status_reset","deprecated":false},{"title":"/v1/status/{accountId}/{integrationId}/events","summary":"List Status Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/status_list_events","deprecated":false},{"title":"/v1/status/timeseries","summary":"Get Status Timeseries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/status_get_timeseries","deprecated":false},{"title":"/v1/status/{accountId}/{integrationId}/timeseries","summary":"Get Integration Timeseries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/status_get_integration_timeseries","deprecated":false}]}]}]}]}},{"type":"group","label":"Sub Orgs","link":"/api-reference/management/suborgs","routeSlug":"/api-reference/management/suborgs","items":[{"label":"List Sub-Organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/suborgs/suborgs_list","routeSlug":"/api-reference/management/suborgs/suborgs_list","metadata":{"seo":{"title":"List Sub-Organizations","description":"List all organizations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subOrgs_list","name":"List Sub-Organizations","isWebhook":false,"pointer":"/paths/~1v1~1suborgs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Sub-Organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List all organizations"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"subOrgs_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/suborgs","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/suborgs","href":"suborgs/suborgs_list","openApiOperationId":"subOrgs_list","summary":"List Sub-Organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrganizationResponse"}},"schemaId":"components/schemas/ListOrganizationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1suborgs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrganizationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrganizationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suborgs/suborgs_list"}],"panels":[]}]},"httpPath":"/v1/suborgs"},{"label":"Create Sub-Organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/suborgs/suborgs_create","routeSlug":"/api-reference/management/suborgs/suborgs_create","metadata":{"seo":{"title":"Create Sub-Organization","description":"Add a new organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subOrgs_create","name":"Create Sub-Organization","isWebhook":false,"pointer":"/paths/~1v1~1suborgs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Sub-Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a new organization."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"subOrgs_create"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrganizationRequest"}},"schemaId":"components/schemas/CreateOrganizationRequest","pointer":"/paths/~1v1~1suborgs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/suborgs","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrganizationRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/suborgs","href":"suborgs/suborgs_create","openApiOperationId":"subOrgs_create","summary":"Create Sub-Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateOrganizationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrganizationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrganizationResponse"}},"schemaId":"components/schemas/CreateOrganizationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1suborgs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOrganizationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrganizationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suborgs/suborgs_create"}],"panels":[]}]},"httpPath":"/v1/suborgs"},{"label":"Get Sub-Organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/suborgs/suborgs_get","routeSlug":"/api-reference/management/suborgs/suborgs_get","metadata":{"seo":{"title":"Get Sub-Organization","description":"Retrieve an Organization by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subOrgs_get","name":"Get Sub-Organization","isWebhook":false,"pointer":"/paths/~1v1~1suborgs~1{organizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Sub-Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve an Organization by ID"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"subOrgs_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1v1~1suborgs~1{organizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/suborgs/{organizationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/suborgs/{organizationId}","href":"suborgs/suborgs_get","openApiOperationId":"subOrgs_get","summary":"Get Sub-Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationResponse"}},"schemaId":"components/schemas/GetOrganizationResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1suborgs~1{organizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrganizationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suborgs/suborgs_get"}],"panels":[]}]},"httpPath":"/v1/suborgs/{organizationId}"},{"label":"Delete Sub-Organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/suborgs/suborgs_delete","routeSlug":"/api-reference/management/suborgs/suborgs_delete","metadata":{"seo":{"title":"Delete Sub-Organization","description":"Delete a Organization by ID. Also deletes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subOrgs_delete","name":"Delete Sub-Organization","isWebhook":false,"pointer":"/paths/~1v1~1suborgs~1{organizationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Sub-Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delete a Organization by ID. Also deletes"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"subOrgs_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1v1~1suborgs~1{organizationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/suborgs/{organizationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/suborgs/{organizationId}","href":"suborgs/suborgs_delete","openApiOperationId":"subOrgs_delete","summary":"Delete Sub-Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1suborgs~1{organizationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suborgs/suborgs_delete"}],"panels":[]}]},"httpPath":"/v1/suborgs/{organizationId}"}],"content":{"contentType":"group","meta":{"name":"SubOrgs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sub Orgs","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/suborgs","summary":"List Sub-Organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/suborgs/suborgs_list","deprecated":false},{"title":"/v1/suborgs","summary":"Create Sub-Organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/suborgs/suborgs_create","deprecated":false},{"title":"/v1/suborgs/{organizationId}","summary":"Get Sub-Organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/suborgs/suborgs_get","deprecated":false},{"title":"/v1/suborgs/{organizationId}","summary":"Delete Sub-Organization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/suborgs/suborgs_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Tokens","link":"/api-reference/management/tokens","routeSlug":"/api-reference/management/tokens","items":[{"label":"Create Organization Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_create_token","routeSlug":"/api-reference/management/tokens/tokens_create_token","metadata":{"seo":{"title":"Create Organization Token","description":"Create an adhoc organization token restricted to specified resources and permission set.Tokens can only be reduced in scope, never expanded.Permissions are inherited from the token used to call this API.Permissions assigned to the new token will not be persisted, this is not a way to create roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_create_token","name":"Create Organization Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Organization Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create an adhoc organization token restricted to specified resources and permission set."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tokens can only be reduced in scope, never expanded."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Permissions are inherited from the token used to call this API."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Permissions assigned to the new token will not be persisted, this is not a way to create roles."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_create_token"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTokenRequest"}},"schemaId":"components/schemas/CreateTokenRequest","pointer":"/paths/~1v1~1tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tokens","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTokenRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens","href":"tokens/tokens_create_token","openApiOperationId":"tokens_create_token","summary":"Create Organization Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTokenResponse"}},"schemaId":"components/schemas/CreateTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_create_token"}],"panels":[]}]},"httpPath":"/v1/tokens"},{"label":"List Refresh Tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_list","routeSlug":"/api-reference/management/tokens/tokens_list","metadata":{"seo":{"title":"List Refresh Tokens","description":"Returns a list of all RefreshToken objects belonging to the Authorization Bearertoken. For more infromation on Tokens, refer toAuthentication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_list","name":"List Refresh Tokens","isWebhook":false,"pointer":"/paths/~1v1~1tokens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Refresh Tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns a list of all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects belonging to the Authorization Bearer"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token. For more infromation on Tokens, refer to"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/api-reference/authentication"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authentication"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_list"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects to return in this page. Defaults to 100."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"start_after","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" objects starting after this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"order","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select a field to order the results by. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To control the direction of the sorting, append"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[asc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to the field name. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name[desc]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will sort the results by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in descending order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The ordering defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"asc"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified. May be used multiple times to order by multiple fields, and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ordering is applied in the order the fields are specified."},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"filter","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter results by this query. For more information on filtering, refer to our "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/getting-started/management-api-filtering"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filtering Guide"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to no filter."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If used more than once, the queries are ANDed together."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/tokens","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"start_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"order","in":"query","required":false,"schemaId":"schema_2"},{"name":"filter","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens","href":"tokens/tokens_list","openApiOperationId":"tokens_list","summary":"List Refresh Tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTokensResponse"}},"schemaId":"components/schemas/ListTokensResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTokensResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTokensResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_list"}],"panels":[]}]},"httpPath":"/v1/tokens"},{"label":"Create MCP Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_create_mcp_token","routeSlug":"/api-reference/management/tokens/tokens_create_mcp_token","metadata":{"seo":{"title":"Create MCP Token","description":"Create a token for MCP authentication. This token is soley for MCP authentication and cannotauthenticate with any other API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_create_mcp_token","name":"Create MCP Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1mcp/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create MCP Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a token for MCP authentication. This token is soley for MCP authentication and cannot"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"authenticate with any other API."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_create_mcp_token"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMCPTokenRequest"}},"schemaId":"components/schemas/CreateMCPTokenRequest","pointer":"/paths/~1v1~1tokens~1mcp/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tokens/mcp","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateMCPTokenRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/mcp","href":"tokens/tokens_create_mcp_token","openApiOperationId":"tokens_create_mcp_token","summary":"Create MCP Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateMCPTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMCPTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMCPTokenResponse"}},"schemaId":"components/schemas/CreateMCPTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1mcp/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateMCPTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMCPTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_create_mcp_token"}],"panels":[]}]},"httpPath":"/v1/tokens/mcp"},{"label":"Create Integration Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_create_integration_token","routeSlug":"/api-reference/management/tokens/tokens_create_integration_token","metadata":{"seo":{"title":"Create Integration Token","description":"Create an adhoc integration token restricted to a single integration. The token used to callthis API must have the necessary permissions to create tokens and have access to the accountand integration IDs. Permissions may not be escalated, so any operation that the invocationtoken does not have access to cannot be granted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_create_integration_token","name":"Create Integration Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{accountId}~1{integrationId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Integration Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create an adhoc integration token restricted to a single integration. The token used to call"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this API must have the necessary permissions to create tokens and have access to the account"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and integration IDs. Permissions may not be escalated, so any operation that the invocation"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token does not have access to cannot be granted."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_create_integration_token"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_4","required":true},{"name":"integrationId","in":"path","schemaId":"schema_26","required":true}],"pointer":"/paths/~1v1~1tokens~1{accountId}~1{integrationId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateIntegrationTokenRequest"}},"schemaId":"components/schemas/CreateIntegrationTokenRequest","pointer":"/paths/~1v1~1tokens~1{accountId}~1{integrationId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tokens/{accountId}/{integrationId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_5"},{"name":"integrationId","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateIntegrationTokenRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{accountId}/{integrationId}","href":"tokens/tokens_create_integration_token","openApiOperationId":"tokens_create_integration_token","summary":"Create Integration Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateIntegrationTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateIntegrationTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateIntegrationTokenResponse"}},"schemaId":"components/schemas/CreateIntegrationTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{accountId}~1{integrationId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateIntegrationTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateIntegrationTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_create_integration_token"}],"panels":[]}]},"httpPath":"/v1/tokens/{accountId}/{integrationId}"},{"label":"Create Synqly Integrations Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_create_synqly_integrations_token","routeSlug":"/api-reference/management/tokens/tokens_create_synqly_integrations_token","metadata":{"seo":{"title":"Create Synqly Integrations Token","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_create_synqly_integrations_token","name":"Create Synqly Integrations Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1synqly-integrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Synqly Integrations Token","badges":[{"name":"Alpha","color":"in-development","position":"before"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"type":"warning","name":"In Development"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This operation is actively being developed. Breaking changes should be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expected."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please contact us before using this operation."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"tag","tag":"admonition"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a token for managing Synqly-specific integrations. This token can be used with the integration APIs to manage"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrations for Synqly-specific integrations, such as status events exports and async operations. See the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/synqly-integrations"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Integrations"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" documentation for more information."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_create_synqly_integrations_token"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenRequest"}},"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenRequest","pointer":"/paths/~1v1~1tokens~1synqly-integrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tokens/synqly-integrations","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenRequest"}},"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/synqly-integrations","href":"tokens/tokens_create_synqly_integrations_token","openApiOperationId":"tokens_create_synqly_integrations_token","summary":"Create Synqly Integrations Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenResponse"}},"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1synqly-integrations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateSynqlyIntegrationsTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSynqlyIntegrationsTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_create_synqly_integrations_token"}],"panels":[]}]},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/tokens/synqly-integrations"},{"label":"Delete Adhoc Refresh Token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_delete","routeSlug":"/api-reference/management/tokens/tokens_delete","metadata":{"seo":{"title":"Delete Adhoc Refresh Token","description":"Deletes the Refresh Token with id {id}. This immediatelyinvalidates both the primary and secondary token pairs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_delete","name":"Delete Adhoc Refresh Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Adhoc Refresh Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the Refresh Token with id "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". This immediately"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"invalidates both the primary and secondary token pairs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_delete"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refreshTokenId","in":"path","schemaId":"schema_45","required":true}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/tokens/{refreshTokenId}","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"refreshTokenId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{refreshTokenId}","href":"tokens/tokens_delete","openApiOperationId":"tokens_delete","summary":"Delete Adhoc Refresh Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_delete"}],"panels":[]}]},"httpPath":"/v1/tokens/{refreshTokenId}"},{"label":"Get Refresh Token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_get","routeSlug":"/api-reference/management/tokens/tokens_get","metadata":{"seo":{"title":"Get Refresh Token","description":"Returns the RefreshToken object matching {tokenId}. For more information onTokens, refer toAuthentication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_get","name":"Get Refresh Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Refresh Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{tokenId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". For more information on"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tokens, refer to"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/api-reference/authentication"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authentication"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_get"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refreshTokenId","in":"path","schemaId":"schema_45","required":true}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/tokens/{refreshTokenId}/info","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"refreshTokenId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{refreshTokenId}/info","href":"tokens/tokens_get","openApiOperationId":"tokens_get","summary":"Get Refresh Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTokenResponse"}},"schemaId":"components/schemas/GetTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_get"}],"panels":[]}]},"httpPath":"/v1/tokens/{refreshTokenId}/info"},{"label":"Reset Refresh Token","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_reset","routeSlug":"/api-reference/management/tokens/tokens_reset","metadata":{"seo":{"title":"Reset Refresh Token","description":"This API can be used to reset Organization or Integration RefreshTokens.Resets the specified RefreshToken and expiration time, removes the secondary, and resets access and refresh tokens for theRefreshToken object matching {ownerId}/{refreshTokenId} where ownerId is an organizationId or integrationId.An Organization token with administrator permissions can be used to perform this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_reset","name":"Reset Refresh Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{ownerId}~1{refreshTokenId}~1reset/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Refresh Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This API can be used to reset "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshTokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Resets the specified "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and expiration time, removes the secondary, and resets access and refresh tokens for the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}/{refreshTokenId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" where "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ownerId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"An "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" token with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"administrator"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" permissions can be used to perform this operation."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_reset"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true},{"name":"refreshTokenId","in":"path","schemaId":"schema_45","required":true}],"pointer":"/paths/~1v1~1tokens~1{ownerId}~1{refreshTokenId}~1reset/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/tokens/{ownerId}/{refreshTokenId}/reset","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"},{"name":"refreshTokenId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{ownerId}/{refreshTokenId}/reset","href":"tokens/tokens_reset","openApiOperationId":"tokens_reset","summary":"Reset Refresh Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResetTokenResponse"}},"schemaId":"components/schemas/ResetTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{ownerId}~1{refreshTokenId}~1reset/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResetTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResetTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_reset"}],"panels":[]}]},"httpPath":"/v1/tokens/{ownerId}/{refreshTokenId}/reset"},{"label":"Rotate Refresh Token","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_rotate","routeSlug":"/api-reference/management/tokens/tokens_rotate","metadata":{"seo":{"title":"Rotate Refresh Token","description":"This API can be used to rotate an Organization or Integration RefreshTokens.Rotate deletes the existing Secondary TokenPair, moves the Primary TokenPair to the Secondary TokenPair and creates a new Primary TokenPair for theRefreshToken object matching {ownerId}/{refreshTokenId} where ownerId is an organizationId or integrationId.An Organization token with administrator permissions can be used to perform this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_rotate","name":"Rotate Refresh Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{ownerId}~1{refreshTokenId}~1rotate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate Refresh Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This API can be used to rotate an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshTokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rotate deletes the existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Secondary"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" TokenPair, moves the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Primary"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" TokenPair to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Secondary"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" TokenPair and creates a new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Primary"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" TokenPair for the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ownerId}/{refreshTokenId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" where "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ownerId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizationId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrationId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"An "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" token with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"administrator"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" permissions can be used to perform this operation."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_rotate"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ownerId","in":"path","schemaId":"schema_19","required":true},{"name":"refreshTokenId","in":"path","schemaId":"schema_45","required":true}],"pointer":"/paths/~1v1~1tokens~1{ownerId}~1{refreshTokenId}~1rotate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/tokens/{ownerId}/{refreshTokenId}/rotate","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"ownerId","in":"path","required":true,"schemaId":"components/schemas/AccountId"},{"name":"refreshTokenId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{ownerId}/{refreshTokenId}/rotate","href":"tokens/tokens_rotate","openApiOperationId":"tokens_rotate","summary":"Rotate Refresh Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RotateTokenResponse"}},"schemaId":"components/schemas/RotateTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{ownerId}~1{refreshTokenId}~1rotate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RotateTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RotateTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_rotate"}],"panels":[]}]},"httpPath":"/v1/tokens/{ownerId}/{refreshTokenId}/rotate"},{"label":"Refresh Token Pair","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_refresh","routeSlug":"/api-reference/management/tokens/tokens_refresh","metadata":{"seo":{"title":"Refresh Token Pair","description":"Creates a new primary TokenPair object, setting the secondary TokenPairto the previous primary value. Call /v1/removeSecondaryToken to removethis secondary backup once the new primary TokenPair has been deployed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_refresh","name":"Refresh Token Pair","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1refresh/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh Token Pair","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates a new primary "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TokenPair"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object, setting the secondary "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TokenPair"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"to the previous primary value. Call "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/v1/removeSecondaryToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to remove"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this secondary backup once the new primary "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TokenPair"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" has been deployed."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_refresh"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refreshTokenId","in":"path","schemaId":"schema_45","required":true}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1refresh/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/tokens/{refreshTokenId}/refresh","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"refreshTokenId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{refreshTokenId}/refresh","href":"tokens/tokens_refresh","openApiOperationId":"tokens_refresh","summary":"Refresh Token Pair"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefreshTokenResponse"}},"schemaId":"components/schemas/RefreshTokenResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1refresh/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefreshTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefreshTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_refresh"}],"panels":[]}]},"httpPath":"/v1/tokens/{refreshTokenId}/refresh"},{"label":"Remove Secondary Token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/management/tokens/tokens_remove_secondary","routeSlug":"/api-reference/management/tokens/tokens_remove_secondary","metadata":{"seo":{"title":"Remove Secondary Token","description":"Deletes the secondary TokenPair for the RefreshToken objectmatching {refreshTokenId}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens_remove_secondary","name":"Remove Secondary Token","isWebhook":false,"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1secondary/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove Secondary Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deletes the secondary "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TokenPair"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RefreshToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"matching "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{refreshTokenId}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation ID:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens_remove_secondary"},"children":[],"type":"code"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refreshTokenId","in":"path","schemaId":"schema_45","required":true}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1secondary/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/tokens/{refreshTokenId}/secondary","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"parameters":{"path":[{"name":"refreshTokenId","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","402","403","404","405","409","415","429","500"],"pointer":"/v1/tokens/{refreshTokenId}/secondary","href":"tokens/tokens_remove_secondary","openApiOperationId":"tokens_remove_secondary","summary":"Remove Secondary Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"405","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"415","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v1~1tokens~1{refreshTokenId}~1secondary/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"405","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"415","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens_remove_secondary"}],"panels":[]}]},"httpPath":"/v1/tokens/{refreshTokenId}/secondary"}],"content":{"contentType":"group","meta":{"name":"Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tokens","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/tokens","summary":"Create Organization Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokens_create_token","deprecated":false},{"title":"/v1/tokens","summary":"List Refresh Tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tokens/tokens_list","deprecated":false},{"title":"/v1/tokens/mcp","summary":"Create MCP Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokens_create_mcp_token","deprecated":false},{"title":"/v1/tokens/{accountId}/{integrationId}","summary":"Create Integration Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokens_create_integration_token","deprecated":false},{"title":"/v1/tokens/synqly-integrations","summary":"Create Synqly Integrations Token","prefix":{"name":"post","color":"post"},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"link":"/tokens/tokens_create_synqly_integrations_token","deprecated":false},{"title":"/v1/tokens/{refreshTokenId}","summary":"Delete Adhoc Refresh Token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tokens/tokens_delete","deprecated":false},{"title":"/v1/tokens/{refreshTokenId}/info","summary":"Get Refresh Token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tokens/tokens_get","deprecated":false},{"title":"/v1/tokens/{ownerId}/{refreshTokenId}/reset","summary":"Reset Refresh Token","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tokens/tokens_reset","deprecated":false},{"title":"/v1/tokens/{ownerId}/{refreshTokenId}/rotate","summary":"Rotate Refresh Token","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tokens/tokens_rotate","deprecated":false},{"title":"/v1/tokens/{refreshTokenId}/refresh","summary":"Refresh Token Pair","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tokens/tokens_refresh","deprecated":false},{"title":"/v1/tokens/{refreshTokenId}/secondary","summary":"Remove Secondary Token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tokens/tokens_remove_secondary","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccountId":{"id":"components/schemas/AccountId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"title":"Account","type":"object","properties":{"id":{"$ref":"#/components/schemas/AccountId"},"fullname":{"type":"string","description":"Human friendly display name for this account."},"organization_id":{"$ref":"#/components/schemas/OrganizationId","description":"Organization that manages this Account."},"environment":{"$ref":"#/components/schemas/Environment","description":"Environment this account runs in."},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"User defined labels that apply to this account. These values can be used in role bindings to limit the scope of permissions."}},"required":["id","fullname","organization_id","environment"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/ListAccountsResponse":{"id":"components/schemas/ListAccountsResponse","kind":"json-schema","title":"ListAccountsResponse","data":{"title":"ListAccountsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"total":{"type":"integer","nullable":true}},"required":["result"]}},"components/schemas/GetAccountResponse":{"id":"components/schemas/GetAccountResponse","kind":"json-schema","title":"GetAccountResponse","data":{"title":"GetAccountResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Account"}},"required":["result"]}},"components/schemas/ProvisionedTokenRequest":{"id":"components/schemas/ProvisionedTokenRequest","kind":"json-schema","title":"ProvisionedTokenRequest","data":{"title":"ProvisionedTokenRequest","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Request a token for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" being created. Requires the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tokens: provision"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"action, granted by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account-provisioner"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" permission set. The token is scoped"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"by the server to the new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; its scope cannot be set by the caller."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"permission_set":{"$ref":"#/components/schemas/Permissions","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Permission set for the new token. Must be one of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account-manager"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"connect-ui"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token-issuer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"token_ttl":{"type":"string","nullable":true,"description":"Token time-to-live. If not provided, defaults to 24 hours. Use the format \"1h\", \"1m\", \"1s\" for hours, minutes, and seconds respectively, e.g., \"720h\" for 30 days."},"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this token (lowercase [a-z0-9_-], can be used in URLs). Defaults to the token id. Must not collide with an existing token in the organization."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this token, defaults to the same value as the 'name' field if not specified."}},"required":["permission_set"]}},"components/schemas/CreateAccountRequest":{"id":"components/schemas/CreateAccountRequest","kind":"json-schema","title":"CreateAccountRequest","data":{"title":"CreateAccountRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Account, 2 to 128 characters from [a-zA-Z0-9_-], usable in place of the AccountId in URLs. Names are case-sensitive, so duplicate name detection and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" filters match the exact case. Also used for default sort order. Accounts in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"test"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" environment must have a name starting with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"~"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to AccountId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Account, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"environment":{"$ref":"#/components/schemas/Environment","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Environment this account runs in. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"prod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"User defined labels that apply to this account. Labels are limited to 48 characters in length, must contain at least 1 character, and must contain only letters, numbers, underscores, hyphens, colons, and periods. The label values can be used in role bindings to limit the scope of permissions."},"token":{"$ref":"#/components/schemas/ProvisionedTokenRequest","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optionally issue a token scoped to the new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The token secret is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"returned exactly once, in this response, and cannot be retrieved again. If the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"response is lost, an organization administrator must issue a replacement with"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/tokens"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/CreateAccountResponseResult":{"id":"components/schemas/CreateAccountResponseResult","kind":"json-schema","title":"CreateAccountResponseResult","data":{"title":"CreateAccountResponseResult","type":"object","properties":{"account":{"$ref":"#/components/schemas/Account"},"token":{"$ref":"#/components/schemas/RefreshToken","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Present only when the request carried a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" block."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["account"]}},"components/schemas/CreateAccountResponse":{"id":"components/schemas/CreateAccountResponse","kind":"json-schema","title":"CreateAccountResponse","data":{"title":"CreateAccountResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CreateAccountResponseResult"}},"required":["result"]}},"components/schemas/UpdateAccountRequest":{"id":"components/schemas/UpdateAccountRequest","kind":"json-schema","title":"Account","data":{"title":"Account","type":"object","properties":{"id":{"$ref":"#/components/schemas/AccountId"},"fullname":{"type":"string","description":"Human friendly display name for this account."},"organization_id":{"$ref":"#/components/schemas/OrganizationId","description":"Organization that manages this Account."},"environment":{"$ref":"#/components/schemas/Environment","description":"Environment this account runs in."},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"User defined labels that apply to this account. These values can be used in role bindings to limit the scope of permissions."}},"required":["id","fullname","organization_id","environment"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateAccountResponse":{"id":"components/schemas/UpdateAccountResponse","kind":"json-schema","title":"UpdateAccountResponse","data":{"title":"UpdateAccountResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Account"}},"required":["result"]}},"components/schemas/PatchAccountResponse":{"id":"components/schemas/PatchAccountResponse","kind":"json-schema","title":"PatchAccountResponse","data":{"title":"PatchAccountResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Account"}},"required":["result"]}},"components/schemas/AuditType":{"id":"components/schemas/AuditType","kind":"json-schema","title":"AuditType","data":{"title":"AuditType","type":"string","enum":["ALARM","ERROR","API","UNKNOWN"]}},"components/schemas/HTTPMethod":{"id":"components/schemas/HTTPMethod","kind":"json-schema","title":"HTTPMethod","data":{"title":"HTTPMethod","type":"string","enum":["DELETE","GET","PATCH","POST","PUT"]}},"components/schemas/Audit":{"id":"components/schemas/Audit","kind":"json-schema","title":"Audit","data":{"title":"Audit","type":"object","properties":{"environment":{"type":"string"},"created_at":{"type":"string","format":"date-time","description":"Time when the API request occurred."},"remote_addr":{"type":"string"},"user_agent":{"type":"string"},"audit_type":{"$ref":"#/components/schemas/AuditType"},"method":{"$ref":"#/components/schemas/HTTPMethod"},"path":{"type":"string"},"code":{"type":"string"},"body":{"nullable":true},"response":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"member_id":{"$ref":"#/components/schemas/MemberId","nullable":true},"account_id":{"$ref":"#/components/schemas/AccountId","nullable":true},"integration_id":{"$ref":"#/components/schemas/IntegrationId","nullable":true},"bridge_group_id":{"$ref":"#/components/schemas/BridgeGroupId","nullable":true}},"required":["environment","created_at","remote_addr","user_agent","audit_type","method","path","code"]}},"components/schemas/ListAuditEventsResponse":{"id":"components/schemas/ListAuditEventsResponse","kind":"json-schema","title":"ListAuditEventsResponse","data":{"title":"ListAuditEventsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Audit"}}},"required":["result"]}},"components/schemas/AuthCode":{"id":"components/schemas/AuthCode","kind":"json-schema","title":"AuthCode","data":{"title":"AuthCode","type":"string","enum":["success","failure","disabled","expired","invited","locked"]}},"components/schemas/LogonRequest":{"id":"components/schemas/LogonRequest","kind":"json-schema","title":"LogonRequest","data":{"title":"LogonRequest","type":"object","properties":{"name":{"type":"string","description":"Email address identifying the member to initiate a session for."},"secret":{"type":"string","description":"Password of the member to initiate a session for."}},"required":["name","secret"]}},"components/schemas/LogonResponseResult":{"id":"components/schemas/LogonResponseResult","kind":"json-schema","title":"LogonResponseResult","data":{"title":"LogonResponseResult","type":"object","properties":{"auth_code":{"$ref":"#/components/schemas/AuthCode","description":"Authentication result"},"auth_msg":{"type":"string","nullable":true,"description":"Authentication failure message"},"refresh_token_id":{"$ref":"#/components/schemas/TokenId"},"token":{"$ref":"#/components/schemas/TokenPair"},"organization":{"$ref":"#/components/schemas/Organization"},"member":{"$ref":"#/components/schemas/Member"}},"required":["auth_code","refresh_token_id","token","organization","member"]}},"components/schemas/LogonResponse":{"id":"components/schemas/LogonResponse","kind":"json-schema","title":"LogonResponse","data":{"title":"LogonResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/LogonResponseResult"}},"required":["result"]}},"components/schemas/ChangePasswordResponseResult":{"id":"components/schemas/ChangePasswordResponseResult","kind":"json-schema","title":"ChangePasswordResponseResult","data":{"title":"ChangePasswordResponseResult","type":"object","properties":{"auth_code":{"$ref":"#/components/schemas/AuthCode","description":"Authentication result"},"auth_msg":{"type":"string","nullable":true,"description":"Authentication failure message"}},"required":["auth_code"]}},"components/schemas/ChangePasswordResponse":{"id":"components/schemas/ChangePasswordResponse","kind":"json-schema","title":"ChangePasswordResponse","data":{"title":"ChangePasswordResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/ChangePasswordResponseResult"}},"required":["result"]}},"components/schemas/AuthConfigurationId":{"id":"components/schemas/AuthConfigurationId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/AuthConfigurationState":{"id":"components/schemas/AuthConfigurationState","kind":"json-schema","title":"AuthConfigurationState","data":{"title":"AuthConfigurationState","type":"string","enum":["enabled","disabled"]}},"components/schemas/AuthConfiguration":{"id":"components/schemas/AuthConfiguration","kind":"json-schema","title":"AuthConfiguration","data":{"title":"AuthConfiguration","type":"object","description":"Authentication configuration for an Organization. Each configuration describes a single\nway members can sign in: an external Identity Provider (OIDC or SAML), or the built-in\n(password-based) authentication method. For external Identity Providers it also describes\nhow to map identities from the IdP to Member accounts of the Organization.","properties":{"id":{"$ref":"#/components/schemas/AuthConfigurationId"},"fullname":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Display name for the configuration, used on authentication screens."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" To avoid confusion this name must be unique, however it cannot be used"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"as an identifier in API calls."},"children":[],"type":"text"}],"type":"paragraph"}]},"state":{"$ref":"#/components/schemas/AuthConfigurationState","description":"Whether this authentication method is enabled or disabled for the Organization."},"identity_provider":{"$ref":"#/components/schemas/IdPConfiguration"}},"required":["id","fullname","state","identity_provider"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/IdPConfiguration":{"id":"components/schemas/IdPConfiguration","kind":"json-schema","title":"IdPConfiguration","data":{"title":"IdPConfiguration","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["oidc"]}}},{"$ref":"#/components/schemas/OIDCConfiguration"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["saml"]}}},{"$ref":"#/components/schemas/SAMLConfiguration"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["builtin"]}}},{"$ref":"#/components/schemas/BuiltInConfiguration"}],"required":["type"]}]}},"components/schemas/BuiltInConfiguration":{"id":"components/schemas/BuiltInConfiguration","kind":"json-schema","title":"BuiltInConfiguration","data":{"title":"BuiltInConfiguration","type":"object","description":"Configuration for built-in (password-based) authentication. Only one built-in\nconfiguration may exist per Organization.","properties":{"allow_for_users":{"type":"array","items":{"$ref":"#/components/schemas/MemberId"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Members allowed to use built-in authentication, identified by member id or name."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use the special list [\"*\"] to allow all members; this is the default when omitted."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/OIDCConfiguration":{"id":"components/schemas/OIDCConfiguration","kind":"json-schema","title":"OIDCConfiguration","data":{"title":"OIDCConfiguration","type":"object","description":"Configuration for an OpenID Connect (OIDC) compliant Identity Provider.","properties":{"issuer_url":{"type":"string","description":"Issuer URL used to automatically obtain the OpenID Connect discovery document."},"client_id":{"type":"string","description":"Client ID registered with the identity provider."}},"required":["issuer_url","client_id"]}},"components/schemas/SAMLConfiguration":{"id":"components/schemas/SAMLConfiguration","kind":"json-schema","title":"SAMLConfiguration","data":{"title":"SAMLConfiguration","type":"object","description":"Configuration for a SAML 2.0 Identity Provider.","properties":{"idp_entity_id":{"type":"string","description":"Entity ID of the SAML Identity Provider."},"idp_sso_url":{"type":"string","description":"Single Sign-On URL of the SAML Identity Provider."},"sp_entity_id":{"type":"string","description":"Entity ID of the Service Provider (this service)."},"name_id_format":{"type":"string","nullable":true,"description":"NameID format. Defaults to emailAddress."}},"required":["idp_entity_id","idp_sso_url","sp_entity_id"]}},"components/schemas/ChangePasswordRequest":{"id":"components/schemas/ChangePasswordRequest","kind":"json-schema","title":"ChangePasswordRequest","data":{"title":"ChangePasswordRequest","type":"object","properties":{"old_secret":{"type":"string","description":"Old member secret"},"new_secret":{"type":"string","description":"New member secret"}},"required":["old_secret","new_secret"]}},"components/schemas/CreateOidcConfiguration":{"id":"components/schemas/CreateOidcConfiguration","kind":"json-schema","title":"CreateOidcConfiguration","data":{"title":"CreateOidcConfiguration","type":"object","description":"Configuration for an OpenID Connect (OIDC) compliant Identity Provider.","properties":{"issuer_url":{"type":"string","description":"Issuer URL used to automatically obtain the OpenID Connect discovery document."},"client_id":{"type":"string","description":"Client ID registered with the identity provider."},"client_secret":{"type":"string","description":"Client secret registered with the identity provider."}},"required":["issuer_url","client_id","client_secret"]}},"components/schemas/CreateSamlConfiguration":{"id":"components/schemas/CreateSamlConfiguration","kind":"json-schema","title":"CreateSamlConfiguration","data":{"title":"CreateSamlConfiguration","type":"object","description":"Configuration for creating a SAML 2.0 Identity Provider.","properties":{"idp_entity_id":{"type":"string","description":"Entity ID of the SAML Identity Provider."},"idp_sso_url":{"type":"string","description":"Single Sign-On URL of the SAML Identity Provider (HTTPS required)."},"idp_certificate":{"type":"string","description":"PEM-encoded X.509 certificate for verifying SAML assertion signatures."},"sp_entity_id":{"type":"string","description":"Entity ID of the Service Provider."},"idp_metadata_url":{"type":"string","nullable":true,"description":"URL to the IdP's SAML metadata document (informational)."},"name_id_format":{"type":"string","nullable":true,"description":"NameID format. Defaults to urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress."}},"required":["idp_entity_id","idp_sso_url","idp_certificate","sp_entity_id"]}},"components/schemas/CreateBuiltInConfiguration":{"id":"components/schemas/CreateBuiltInConfiguration","kind":"json-schema","title":"CreateBuiltInConfiguration","data":{"title":"CreateBuiltInConfiguration","type":"object","description":"Configuration for creating built-in (password-based) authentication.","properties":{"allow_for_users":{"type":"array","items":{"$ref":"#/components/schemas/MemberId"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Members allowed to use built-in authentication, identified by member id or name."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use the special list [\"*\"] to allow all members; this is the default when omitted."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/CreateIdPConfiguration":{"id":"components/schemas/CreateIdPConfiguration","kind":"json-schema","title":"CreateIdPConfiguration","data":{"title":"CreateIdPConfiguration","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["oidc"]}}},{"$ref":"#/components/schemas/CreateOidcConfiguration"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["saml"]}}},{"$ref":"#/components/schemas/CreateSamlConfiguration"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["builtin"]}}},{"$ref":"#/components/schemas/CreateBuiltInConfiguration"}],"required":["type"]}]}},"components/schemas/CreateAuthConfigurationRequest":{"id":"components/schemas/CreateAuthConfigurationRequest","kind":"json-schema","title":"CreateAuthConfigurationRequest","data":{"title":"CreateAuthConfigurationRequest","type":"object","description":"Request to create an authentication configuration","properties":{"fullname":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Display name for the configuration, used on authentication screens."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" To avoid confusion this name must be unique, however it cannot be used"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"as an identifier in API calls."},"children":[],"type":"text"}],"type":"paragraph"}]},"state":{"$ref":"#/components/schemas/AuthConfigurationState","nullable":true,"description":"Whether the configuration is enabled or disabled. Defaults to enabled when omitted."},"config":{"$ref":"#/components/schemas/CreateIdPConfiguration","description":"Identity provider configuration. The type discriminator determines the authentication method."}},"required":["fullname","config"]}},"components/schemas/CreateAuthConfigurationResponse":{"id":"components/schemas/CreateAuthConfigurationResponse","kind":"json-schema","title":"CreateAuthConfigurationResponse","data":{"title":"CreateAuthConfigurationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/AuthConfiguration"}},"required":["result"]}},"components/schemas/GetAuthConfigurationResponse":{"id":"components/schemas/GetAuthConfigurationResponse","kind":"json-schema","title":"GetAuthConfigurationResponse","data":{"title":"GetAuthConfigurationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/AuthConfiguration"}},"required":["result"]}},"components/schemas/GetAuthMetadataResponse":{"id":"components/schemas/GetAuthMetadataResponse","kind":"json-schema","title":"GetAuthMetadataResponse","data":{"title":"GetAuthMetadataResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/AuthConfigurationMetadata","description":"Information the user needs to configure their Identity Provider."}},"required":["result"]}},"components/schemas/AuthConfigurationMetadata":{"id":"components/schemas/AuthConfigurationMetadata","kind":"json-schema","title":"AuthConfigurationMetadata","data":{"title":"AuthConfigurationMetadata","type":"object","description":"SP-side configuration values the user needs to enter into their Identity Provider.\nOnly the fields relevant to the configured protocol are populated.","properties":{"oidc":{"$ref":"#/components/schemas/OIDCUserConfiguration","nullable":true,"description":"OIDC configuration values. Present when the configuration uses OIDC."},"saml":{"$ref":"#/components/schemas/SAMLUserConfiguration","nullable":true,"description":"SAML configuration values. Present when the configuration uses SAML."}}}},"components/schemas/OIDCUserConfiguration":{"id":"components/schemas/OIDCUserConfiguration","kind":"json-schema","title":"OIDCUserConfiguration","data":{"title":"OIDCUserConfiguration","type":"object","description":"Values the user needs to enter into their OIDC Identity Provider.","properties":{"redirect_uri":{"type":"string","description":"The redirect URI to register with the Identity Provider."}},"required":["redirect_uri"]}},"components/schemas/SAMLUserConfiguration":{"id":"components/schemas/SAMLUserConfiguration","kind":"json-schema","title":"SAMLUserConfiguration","data":{"title":"SAMLUserConfiguration","type":"object","description":"Values the user needs to enter into their SAML Identity Provider.","properties":{"acs_url":{"type":"string","description":"Assertion Consumer Service URL to register with the Identity Provider."},"sp_entity_id":{"type":"string","description":"Service Provider Entity ID to register with the Identity Provider."},"supported_name_id_formats":{"type":"array","items":{"type":"string"},"description":"Supported NameID formats."}},"required":["acs_url","sp_entity_id","supported_name_id_formats"]}},"components/schemas/UpdateOidcConfiguration":{"id":"components/schemas/UpdateOidcConfiguration","kind":"json-schema","title":"UpdateOidcConfiguration","data":{"title":"UpdateOidcConfiguration","type":"object","description":"Configuration for an OpenID Connect (OIDC) compliant Identity Provider.","properties":{"issuer_url":{"type":"string","description":"Issuer URL used to automatically obtain the OpenID Connect discovery document."},"client_id":{"type":"string","description":"Client ID registered with the identity provider."},"client_secret":{"type":"string","nullable":true,"description":"Client secret. Include only when rotating the secret."}},"required":["issuer_url","client_id"]}},"components/schemas/UpdateSamlConfiguration":{"id":"components/schemas/UpdateSamlConfiguration","kind":"json-schema","title":"UpdateSamlConfiguration","data":{"title":"UpdateSamlConfiguration","type":"object","description":"Configuration for updating a SAML 2.0 Identity Provider.","properties":{"idp_entity_id":{"type":"string","description":"Entity ID of the SAML Identity Provider."},"idp_sso_url":{"type":"string","description":"Single Sign-On URL of the SAML Identity Provider (HTTPS required)."},"idp_certificate":{"type":"string","nullable":true,"description":"PEM-encoded X.509 certificate. Omit to keep existing certificate."},"sp_entity_id":{"type":"string","description":"Entity ID of the Service Provider."},"idp_metadata_url":{"type":"string","nullable":true,"description":"URL to the IdP's SAML metadata document (informational)."},"name_id_format":{"type":"string","nullable":true,"description":"NameID format. Defaults to urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress."}},"required":["idp_entity_id","idp_sso_url","sp_entity_id"]}},"components/schemas/UpdateBuiltInConfiguration":{"id":"components/schemas/UpdateBuiltInConfiguration","kind":"json-schema","title":"UpdateBuiltInConfiguration","data":{"title":"UpdateBuiltInConfiguration","type":"object","description":"Configuration for updating built-in (password-based) authentication.","properties":{"allow_for_users":{"type":"array","items":{"$ref":"#/components/schemas/MemberId"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Members allowed to use built-in authentication, identified by member id or name."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use the special list [\"*\"] to allow all members; this is the default when omitted."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/UpdateIdPConfiguration":{"id":"components/schemas/UpdateIdPConfiguration","kind":"json-schema","title":"UpdateIdPConfiguration","data":{"title":"UpdateIdPConfiguration","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["oidc"]}}},{"$ref":"#/components/schemas/UpdateOidcConfiguration"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["saml"]}}},{"$ref":"#/components/schemas/UpdateSamlConfiguration"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["builtin"]}}},{"$ref":"#/components/schemas/UpdateBuiltInConfiguration"}],"required":["type"]}]}},"components/schemas/UpdateAuthConfigurationRequest":{"id":"components/schemas/UpdateAuthConfigurationRequest","kind":"json-schema","title":"UpdateAuthConfigurationRequest","data":{"title":"UpdateAuthConfigurationRequest","type":"object","description":"Request to update an authentication configuration","properties":{"fullname":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Display name for the configuration, used on authentication screens."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" To avoid confusion this name must be unique, however it cannot be used"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"as an identifier in API calls."},"children":[],"type":"text"}],"type":"paragraph"}]},"state":{"$ref":"#/components/schemas/AuthConfigurationState","nullable":true,"description":"Whether the configuration is enabled or disabled. Defaults to enabled when omitted."},"config":{"$ref":"#/components/schemas/UpdateIdPConfiguration","description":"Identity provider configuration. The type discriminator determines the authentication method."},"updated_at":{"type":"string","format":"date-time","nullable":true,"description":"Used for optimistic locking to prevent concurrent updates."}},"required":["fullname","config"]}},"components/schemas/UpdateAuthConfigurationResponse":{"id":"components/schemas/UpdateAuthConfigurationResponse","kind":"json-schema","title":"UpdateAuthConfigurationResponse","data":{"title":"UpdateAuthConfigurationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/AuthConfiguration"}},"required":["result"]}},"components/schemas/ListAuthConfigurationsResponse":{"id":"components/schemas/ListAuthConfigurationsResponse","kind":"json-schema","title":"ListAuthConfigurationsResponse","data":{"title":"ListAuthConfigurationsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AuthConfiguration"}}},"required":["result"]}},"components/schemas/BridgeGroupId":{"id":"components/schemas/BridgeGroupId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/BridgeGroup":{"id":"components/schemas/BridgeGroup","kind":"json-schema","title":"BridgeGroup","data":{"title":"BridgeGroup","type":"object","description":"A Bridge Group represents a connection between the Synqly Saas or Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in Synqly docs for additional information.","properties":{"id":{"$ref":"#/components/schemas/BridgeGroupId"},"fullname":{"type":"string","description":"Full name of bridge"},"description":{"type":"string","nullable":true,"description":"Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas."},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration."}},"required":["id","fullname"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/ListBridgesResponse":{"id":"components/schemas/ListBridgesResponse","kind":"json-schema","title":"ListBridgesResponse","data":{"title":"ListBridgesResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/BridgeGroup"}}},"required":["result"]}},"components/schemas/GetBridgeResponse":{"id":"components/schemas/GetBridgeResponse","kind":"json-schema","title":"GetBridgeResponse","data":{"title":"GetBridgeResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/BridgeGroup"}},"required":["result"]}},"components/schemas/GetBridgeStatusResponse":{"id":"components/schemas/GetBridgeStatusResponse","kind":"json-schema","title":"GetBridgeStatusResponse","data":{"title":"GetBridgeStatusResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/BridgeStatus"}}},"required":["result"]}},"components/schemas/CreateBridgeRequest":{"id":"components/schemas/CreateBridgeRequest","kind":"json-schema","title":"CreateBridgeRequest","data":{"title":"CreateBridgeRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Bridge (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to BridgeGroupId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Bridge, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"description":{"type":"string","nullable":true,"description":"Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas."},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Bridge selection labels"}}}},"components/schemas/CreateBridgeResponseResult":{"id":"components/schemas/CreateBridgeResponseResult","kind":"json-schema","title":"CreateBridgeResponseResult","data":{"title":"CreateBridgeResponseResult","type":"object","properties":{"bridge":{"$ref":"#/components/schemas/BridgeGroup"},"credential":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"JWT for the Bridge Group to connect to Synqly. This must be saved in a file {bridgeId}.creds in the same directory as the bridge executable."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["bridge","credential"]}},"components/schemas/CreateBridgeResponse":{"id":"components/schemas/CreateBridgeResponse","kind":"json-schema","title":"CreateBridgeResponse","data":{"title":"CreateBridgeResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CreateBridgeResponseResult"}},"required":["result"]}},"components/schemas/UpdateBridgeRequest":{"id":"components/schemas/UpdateBridgeRequest","kind":"json-schema","title":"BridgeGroup","data":{"title":"BridgeGroup","type":"object","description":"A Bridge Group represents a connection between the Synqly Saas or Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in Synqly docs for additional information.","properties":{"id":{"$ref":"#/components/schemas/BridgeGroupId"},"fullname":{"type":"string","description":"Full name of bridge"},"description":{"type":"string","nullable":true,"description":"Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas."},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration."}},"required":["id","fullname"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateBridgeResponse":{"id":"components/schemas/UpdateBridgeResponse","kind":"json-schema","title":"UpdateBridgeResponse","data":{"title":"UpdateBridgeResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/BridgeGroup"}},"required":["result"]}},"components/schemas/PatchBridgeResponse":{"id":"components/schemas/PatchBridgeResponse","kind":"json-schema","title":"PatchBridgeResponse","data":{"title":"PatchBridgeResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/BridgeGroup"}},"required":["result"]}},"components/schemas/BridgeStatus":{"id":"components/schemas/BridgeStatus","kind":"json-schema","title":"BridgeStatus","data":{"title":"BridgeStatus","type":"object","properties":{"current_time":{"type":"string","format":"date-time","description":"Local time on the Bridge when the status check was performed."},"response_duration":{"type":"string","description":"Round trip time for the status check."},"local_config":{"$ref":"#/components/schemas/BridgeLocalConfig","description":"Local configuration parameters for the Bridge."},"local_stats":{"$ref":"#/components/schemas/BridgeLocalStats","description":"Local bridge statistics"}},"required":["current_time","response_duration","local_config","local_stats"]}},"components/schemas/BridgeLocalConfig":{"id":"components/schemas/BridgeLocalConfig","kind":"json-schema","title":"BridgeLocalConfig","data":{"title":"BridgeLocalConfig","type":"object","properties":{"version":{"type":"string","description":"Version of the Bridge."},"allow_addresses":{"type":"array","items":{"type":"string"},"description":"List of IP addresses that the Bridge is allowed to connect to."},"vault":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Vault configuration for the Bridge."}},"required":["version","allow_addresses"]}},"components/schemas/BridgeLocalStats":{"id":"components/schemas/BridgeLocalStats","kind":"json-schema","title":"BridgeLocalStats","data":{"title":"BridgeLocalStats","type":"object","properties":{"requests":{"type":"integer","format":"int64"},"failures":{"type":"integer","format":"int64"},"in_bytes":{"type":"integer","format":"int64"},"out_bytes":{"type":"integer","format":"int64"}},"required":["requests","failures","in_bytes","out_bytes"]}},"components/schemas/ProviderId":{"id":"components/schemas/ProviderId","kind":"json-schema","title":"ProviderId","data":{"title":"ProviderId","type":"string"}},"components/schemas/CategoryId":{"id":"components/schemas/CategoryId","kind":"json-schema","title":"CategoryId","data":{"title":"CategoryId","type":"string","enum":["appsec","assets","chat","cloudsecurity","custom","edr","emailsecurity","endpointmanagement","grc","identity","incidentresponse","networksecurity","notifications","securityawareness","siem","sink","ssf","storage","threatintel","ticketing","vulnerabilities"],"description":"Id of the Integrations category"}},"components/schemas/ProviderCapabilitiesBase":{"id":"components/schemas/ProviderCapabilitiesBase","kind":"json-schema","title":"ProviderCapabilitiesBase","data":{"title":"ProviderCapabilitiesBase","type":"object","description":"Base properties for provider capabilities. This type is used both\ndirectly (when providers are nested in connectors) and extended by\nProviderCapabilities (which adds the expandable connector field).","properties":{"id":{"$ref":"#/components/schemas/ProviderId","description":"Unique identifier for the Provider."},"name":{"type":"string","description":"Name of the Provider."},"fullname":{"type":"string","description":"Display name of the Provider."},"vendor":{"type":"string","description":"Display name of the Provider vendor."},"description":{"type":"string","description":"Description of the Provider."},"connector_id":{"$ref":"#/components/schemas/CategoryId","description":"Id of the Connector that the Provider implements."},"operations":{"type":"array","items":{"$ref":"#/components/schemas/ProviderOperations"},"nullable":true,"description":"Operations that the Provider implements."},"provider_config":{"nullable":true,"description":"Details on the specific configuration options for the Provider."},"release":{"$ref":"#/components/schemas/ProviderRelease","nullable":true,"description":"Provider availability information."}},"required":["id","name","fullname","vendor","description","connector_id"]}},"components/schemas/ProviderCapabilities":{"id":"components/schemas/ProviderCapabilities","kind":"json-schema","title":"ProviderCapabilities","data":{"title":"ProviderCapabilities","type":"object","properties":{"connector":{"$ref":"#/components/schemas/ConnectorOrId","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id of the Connector that the Provider implements – or, if"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expand=connector"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is set – the details of the Connector. NOTE:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The current default behavior is to return the ID of the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connector. This field will soon only be populated when"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expand=connector"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is set in the APIs that support it. It is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"recommended you use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"connector_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a stable reference to the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connector ID. This field will soon only be populated when"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expand=connector"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is set in the APIs that support it."},"children":[],"type":"text"}],"type":"paragraph"}]}},"allOf":[{"$ref":"#/components/schemas/ProviderCapabilitiesBase"}]}},"components/schemas/ProviderRelease":{"id":"components/schemas/ProviderRelease","kind":"json-schema","title":"ProviderRelease","data":{"title":"ProviderRelease","type":"object","properties":{"availability":{"$ref":"#/components/schemas/Availability","description":"Availability status."},"environments":{"type":"array","items":{"$ref":"#/components/schemas/ProviderEnvironment"},"description":"Environments the Provider is available to."}},"required":["availability","environments"]}},"components/schemas/Availability":{"id":"components/schemas/Availability","kind":"json-schema","title":"Availability","data":{"title":"Availability","type":"string","enum":["internal","in-development","pre-release","deprecated","generally-available"]}},"components/schemas/ProviderEnvironment":{"id":"components/schemas/ProviderEnvironment","kind":"json-schema","title":"ProviderEnvironment","data":{"title":"ProviderEnvironment","type":"string","enum":["prod","test"]}},"components/schemas/ConnectorOrId":{"id":"components/schemas/ConnectorOrId","kind":"json-schema","title":"ConnectorOrId","data":{"title":"ConnectorOrId","oneOf":[{"$ref":"#/components/schemas/CategoryId"},{"$ref":"#/components/schemas/Connector"}]}},"components/schemas/Connector":{"id":"components/schemas/Connector","kind":"json-schema","title":"Connector","data":{"title":"Connector","type":"object","description":"Provides details of the Connector.","properties":{"id":{"$ref":"#/components/schemas/CategoryId","description":"Unique identifier for the Connector."},"name":{"$ref":"#/components/schemas/CategoryId","description":"Name of the connector."},"fullname":{"type":"string","description":"Display name of the Connector."},"description":{"type":"string","description":"Description of the Connector."},"provider_ids":{"type":"array","items":{"$ref":"#/components/schemas/ProviderId"},"description":"List of Providers that implement the Connector."},"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderCapabilitiesBase"},"nullable":true,"description":"List of capabilities for Providers that implement the Connector.\nUses ProviderCapabilitiesBase which omits the expandable connector\nfield since nested providers never have expanded connectors."},"connector":{"$ref":"#/components/schemas/CategoryId","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DEPRECATED – use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" instead."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"deprecated"},"release":{"$ref":"#/components/schemas/ConnectorRelease","nullable":true,"description":"Connector availability information."}},"required":["id","name","fullname","description","provider_ids"]}},"components/schemas/ConnectorRelease":{"id":"components/schemas/ConnectorRelease","kind":"json-schema","title":"ConnectorRelease","data":{"title":"ConnectorRelease","type":"object","properties":{"availability":{"$ref":"#/components/schemas/Availability","description":"Availability status."}},"required":["availability"]}},"components/schemas/ProviderOperations":{"id":"components/schemas/ProviderOperations","kind":"json-schema","title":"ProviderOperations","data":{"title":"ProviderOperations","type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the operation."},"name":{"type":"string","description":"Name of the operation."},"fullname":{"type":"string","nullable":true,"description":"Display name of the operation."},"description":{"type":"string","nullable":true,"description":"Description of the operation."},"request_method":{"type":"string","nullable":true,"description":"HTTP method used for the operation."},"request_path":{"type":"string","nullable":true,"description":"URI template path for the operation, including path parameters."},"supported":{"type":"boolean","description":"Whether the operation is supported by the provider."},"required_fields":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of fields in the request body that are required by the\nprovider for this operation. Due to limitations of the OpenAPI\nformat these fields may be marked as optional, even though they\nare in fact required by this provider."},"supported_response_fields":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of fields that may be returned in the response body. Any\nfields not listed in this array are not supported by this\nprovider and will not be returned in the response body."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/ProviderFilter"},"nullable":true,"description":"Filters that can be applied to this operation."},"orders":{"type":"array","items":{"$ref":"#/components/schemas/ProviderOrder"},"nullable":true,"description":"Orders that can be applied to this operation."},"request_body":{"$ref":"#/components/schemas/RequestBody","nullable":true,"description":"This field is only available if the operation supports a request\nbody. Describes the request body and its schema."},"actions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProviderActionSpec"},"nullable":true,"description":"Supported actions for this operation, keyed by Synqly-unified\naction name. Use the capabilities API to discover which actions\neach provider supports."}},"required":["id","name","supported"]}},"components/schemas/ProviderActionSpec":{"id":"components/schemas/ProviderActionSpec","kind":"json-schema","title":"ProviderActionSpec","data":{"title":"ProviderActionSpec","type":"object","description":"Describes a supported action within an operation.","properties":{"required_fields":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Fields required when using this action."},"docs":{"type":"string","nullable":true,"description":"Description of what this action does for this provider."}}}},"components/schemas/RequestBody":{"id":"components/schemas/RequestBody","kind":"json-schema","title":"RequestBody","data":{"title":"RequestBody","type":"object","description":"Describes the request body and its schema.","properties":{"required":{"type":"boolean","description":"If true the request body is required, false otherwise."},"schema":{"type":"object","additionalProperties":true,"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The schema defining the type used for the request body. If"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expanded will be a full JSON schema of the entire request body,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"otherwise this will be a reference object. The reference object"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"has a single key "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"$ref"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", which is a URI [RFC3986] identifying the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location of a component within the Engine OpenAPI specification."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["required"]}},"components/schemas/ProviderFilter":{"id":"components/schemas/ProviderFilter","kind":"json-schema","title":"ProviderFilter","data":{"title":"ProviderFilter","type":"object","properties":{"name":{"type":"string","description":"Name of the filter."},"type":{"$ref":"#/components/schemas/FilterType","description":"Type of the value that this filter can apply to"},"operators":{"type":"array","items":{"type":"string"},"description":"List of operators that this filter supports."},"values":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of possible values for this filter."},"docs":{"type":"string","nullable":true,"description":"Caller-facing notes for this filter, such as operator semantics that differ from the Synqly default."}},"required":["name","type","operators"]}},"components/schemas/ProviderOrder":{"id":"components/schemas/ProviderOrder","kind":"json-schema","title":"ProviderOrder","data":{"title":"ProviderOrder","type":"object","properties":{"name":{"type":"string","description":"Name of the field to order by."},"directions":{"type":"array","items":{"$ref":"#/components/schemas/OrderDirection"},"description":"List of possible directions to order by."}},"required":["name","directions"]}},"components/schemas/OrderDirection":{"id":"components/schemas/OrderDirection","kind":"json-schema","title":"OrderDirection","data":{"title":"OrderDirection","type":"string","enum":["asc","desc"]}},"components/schemas/FilterType":{"id":"components/schemas/FilterType","kind":"json-schema","title":"FilterType","data":{"title":"FilterType","type":"string","enum":["string","datetime","enum","boolean","number"]}},"components/schemas/ListConnectorsCapabilitiesResponse":{"id":"components/schemas/ListConnectorsCapabilitiesResponse","kind":"json-schema","title":"ListConnectorsCapabilitiesResponse","data":{"title":"ListConnectorsCapabilitiesResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Connector"}}},"required":["result"]}},"components/schemas/ListProvidersCapabilitiesResponse":{"id":"components/schemas/ListProvidersCapabilitiesResponse","kind":"json-schema","title":"ListProvidersCapabilitiesResponse","data":{"title":"ListProvidersCapabilitiesResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ProviderCapabilities"}}},"required":["result"]}},"components/schemas/ProviderCapabilitiesResponse":{"id":"components/schemas/ProviderCapabilitiesResponse","kind":"json-schema","title":"ProviderCapabilitiesResponse","data":{"title":"ProviderCapabilitiesResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/ProviderCapabilities"}},"required":["result"]}},"components/schemas/ListConnectorCapabilitiesExpandOptions":{"id":"components/schemas/ListConnectorCapabilitiesExpandOptions","kind":"json-schema","title":"ListConnectorCapabilitiesExpandOptions","data":{"title":"ListConnectorCapabilitiesExpandOptions","type":"string","enum":["providers"]}},"components/schemas/ListProviderCapabilitiesExpandOptions":{"id":"components/schemas/ListProviderCapabilitiesExpandOptions","kind":"json-schema","title":"ListProviderCapabilitiesExpandOptions","data":{"title":"ListProviderCapabilitiesExpandOptions","type":"string","enum":["connector","operations","provider_config"]}},"components/schemas/GetProviderCapabilitiesExpandOptions":{"id":"components/schemas/GetProviderCapabilitiesExpandOptions","kind":"json-schema","title":"GetProviderCapabilitiesExpandOptions","data":{"title":"GetProviderCapabilitiesExpandOptions","type":"string","enum":["connector","operations","request_body","provider_config"]}},"components/schemas/Id":{"id":"components/schemas/Id","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/Base":{"id":"components/schemas/Base","kind":"json-schema","title":"Base","data":{"title":"Base","type":"object","properties":{"name":{"type":"string","description":"Human-readable name for this resource"},"created_at":{"type":"string","format":"date-time","description":"Time object was originally created"},"updated_at":{"type":"string","format":"date-time","description":"Last time object was updated"}},"required":["name","created_at","updated_at"]}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"title":"Problem","type":"object","description":"Generic base type for problems in Synqly. This object carries both machine-readable data as well as information intended for display purposes.","properties":{"type":{"$ref":"#/components/schemas/ProblemType","nullable":true},"occurred_at":{"type":"string","format":"date-time","description":"The date and time the problem occurred."},"status":{"type":"integer","description":"The HTTP status code of the problem. Matches the HTTP response code sent by the server."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."},"cause":{"type":"array","items":{"$ref":"#/components/schemas/ProblemCause"},"nullable":true,"description":"A list of the root cause(s) for this problem occurrence. Includes at minimum one root cause, and is otherwise an unordered list of causes."}},"required":["occurred_at","status","instance"],"allOf":[{"$ref":"#/components/schemas/ProblemDetails"}]}},"components/schemas/ProblemCause":{"id":"components/schemas/ProblemCause","kind":"json-schema","title":"ProblemCause","data":{"title":"ProblemCause","type":"object","properties":{"type":{"$ref":"#/components/schemas/ProblemType"}},"required":["type"],"allOf":[{"$ref":"#/components/schemas/ProblemDetails"}]}},"components/schemas/ProblemType":{"id":"components/schemas/ProblemType","kind":"json-schema","title":"ProblemType","data":{"title":"ProblemType","type":"string","description":"A URI reference that identifies the type of problem that occurred. When the URI scheme is HTTP(s), it may or may not be possible to deference the URL to a display-friendly description of the problem type."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"title":"ProblemDetails","type":"object","properties":{"message":{"type":"string","description":"A short, display-friendly summary of the problem."},"detail":{"type":"string","nullable":true,"description":"A display-friendly and more detailed explanation of the problem. It may offer additional contextual detail, but may also be just a generic description of the problem."},"remediation":{"type":"string","nullable":true,"description":"A display-friendly explanation for how to remediate the problem. This field may be omitted in case there are multiple problems, each with its own remediation, or if no remediation is possible."},"context":{"$ref":"#/components/schemas/ProblemContext","nullable":true,"description":"Additional context providing further detail about the problem, such as a problematic input parameter and/or a list of related resources."}},"required":["message"]}},"components/schemas/ProblemContext":{"id":"components/schemas/ProblemContext","kind":"json-schema","title":"ProblemContext","data":{"title":"ProblemContext","type":"object","properties":{"parameter":{"$ref":"#/components/schemas/ProblematicParameter","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the problem is related to a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"query"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"path"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"body"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" parameter, this field will describe the problematic parameter and where to find it."},"children":[],"type":"text"}],"type":"paragraph"}]},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ResourceReference"},"nullable":true},"raw_error":{"type":"string","nullable":true,"description":"If available this represents the underlying raw error, for example an error response from a Provider."},"provider_details":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"If available this represents the underlying details from the provider. May include the error message, status code, and other details."}}}},"components/schemas/ProblematicParameter":{"id":"components/schemas/ProblematicParameter","kind":"json-schema","title":"ProblematicParameter","data":{"title":"ProblematicParameter","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of the parameter is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"body"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this value is always a JSON Pointer, otherwise it's the name of the parameter."},"children":[],"type":"text"}],"type":"paragraph"}]},"location":{"$ref":"#/components/schemas/ParameterLocation","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The location of the parameter. Possible values are "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"query"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"path"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"body"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"value":{"nullable":true,"description":"The given value of the parameter."}},"required":["id","location"]}},"components/schemas/ParameterLocation":{"id":"components/schemas/ParameterLocation","kind":"json-schema","title":"ParameterLocation","data":{"title":"ParameterLocation","type":"string","enum":["header","path","query","body"]}},"components/schemas/ResourceReference":{"id":"components/schemas/ResourceReference","kind":"json-schema","title":"ResourceReference","data":{"title":"ResourceReference","type":"object","properties":{"type":{"$ref":"#/components/schemas/ResourceType","description":"Type of the related resource."},"id":{"type":"string","description":"ID of the related resource."},"rel":{"$ref":"#/components/schemas/ProblemRelation","description":"The way in which the resource relates to the problem."}},"required":["type","id","rel"]}},"components/schemas/ProblemRelation":{"id":"components/schemas/ProblemRelation","kind":"json-schema","title":"ProblemRelation","data":{"title":"ProblemRelation","type":"string","enum":["affected","cause"]}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"title":"ResourceType","type":"string","enum":["account","bridge","credential","integration_point","integration","member","operation","organization_webhook","role","sub_org","token","transform"]}},"components/schemas/PatchOp":{"id":"components/schemas/PatchOp","kind":"json-schema","title":"PatchOp","data":{"title":"PatchOp","type":"string","enum":["add","copy","move","remove","replace","test"]}},"components/schemas/PatchOperation":{"id":"components/schemas/PatchOperation","kind":"json-schema","title":"PatchOperation","data":{"title":"PatchOperation","type":"object","description":"JSON patch to apply. A JSON patch is a list of patch operations. (see https://jsonpatch.com/)","properties":{"op":{"$ref":"#/components/schemas/PatchOp","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The operation to perform. Supported values are "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"add"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"copy"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"move"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"replace"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"remove"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"test"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"path":{"type":"string","description":"The path to the field to update. The path is a JSON Pointer."},"from":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The path to the field to copy from. This is required for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"copy"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"move"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" operations."},"children":[],"type":"text"}],"type":"paragraph"}]},"value":{"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The value to set the field to. This is required for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"add"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"replace"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"test"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" operations."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["op","path"]}},"components/schemas/ResourceId":{"id":"components/schemas/ResourceId","kind":"json-schema","title":"ResourceId","data":{"title":"ResourceId","type":"string","enum":["alerts","applications","audit_logs","comments","devices","events","evidence","findings","groups","investigations","iocs","log_providers","posture_scores","projects","scans","scan_activities","threats","tickets","users","compliance","cloudresourceinventory"]}},"components/schemas/ActionId":{"id":"components/schemas/ActionId","kind":"json-schema","title":"ActionId","data":{"title":"ActionId","type":"string","enum":["query","read","create","update","delete","patch"]}},"components/schemas/CredentialId":{"id":"components/schemas/CredentialId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/OwnerType":{"id":"components/schemas/OwnerType","kind":"json-schema","title":"OwnerType","data":{"title":"OwnerType","type":"string","enum":["account","integration","integration_point","organization_webhook"]}},"components/schemas/ManagedType":{"id":"components/schemas/ManagedType","kind":"json-schema","title":"ManagedType","data":{"title":"ManagedType","type":"string","enum":["Managed","Unmanaged"]}},"components/schemas/CredentialKind":{"id":"components/schemas/CredentialKind","kind":"json-schema","title":"CredentialKind","data":{"title":"CredentialKind","type":"string","enum":["default","ssf"],"description":"What a credential is for. Set by Synqly when the credential is created and never changed afterwards.","x-fern-availability":"in-development"}},"components/schemas/Credential":{"id":"components/schemas/Credential","kind":"json-schema","title":"Credential","data":{"title":"Credential","type":"object","description":"Credential to access an integration. Each credential is owned by an Account, Integration, IntegrationPoint or OrganizationWebhook.","properties":{"id":{"$ref":"#/components/schemas/CredentialId"},"account_id":{"$ref":"#/components/schemas/AccountId","nullable":true,"description":"Account that manages this credential."},"integration_id":{"$ref":"#/components/schemas/IntegrationId","nullable":true,"description":"Integration associated with this credential."},"integration_point_id":{"$ref":"#/components/schemas/IntegrationPointId","nullable":true,"description":"Integration Point associated with this credential."},"organization_webhook_id":{"$ref":"#/components/schemas/WebhookId","nullable":true,"description":"Organization Webhook associated with this credential."},"owner_type":{"$ref":"#/components/schemas/OwnerType","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"One of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_point"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","description":"Human friendly display name for this Credential"},"config":{"$ref":"#/components/schemas/CredentialConfig","nullable":true,"description":"Credential configuration"},"expires":{"type":"string","format":"date-time","nullable":true,"description":"Time when this credential expires and can no longer be used again."},"managed":{"$ref":"#/components/schemas/ManagedType","description":"Field is set by the management process. Determines lifecycle and ownership of the credential."}},"required":["id","owner_type","fullname","managed"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/CredentialResponse":{"id":"components/schemas/CredentialResponse","kind":"json-schema","title":"CredentialResponse","data":{"title":"CredentialResponse","type":"object","description":"Response object for a Credential","properties":{"id":{"$ref":"#/components/schemas/CredentialId"},"account_id":{"$ref":"#/components/schemas/AccountId","nullable":true,"description":"Account that manages this credential."},"integration_id":{"$ref":"#/components/schemas/IntegrationId","nullable":true,"description":"Integration associated with this credential."},"integration_point_id":{"$ref":"#/components/schemas/IntegrationPointId","nullable":true,"description":"Integration Point associated with this credential."},"organization_webhook_id":{"$ref":"#/components/schemas/WebhookId","nullable":true,"description":"Integration Point associated with this credential."},"owner_type":{"$ref":"#/components/schemas/OwnerType","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"One of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_point"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","description":"Human friendly display name for this Credential. Defaults to the same value as the 'name' field if not specified."},"config":{"$ref":"#/components/schemas/CredentialConfigNoSecret"},"expires":{"type":"string","format":"date-time","nullable":true,"description":"Time when this credential expires and can no longer be used again."},"managed":{"$ref":"#/components/schemas/ManagedType","description":"Field is set by the management process. Determines lifecycle and ownership of the credential."},"kind":{"$ref":"#/components/schemas/CredentialKind","description":"What the credential is for. Read only - it is set when the credential is created and cannot be changed.","x-fern-availability":"in-development"}},"required":["id","owner_type","fullname","config","managed","kind"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/CredentialConfigNoSecret":{"id":"components/schemas/CredentialConfigNoSecret","kind":"json-schema","title":"CredentialConfigNoSecret","data":{"title":"CredentialConfigNoSecret","type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"components/schemas/AwsCredentialId":{"id":"components/schemas/AwsCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/AwsRoleCredentialId":{"id":"components/schemas/AwsRoleCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/BasicCredentialId":{"id":"components/schemas/BasicCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/TokenCredentialId":{"id":"components/schemas/TokenCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/SecretCredentialId":{"id":"components/schemas/SecretCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/OAuthClientCredentialId":{"id":"components/schemas/OAuthClientCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/TlsCertificateCredentialId":{"id":"components/schemas/TlsCertificateCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/OAuthCodeCredentialId":{"id":"components/schemas/OAuthCodeCredentialId","kind":"json-schema","title":"CredentialId","data":{"title":"CredentialId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Credential"}},"components/schemas/CredentialConfig":{"id":"components/schemas/CredentialConfig","kind":"json-schema","title":"CredentialConfig","data":{"title":"CredentialConfig","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["aws"]}}},{"$ref":"#/components/schemas/AwsCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["aws_role"]}}},{"$ref":"#/components/schemas/AwsRoleCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["token"]}}},{"$ref":"#/components/schemas/TokenCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["basic"]}}},{"$ref":"#/components/schemas/BasicCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["secret"]}}},{"$ref":"#/components/schemas/SecretCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["o_auth_client"]}}},{"$ref":"#/components/schemas/OAuthClientCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["tls_certificate"]}}},{"$ref":"#/components/schemas/TlsCertificateCredential"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["o_auth_code"]}}},{"$ref":"#/components/schemas/OAuthCodeCredential"}],"required":["type"]}]}},"components/schemas/CredentialBase":{"id":"components/schemas/CredentialBase","kind":"json-schema","title":"CredentialBase","data":{"title":"CredentialBase","type":"object","description":"Base type for all credential types","properties":{}}},"components/schemas/AwsRoleCredential":{"id":"components/schemas/AwsRoleCredential","kind":"json-schema","title":"AWS Role","data":{"title":"AWS Role","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS Role configuration to authenticate with AWS. Delegated access with AWS Roles are used to create short-term credentials to access AWS resources in the destination AWS account. You can review "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this guide on delegating access across AWS accounts using IAM roles"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"role_arn":{"type":"string","description":"ARN of the AWS role to assume in the destination account.","title":"Role ARN"},"external_id":{"type":"string","description":"External ID to use when assuming the AWS role in the destination account.","title":"External ID"},"role_session_name":{"type":"string","nullable":true,"description":"Name of the AWS role session.","title":"Role Session Name"},"duration":{"type":"integer","nullable":true,"description":"The duration, in seconds, of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour.","title":"Duration"}},"required":["role_arn","external_id"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/AwsCredential":{"id":"components/schemas/AwsCredential","kind":"json-schema","title":"AWS Access Keys","data":{"title":"AWS Access Keys","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Access key to authenticate with AWS. Access keys are long-term credentials for an IAM user and consist of an Access Key ID and a Secret Access Key. Follow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this guide to generate credentials"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"You may optionally provide a session token if you are using temporary credentials."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"access_key_id":{"type":"string","description":"Access Key ID portion of the AWS access key pair.","title":"Access Key ID"},"secret_access_key":{"type":"string","description":"Secret portion of the AWS access key pair.","title":"Secret Access Key","format":"password"},"session":{"type":"string","nullable":true,"description":"A temporary session token. Session tokens are optional and are only necessary if you are using temporary credentials.","title":"Session","format":"password"}},"required":["access_key_id","secret_access_key"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/TokenCredential":{"id":"components/schemas/TokenCredential","kind":"json-schema","title":"Token","data":{"title":"Token","type":"object","description":"Token used to authenticate with an external service.","properties":{"secret":{"type":"string","description":"Secret value of the token.","title":"Secret","format":"password"}},"required":["secret"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/BasicCredential":{"id":"components/schemas/BasicCredential","kind":"json-schema","title":"Basic Credentials","data":{"title":"Basic Credentials","type":"object","description":"Username and secret used to authenticate with an external service.","properties":{"username":{"type":"string","description":"Username value for authentication","title":"Username"},"secret":{"type":"string","description":"Secret value for authentication","title":"Secret","format":"password"}},"required":["username","secret"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/SecretCredential":{"id":"components/schemas/SecretCredential","kind":"json-schema","title":"Secret","data":{"title":"Secret","type":"object","description":"Secret value such as password or webhook url","properties":{"secret":{"type":"string","description":"Secret value","title":"Secret","format":"password"}},"required":["secret"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/OAuthClientCredential":{"id":"components/schemas/OAuthClientCredential","kind":"json-schema","title":"Client Credentials","data":{"title":"Client Credentials","type":"object","description":"A Client ID and secret used for authenticating with OAuth 2.0 compatible service using the client credentials grant.","properties":{"token_url":{"type":"string","nullable":true,"description":"Optional URL for the OAuth 2.0 token exchange if it can not be constructed based on provider configuration","title":"Token URL"},"client_id":{"type":"string","description":"The ID of the client application defined at the service provider","title":"Client ID"},"client_secret":{"type":"string","description":"Secret value for authentication","title":"Client Secret","format":"password"},"extra":{"type":"object","additionalProperties":true,"nullable":true,"description":"Optional connection specific JSON map data such as a signing key ID or organization ID","title":"Extra"}},"required":["client_id","client_secret"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/TlsCertificateCredential":{"id":"components/schemas/TlsCertificateCredential","kind":"json-schema","title":"Certificate and Private Key","data":{"title":"Certificate and Private Key","type":"object","description":"A PEM-encoded certificate and private key pair. Used for TLS client authentication (mutual TLS), server identity, or other cryptographic operations requiring a certificate with its associated private key.","properties":{"certificate":{"type":"string","description":"PEM-encoded certificate.","title":"Certificate"},"private_key":{"type":"string","description":"PEM-encoded private key corresponding to the certificate.","title":"Private Key","format":"password"},"extra":{"type":"object","additionalProperties":true,"nullable":true,"description":"Optional connection specific JSON map data such as the client ID the certificate authenticates","title":"Extra"}},"required":["certificate","private_key"],"allOf":[{"$ref":"#/components/schemas/CredentialBase"}]}},"components/schemas/OAuthCodeCredential":{"id":"components/schemas/OAuthCodeCredential","kind":"json-schema","title":"OAuth App Install","data":{"title":"OAuth App Install","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticates with an installed OAuth app instead of a client id and secret. The integration's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"oauth_app_install"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" reports the install's state."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{},"allOf":[{"$ref":"#/components/schemas/CredentialBase"}],"x-fern-availability":"in-development"}},"components/schemas/ListCredentialsResponse":{"id":"components/schemas/ListCredentialsResponse","kind":"json-schema","title":"ListCredentialsResponse","data":{"title":"ListCredentialsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CredentialResponse"}}},"required":["result"]}},"components/schemas/GetCredentialResponse":{"id":"components/schemas/GetCredentialResponse","kind":"json-schema","title":"GetCredentialResponse","data":{"title":"GetCredentialResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CredentialResponse"}},"required":["result"]}},"components/schemas/LookupCredentialResponse":{"id":"components/schemas/LookupCredentialResponse","kind":"json-schema","title":"LookupCredentialResponse","data":{"title":"LookupCredentialResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CredentialResponse"}},"required":["result"]}},"components/schemas/CreateCredentialRequest":{"id":"components/schemas/CreateCredentialRequest","kind":"json-schema","title":"CreateCredentialRequest","data":{"title":"CreateCredentialRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Credential (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to CredentialId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Credential, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"config":{"$ref":"#/components/schemas/CredentialConfig","nullable":true,"description":"Credential configuration"},"owner_type":{"$ref":"#/components/schemas/OwnerType","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"One of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_point"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"expires":{"type":"string","format":"date-time","nullable":true,"description":"Time when this credential expires and can no longer be used again."}}}},"components/schemas/CreateCredentialResponse":{"id":"components/schemas/CreateCredentialResponse","kind":"json-schema","title":"CreateCredentialResponse","data":{"title":"CreateCredentialResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CredentialResponse"}},"required":["result"]}},"components/schemas/UpdateCredentialRequest":{"id":"components/schemas/UpdateCredentialRequest","kind":"json-schema","title":"Credential","data":{"title":"Credential","type":"object","description":"Credential to access an integration. Each credential is owned by an Account, Integration, IntegrationPoint or OrganizationWebhook.","properties":{"id":{"$ref":"#/components/schemas/CredentialId"},"account_id":{"$ref":"#/components/schemas/AccountId","nullable":true,"description":"Account that manages this credential."},"integration_id":{"$ref":"#/components/schemas/IntegrationId","nullable":true,"description":"Integration associated with this credential."},"integration_point_id":{"$ref":"#/components/schemas/IntegrationPointId","nullable":true,"description":"Integration Point associated with this credential."},"organization_webhook_id":{"$ref":"#/components/schemas/WebhookId","nullable":true,"description":"Organization Webhook associated with this credential."},"owner_type":{"$ref":"#/components/schemas/OwnerType","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"One of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_point"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","description":"Human friendly display name for this Credential"},"config":{"$ref":"#/components/schemas/CredentialConfig","nullable":true,"description":"Credential configuration"},"expires":{"type":"string","format":"date-time","nullable":true,"description":"Time when this credential expires and can no longer be used again."},"managed":{"$ref":"#/components/schemas/ManagedType","description":"Field is set by the management process. Determines lifecycle and ownership of the credential."}},"required":["id","owner_type","fullname","managed"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateCredentialResponse":{"id":"components/schemas/UpdateCredentialResponse","kind":"json-schema","title":"UpdateCredentialResponse","data":{"title":"UpdateCredentialResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CredentialResponse"}},"required":["result"]}},"components/schemas/PatchCredentialResponse":{"id":"components/schemas/PatchCredentialResponse","kind":"json-schema","title":"PatchCredentialResponse","data":{"title":"PatchCredentialResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CredentialResponse"}},"required":["result"]}},"components/schemas/IntegrationId":{"id":"components/schemas/IntegrationId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/IntegrationPointId":{"id":"components/schemas/IntegrationPointId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/IntegrationEnvironments":{"id":"components/schemas/IntegrationEnvironments","kind":"json-schema","title":"IntegrationEnvironments","data":{"title":"IntegrationEnvironments","type":"object","properties":{"test":{"type":"array","items":{"$ref":"#/components/schemas/ProviderConfigId"},"nullable":true,"description":"List of allowed providers for test environment."},"prod":{"type":"array","items":{"$ref":"#/components/schemas/ProviderConfigId"},"nullable":true,"description":"List of allowed providers for production environment."}}}},"components/schemas/AdditionalMappingType":{"id":"components/schemas/AdditionalMappingType","kind":"json-schema","title":"AdditionalMappingType","data":{"title":"AdditionalMappingType","type":"string","enum":["recommended","optional","fixed"]}},"components/schemas/AdditionalMappingTemplate":{"id":"components/schemas/AdditionalMappingTemplate","kind":"json-schema","title":"AdditionalMappingTemplate","data":{"title":"AdditionalMappingTemplate","type":"object","properties":{"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderConfigId"},"description":"A list of provider ID strings that this mapping applies to. Mapping templates must have at least one provider."},"mapping_type":{"$ref":"#/components/schemas/AdditionalMappingType","nullable":true,"description":"This controls the end-user's responsibility for this mapping when creating an integration in this integration point. Default: 'optional'.\nWhen set to 'fixed' the mapping is always included and can not be overridden by the end-user.\nWhen 'optional', the end-user can choose to override the mapping.\nWhen 'recommended', the provider will enter a warning state if the mapping is missing."}},"required":["providers"],"allOf":[{"$ref":"#/components/schemas/AdditionalMapping"}]}},"components/schemas/MappingChainTemplate":{"id":"components/schemas/MappingChainTemplate","kind":"json-schema","title":"MappingChainTemplate","data":{"title":"MappingChainTemplate","type":"object","properties":{"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderConfigId"},"description":"A list of provider ID strings that this mapping applies to. Mapping templates must have at least one provider."}},"required":["providers"],"allOf":[{"$ref":"#/components/schemas/MappingChain"}]}},"components/schemas/IntegrationPoint":{"id":"components/schemas/IntegrationPoint","kind":"json-schema","title":"IntegrationPoint","data":{"title":"IntegrationPoint","type":"object","description":"Enables creation, editing and deletion of Integrations.","properties":{"id":{"$ref":"#/components/schemas/IntegrationPointId"},"fullname":{"type":"string","nullable":true,"description":"Name of integration point, will be shown to end-users in the Connect UI."},"description":{"type":"string","nullable":true,"description":"Optional description of the Integration Point. Will not be displayed to end-users of Connect UI."},"connector":{"$ref":"#/components/schemas/CategoryId","description":"Connector to use for the Integration Point."},"environments":{"$ref":"#/components/schemas/IntegrationEnvironments","description":"Selects providers to use for account environments."},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MappingChainTemplate"},"nullable":true,"description":"A list of mapping chains to apply to integrations using this integration point. Each mapping chain is a list of mappings to apply to the integration in the order they should be applied. Mappings are applied by operation ID. If an integration is created that declares its own mappings for an operation, they will override this list of mappings. Leave this empty to use the default default mappings."},"additional_mappings":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalMappingTemplate"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional data mappings for integrations added to this integration point. This allows for custom data to be mapped to the custom_fields portion of the response."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduled_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationSchedule"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A creation template for integration scheduled operations. When an"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration is created without a non-empty scheduled_operations list,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this list is copied onto the integration and its operations are"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"scheduled from that snapshot. Updating or clearing this template never"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"changes integrations that already exist."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["id","connector","environments"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/ListIntegrationPointsResponse":{"id":"components/schemas/ListIntegrationPointsResponse","kind":"json-schema","title":"ListIntegrationPointsResponse","data":{"title":"ListIntegrationPointsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationPoint"}},"total":{"type":"integer","nullable":true}},"required":["result"]}},"components/schemas/GetIntegrationPointResponse":{"id":"components/schemas/GetIntegrationPointResponse","kind":"json-schema","title":"GetIntegrationPointResponse","data":{"title":"GetIntegrationPointResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/IntegrationPoint"}},"required":["result"]}},"components/schemas/CreateIntegrationPointRequest":{"id":"components/schemas/CreateIntegrationPointRequest","kind":"json-schema","title":"CreateIntegrationPointRequest","data":{"title":"CreateIntegrationPointRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Integration Point (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to IntegrationPointId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Name of integration point, will be shown to end-users in the Connect UI. Defaults to the same value as the 'name' field if not specified."},"description":{"type":"string","nullable":true,"description":"Optional description of the Integration Point. Will not be displayed to end-users of Connect UI."},"connector":{"$ref":"#/components/schemas/CategoryId","description":"Connector to use for the Integration Point."},"environments":{"$ref":"#/components/schemas/IntegrationEnvironments","description":"Selects providers to use for account environments."},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MappingChainTemplate"},"nullable":true,"description":"A list of mapping chains to apply to integrations using this integration point. Each mapping chain is a list of mappings to apply to the integration in the order they should be applied. Mappings are applied by operation ID. If an integration is created that declares its own mappings for an operation, they will override this list of mappings. Leave this empty to use the default default mappings."},"additional_mappings":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalMappingTemplate"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional data mappings for integrations added to this integration point. This allows for custom data to be mapped to the custom_fields portion of the response."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduled_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationSchedule"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A creation template for integration scheduled operations. When an"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration is created without a non-empty scheduled_operations list,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this list is copied onto the integration and its operations are"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"scheduled from that snapshot. Updating or clearing this template never"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"changes integrations that already exist."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["connector","environments"]}},"components/schemas/CreateIntegrationPointResponse":{"id":"components/schemas/CreateIntegrationPointResponse","kind":"json-schema","title":"CreateIntegrationPointResponse","data":{"title":"CreateIntegrationPointResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/IntegrationPoint"}},"required":["result"]}},"components/schemas/UpdateIntegrationPointRequest":{"id":"components/schemas/UpdateIntegrationPointRequest","kind":"json-schema","title":"IntegrationPoint","data":{"title":"IntegrationPoint","type":"object","description":"Enables creation, editing and deletion of Integrations.","properties":{"id":{"$ref":"#/components/schemas/IntegrationPointId"},"fullname":{"type":"string","nullable":true,"description":"Name of integration point, will be shown to end-users in the Connect UI."},"description":{"type":"string","nullable":true,"description":"Optional description of the Integration Point. Will not be displayed to end-users of Connect UI."},"connector":{"$ref":"#/components/schemas/CategoryId","description":"Connector to use for the Integration Point."},"environments":{"$ref":"#/components/schemas/IntegrationEnvironments","description":"Selects providers to use for account environments."},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MappingChainTemplate"},"nullable":true,"description":"A list of mapping chains to apply to integrations using this integration point. Each mapping chain is a list of mappings to apply to the integration in the order they should be applied. Mappings are applied by operation ID. If an integration is created that declares its own mappings for an operation, they will override this list of mappings. Leave this empty to use the default default mappings."},"additional_mappings":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalMappingTemplate"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional data mappings for integrations added to this integration point. This allows for custom data to be mapped to the custom_fields portion of the response."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduled_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationSchedule"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A creation template for integration scheduled operations. When an"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration is created without a non-empty scheduled_operations list,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this list is copied onto the integration and its operations are"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"scheduled from that snapshot. Updating or clearing this template never"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"changes integrations that already exist."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["id","connector","environments"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateIntegrationPointResponse":{"id":"components/schemas/UpdateIntegrationPointResponse","kind":"json-schema","title":"UpdateIntegrationPointResponse","data":{"title":"UpdateIntegrationPointResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/IntegrationPoint"}},"required":["result"]}},"components/schemas/PatchIntegrationPointResponse":{"id":"components/schemas/PatchIntegrationPointResponse","kind":"json-schema","title":"PatchIntegrationPointResponse","data":{"title":"PatchIntegrationPointResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/IntegrationPoint"}},"required":["result"]}},"components/schemas/ListIntegrationOptions":{"id":"components/schemas/ListIntegrationOptions","kind":"json-schema","title":"ListIntegrationOptions","data":{"title":"ListIntegrationOptions","type":"string","enum":["account","accounts","integration_point","integration_points","all"]}},"components/schemas/WebhookConfig":{"id":"components/schemas/WebhookConfig","kind":"json-schema","title":"WebhookConfig","data":{"title":"WebhookConfig","type":"object","properties":{"provider_key":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The key used by Synqly to verify incoming webhook payloads sent by the Provider. The format and requirements for this key is Provider specific:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ServiceNow"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":  Webhook payload signing is not currently supported, so the integrity of incoming ServiceNow payloads cannot be verified."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Jira"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Synqly does "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" automatically configure Jira webhooks. A user with administrator privileges must configure the webhook, including the signing key. If this key is not specified, Synqly will "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" validate incoming webhooks from Jira. It is strongly recommended that a key is specified and configured with Jira to ensure the integrity of incoming payloads."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookItem"},"description":"List of webhooks for an integration. If the provider supports webhooks, they will be sent to the servers provided in this list."}},"required":["items"]}},"components/schemas/WebhookItem":{"id":"components/schemas/WebhookItem","kind":"json-schema","title":"WebhookItem","data":{"title":"WebhookItem","type":"object","properties":{"webhook_url":{"type":"string","description":"Webhook URL. Events from providers will be sent to this URL."},"event_filter":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEvent"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If specified, only events matching this list will be sent to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"webhook_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". If no filters are specified, all events sent from providers will be forwarded to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"webhook_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"integrator_key":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The key used to sign outgoing web hook payloads. If not specified a random key is automatically generated."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use this key at the target URL to validate that the incoming payload was signed by Synqly. The payload is signed symmetrically with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integrator_key"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" using the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"HMAC-SHA256"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" signature scheme. The key should be randomly generated and between 24 bytes (192 bits) and 64 bytes (512 bits) long."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["webhook_url"]}},"components/schemas/Integration":{"id":"components/schemas/Integration","kind":"json-schema","title":"Integration","data":{"title":"Integration","type":"object","description":"Connects an Account to an external service","properties":{"id":{"$ref":"#/components/schemas/IntegrationId"},"fullname":{"type":"string","description":"Human friendly display name for this integration."},"refresh_token_id":{"$ref":"#/components/schemas/TokenId","description":"Integration refresh token id"},"account_id":{"$ref":"#/components/schemas/AccountId","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account associated with this integration. Use the expand=accounts parameter with the List and ListAccount APIs to expand the Account to the full object"},"children":[],"type":"text"}],"type":"paragraph"}]},"account":{"$ref":"#/components/schemas/Account","nullable":true,"description":"When using the expand option on the List or ListAccount APIs, the full account object is included in the response"},"category":{"$ref":"#/components/schemas/CategoryId","description":"Id of the Connector Category for this Integration."},"provider_config":{"$ref":"#/components/schemas/ProviderConfig","description":"Provider configuration for this Integration."},"provider_fullname":{"type":"string","description":"Human friendly display name for the provider."},"provider_type":{"type":"string","description":"Type of the provider for this Integration."},"integration_point_id":{"$ref":"#/components/schemas/IntegrationPointId","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration Point associated with this integration. Use the expand=integration_points parameter with the List and ListAccount APIs to expand the Integration Point to the full object"},"children":[],"type":"text"}],"type":"paragraph"}]},"integration_point":{"$ref":"#/components/schemas/IntegrationPoint","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When using the expand option on the List or ListAccount APIs, the full integration_point object is included in the response"},"children":[],"type":"text"}],"type":"paragraph"}]},"bridge_selector":{"$ref":"#/components/schemas/BridgeSelector","nullable":true,"description":"Use a Bridge to connect to the provider."},"webhook_config":{"$ref":"#/components/schemas/WebhookConfig","nullable":true,"description":"Webhook configuration for this integration. Some providers support webhooks, and will allow end users providers to send events to a server for new or updated data."},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MappingChain"},"nullable":true,"description":"A list of mapping chains to apply to the integration. Each mapping chain is a list of mappings to apply to the integration in the order they should be applied. Mappings are applied by operation ID. Leave this empty to use the default default mappings."},"additional_mappings":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalMapping"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduled_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationSchedule"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Scheduled operations owned by this integration. During creation, a non-empty list is used as supplied; otherwise, the integration point's current scheduled_operations template is copied onto the integration, if present. The stored list is an independent snapshot: later changes to the integration point never affect it. Clearing this field from an existing integration removes its schedules and does not restore the integration point template. The integration does not require an integration point for these schedules to run."},"children":[],"type":"text"}],"type":"paragraph"}]},"oauth_app_install":{"$ref":"#/components/schemas/IntegrationOAuthAppInstall","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The OAuth app install this integration runs with. Present only when the provider config uses an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credential."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"in-development"}},"required":["id","fullname","refresh_token_id","account_id","category","provider_config","provider_fullname","provider_type"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/BridgeSelector":{"id":"components/schemas/BridgeSelector","kind":"json-schema","title":"BridgeSelector","data":{"title":"BridgeSelector","oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["id"]},"value":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["labels"]},"value":{"type":"array","items":{"type":"string"}}},"required":["type"]}]}},"components/schemas/ListIntegrationsResponse":{"id":"components/schemas/ListIntegrationsResponse","kind":"json-schema","title":"ListIntegrationsResponse","data":{"title":"ListIntegrationsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}},"total":{"type":"integer","nullable":true}},"required":["result"]}},"components/schemas/ListAccountIntegrationsResponse":{"id":"components/schemas/ListAccountIntegrationsResponse","kind":"json-schema","title":"ListAccountIntegrationsResponse","data":{"title":"ListAccountIntegrationsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}},"total":{"type":"integer","nullable":true}},"required":["result"]}},"components/schemas/GetIntegrationResponse":{"id":"components/schemas/GetIntegrationResponse","kind":"json-schema","title":"GetIntegrationResponse","data":{"title":"GetIntegrationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Integration"}},"required":["result"]}},"components/schemas/CreateIntegrationRequest":{"id":"components/schemas/CreateIntegrationRequest","kind":"json-schema","title":"CreateIntegrationRequest","data":{"title":"CreateIntegrationRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Integrations (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to IntegrationId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Integrations, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"provider_config":{"$ref":"#/components/schemas/ProviderConfig","description":"Provider configuration for this Integration."},"integration_point_id":{"$ref":"#/components/schemas/IntegrationPointId","nullable":true,"description":"Integration Point associated with this integration."},"bridge_selector":{"$ref":"#/components/schemas/BridgeSelector","nullable":true,"description":"Use a Bridge to connect to the provider."},"webhook_config":{"$ref":"#/components/schemas/WebhookConfig","nullable":true,"description":"Web hook config for this integration"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MappingChain"},"nullable":true,"description":"A list of mapping chains to apply to the integration. Each mapping chain is a list of mappings to apply to the integration in the order they should be applied. Mappings are applied by operation ID. Leave this empty to use the default default mappings."},"additional_mappings":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalMapping"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduled_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationSchedule"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Scheduled operations owned by this integration. During creation, a non-empty list is used as supplied; otherwise, the integration point's current scheduled_operations template is copied onto the integration, if present. The stored list is an independent snapshot: later changes to the integration point never affect it. Clearing this field from an existing integration removes its schedules and does not restore the integration point template. The integration does not require an integration point for these schedules to run."},"children":[],"type":"text"}],"type":"paragraph"}]},"oauth_app_return_url":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Where the administrator's browser goes when the install that "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"oauth_app_authorization_link"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" starts finishes. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"return_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" on Authorize Integration. Only for a provider config that uses an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credential."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"in-development"}},"required":["provider_config"]}},"components/schemas/CreateIntegrationResponseResult":{"id":"components/schemas/CreateIntegrationResponseResult","kind":"json-schema","title":"CreateIntegrationResponseResult","data":{"title":"CreateIntegrationResponseResult","type":"object","properties":{"credentials_created":{"type":"array","items":{"$ref":"#/components/schemas/CredentialResponse"},"nullable":true},"integration":{"$ref":"#/components/schemas/Integration"},"token":{"$ref":"#/components/schemas/TokenPair"},"oauth_app_authorization_link":{"$ref":"#/components/schemas/OAuthAppAuthorizationLink","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Link to install the OAuth app. It can be opened once, within 10 minutes. Present only when the provider config uses an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credential."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"in-development"}},"required":["integration","token"]}},"components/schemas/AuthorizeIntegrationRequest":{"id":"components/schemas/AuthorizeIntegrationRequest","kind":"json-schema","title":"AuthorizeIntegrationRequest","data":{"title":"AuthorizeIntegrationRequest","type":"object","properties":{"return_url":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Where the administrator's browser goes when the install finishes. An"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"absolute "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"https"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URL without a fragment, on an origin listed in the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organization's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"options.oauth_app_return_origins"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"deployment's result page. Defaults to the deployment's result page."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The browser arrives with the query parameters "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"authorized"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"canceled"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"error"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". On "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"error"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" it also gets"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"reason"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"vendor_instance_mismatch"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the administrator consented or signed in"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"to a different vendor instance, such as another tenant, than the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"one the integration names or is installed in."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"role_missing"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the account the administrator signed in with does"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not hold a role that can install the app."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"verification_failed"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the vendor accepted the consent, but the app"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"could not yet be confirmed to work in the vendor instance. Vendors"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"can take a few minutes to apply a consent; try again later with a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"new link."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"vendor_error"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the vendor reported an error or an unexpected"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"response. Try again with a new link."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not_configured"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the OAuth app is not available on this"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"deployment."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"integration_unavailable"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the integration was deleted, or its"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"credential changed, while the install was in progress."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"New reasons may be added, so treat an unknown reason as a generic"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"failure. The outcome is also on the integration's"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"oauth_app_install.state"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and in the integration update webhook."},"children":[],"type":"text"}],"type":"paragraph"}]}},"x-fern-availability":"in-development"}},"components/schemas/AuthorizeIntegrationResponse":{"id":"components/schemas/AuthorizeIntegrationResponse","kind":"json-schema","title":"AuthorizeIntegrationResponse","data":{"title":"AuthorizeIntegrationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/AuthorizeIntegrationResult"}},"required":["result"],"x-fern-availability":"in-development"}},"components/schemas/AuthorizeIntegrationResult":{"id":"components/schemas/AuthorizeIntegrationResult","kind":"json-schema","title":"AuthorizeIntegrationResult","data":{"title":"AuthorizeIntegrationResult","type":"object","properties":{"authorization_link":{"$ref":"#/components/schemas/OAuthAppAuthorizationLink","description":"Link to install the OAuth app. It can be opened once, within 10 minutes."}},"required":["authorization_link"],"x-fern-availability":"in-development"}},"components/schemas/IntegrationMessagesResponse":{"id":"components/schemas/IntegrationMessagesResponse","kind":"json-schema","title":"IntegrationMessagesResponse","data":{"title":"IntegrationMessagesResponse","type":"object","properties":{"problems":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true,"description":"Warnings or issues that occurred during integration creation or verification that did not prevent the request from returning, but may indicate a problem with the integration configuration."}}}},"components/schemas/CreateIntegrationResponse":{"id":"components/schemas/CreateIntegrationResponse","kind":"json-schema","title":"CreateIntegrationResponse","data":{"title":"CreateIntegrationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CreateIntegrationResponseResult"},"messages":{"$ref":"#/components/schemas/IntegrationMessagesResponse","nullable":true,"description":"Warnings or issues that occurred during integration creation, such as authentication failures or invalid custom field mappings."}},"required":["result"]}},"components/schemas/UpdateIntegrationRequest":{"id":"components/schemas/UpdateIntegrationRequest","kind":"json-schema","title":"Integration","data":{"title":"Integration","type":"object","description":"Connects an Account to an external service","properties":{"id":{"$ref":"#/components/schemas/IntegrationId"},"fullname":{"type":"string","description":"Human friendly display name for this integration."},"refresh_token_id":{"$ref":"#/components/schemas/TokenId","description":"Integration refresh token id"},"account_id":{"$ref":"#/components/schemas/AccountId","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account associated with this integration. Use the expand=accounts parameter with the List and ListAccount APIs to expand the Account to the full object"},"children":[],"type":"text"}],"type":"paragraph"}]},"account":{"$ref":"#/components/schemas/Account","nullable":true,"description":"When using the expand option on the List or ListAccount APIs, the full account object is included in the response"},"category":{"$ref":"#/components/schemas/CategoryId","description":"Id of the Connector Category for this Integration."},"provider_config":{"$ref":"#/components/schemas/ProviderConfig","description":"Provider configuration for this Integration."},"provider_fullname":{"type":"string","description":"Human friendly display name for the provider."},"provider_type":{"type":"string","description":"Type of the provider for this Integration."},"integration_point_id":{"$ref":"#/components/schemas/IntegrationPointId","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration Point associated with this integration. Use the expand=integration_points parameter with the List and ListAccount APIs to expand the Integration Point to the full object"},"children":[],"type":"text"}],"type":"paragraph"}]},"integration_point":{"$ref":"#/components/schemas/IntegrationPoint","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When using the expand option on the List or ListAccount APIs, the full integration_point object is included in the response"},"children":[],"type":"text"}],"type":"paragraph"}]},"bridge_selector":{"$ref":"#/components/schemas/BridgeSelector","nullable":true,"description":"Use a Bridge to connect to the provider."},"webhook_config":{"$ref":"#/components/schemas/WebhookConfig","nullable":true,"description":"Webhook configuration for this integration. Some providers support webhooks, and will allow end users providers to send events to a server for new or updated data."},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MappingChain"},"nullable":true,"description":"A list of mapping chains to apply to the integration. Each mapping chain is a list of mappings to apply to the integration in the order they should be applied. Mappings are applied by operation ID. Leave this empty to use the default default mappings."},"additional_mappings":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalMapping"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduled_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationSchedule"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Scheduled operations owned by this integration. During creation, a non-empty list is used as supplied; otherwise, the integration point's current scheduled_operations template is copied onto the integration, if present. The stored list is an independent snapshot: later changes to the integration point never affect it. Clearing this field from an existing integration removes its schedules and does not restore the integration point template. The integration does not require an integration point for these schedules to run."},"children":[],"type":"text"}],"type":"paragraph"}]},"oauth_app_install":{"$ref":"#/components/schemas/IntegrationOAuthAppInstall","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The OAuth app install this integration runs with. Present only when the provider config uses an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credential."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"in-development"}},"required":["id","fullname","refresh_token_id","account_id","category","provider_config","provider_fullname","provider_type"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateIntegrationResponse":{"id":"components/schemas/UpdateIntegrationResponse","kind":"json-schema","title":"UpdateIntegrationResponse","data":{"title":"UpdateIntegrationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Integration"},"credentials_created":{"type":"array","items":{"$ref":"#/components/schemas/CredentialResponse"},"nullable":true,"description":"Credentials created and attached to the integration as a result of this update. Populated only when the request added a credential to an integration that previously had none; empty otherwise."},"messages":{"$ref":"#/components/schemas/IntegrationMessagesResponse","nullable":true,"description":"Warnings or issues that occurred during the update that did not prevent it from succeeding, such as a scheduled operation frequency that was automatically raised to a supported minimum."}},"required":["result"]}},"components/schemas/PatchIntegrationResponse":{"id":"components/schemas/PatchIntegrationResponse","kind":"json-schema","title":"PatchIntegrationResponse","data":{"title":"PatchIntegrationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Integration"},"credentials_created":{"type":"array","items":{"$ref":"#/components/schemas/CredentialResponse"},"nullable":true,"description":"Credentials created and attached to the integration as a result of this patch. Populated only when the request added a credential to an integration that previously had none; empty otherwise."},"messages":{"$ref":"#/components/schemas/IntegrationMessagesResponse","nullable":true,"description":"Warnings or issues that occurred during the patch that did not prevent it from succeeding, such as a scheduled operation frequency that was automatically raised to a supported minimum."}},"required":["result"]}},"components/schemas/VerifyIntegrationRequest":{"id":"components/schemas/VerifyIntegrationRequest","kind":"json-schema","title":"VerifyIntegrationRequest","data":{"title":"VerifyIntegrationRequest","type":"object","properties":{"integration":{"$ref":"#/components/schemas/CreateIntegrationRequest"}},"required":["integration"]}},"components/schemas/VerifyIntegrationResponse":{"id":"components/schemas/VerifyIntegrationResponse","kind":"json-schema","title":"VerifyIntegrationResponse","data":{"title":"VerifyIntegrationResponse","type":"object","properties":{"messages":{"$ref":"#/components/schemas/IntegrationMessagesResponse","nullable":true,"description":"Warnings or issues that occurred during integration verification, such as invalid provider configuration fields. Omitted when there are no warnings."}}}},"components/schemas/MappingDataType":{"id":"components/schemas/MappingDataType","kind":"json-schema","title":"MappingDataType","data":{"title":"MappingDataType","type":"string","enum":["string","number","datetime","boolean","array","any"]}},"components/schemas/AdditionalMapping":{"id":"components/schemas/AdditionalMapping","kind":"json-schema","title":"AdditionalMapping","data":{"title":"AdditionalMapping","type":"object","properties":{"resource":{"$ref":"#/components/schemas/ResourceId","description":"The resources that this mapping applies to."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/ActionId"},"description":"The actions that this mapping applies to. At least one action must be specified."},"source":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The dot-separated path to the field in the source data coming from the provider. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\\."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to escape literal dots in the field name."},"children":[],"type":"text"}],"type":"paragraph"}]},"destination":{"type":"string","description":"The dot-separated path to where the data should reside in the custom fields object when data is returned from the provider."},"literal":{"type":"boolean","nullable":true,"description":"When true, the value in 'source' is treated as a literal value rather than a mapping. This allows adding static values to custom fields. Default: false"},"data_type":{"$ref":"#/components/schemas/MappingDataType","description":"The data type of the field. This ensures the data is processed to the correct type when mapping. Fields set to 'any' will not get validated\nor processed. Other types are cast depending as defined by each provider. For example, a field with 'datetime' is parsed based on the date\nformat used by the provider, and normalized to a unix timestamp with millisecond precision."}},"required":["resource","actions","source","destination","data_type"]}},"components/schemas/MappingChain":{"id":"components/schemas/MappingChain","kind":"json-schema","title":"MappingChain","data":{"title":"MappingChain","type":"object","properties":{"mappings":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A list of mapping IDs to apply in the format "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{mapping_id}:{version}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"operation_ids":{"type":"array","items":{"type":"string"},"description":"The operation IDs to apply the mappings to."}},"required":["mappings","operation_ids"]}},"components/schemas/MappingId":{"id":"components/schemas/MappingId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/MappingBase":{"id":"components/schemas/MappingBase","kind":"json-schema","title":"MappingBase","data":{"title":"MappingBase","type":"object","properties":{"id":{"$ref":"#/components/schemas/MappingId"},"fullname":{"type":"string","description":"Human friendly display name for this mapping."},"organization_id":{"$ref":"#/components/schemas/OrganizationId","description":"Organization that manages this Mapping."}},"required":["id","fullname","organization_id"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/Mapping":{"id":"components/schemas/Mapping","kind":"json-schema","title":"Mapping","data":{"title":"Mapping","type":"object","properties":{"data":{"type":"string","description":"transform to apply."}},"required":["data"],"allOf":[{"$ref":"#/components/schemas/MappingBase"}]}},"components/schemas/ListMappingsResponse":{"id":"components/schemas/ListMappingsResponse","kind":"json-schema","title":"ListMappingsResponse","data":{"title":"ListMappingsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/MappingBase"}},"total":{"type":"integer","nullable":true}},"required":["result"]}},"components/schemas/GetMappingResponse":{"id":"components/schemas/GetMappingResponse","kind":"json-schema","title":"GetMappingResponse","data":{"title":"GetMappingResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Mapping"}},"required":["result"]}},"components/schemas/CreateMappingRequest":{"id":"components/schemas/CreateMappingRequest","kind":"json-schema","title":"CreateMappingRequest","data":{"title":"CreateMappingRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Mapping (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to MappingId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Mapping, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"data":{"type":"string","description":"transform to apply."}},"required":["data"]}},"components/schemas/CreateMappingResponseResult":{"id":"components/schemas/CreateMappingResponseResult","kind":"json-schema","title":"CreateMappingResponseResult","data":{"title":"CreateMappingResponseResult","type":"object","properties":{"mapping":{"$ref":"#/components/schemas/Mapping"}},"required":["mapping"]}},"components/schemas/CreateMappingResponse":{"id":"components/schemas/CreateMappingResponse","kind":"json-schema","title":"CreateMappingResponse","data":{"title":"CreateMappingResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CreateMappingResponseResult"}},"required":["result"]}},"components/schemas/UpdateMappingRequest":{"id":"components/schemas/UpdateMappingRequest","kind":"json-schema","title":"Mapping","data":{"title":"Mapping","type":"object","properties":{"data":{"type":"string","description":"transform to apply."}},"required":["data"],"allOf":[{"$ref":"#/components/schemas/MappingBase"}]}},"components/schemas/UpdateMappingResponse":{"id":"components/schemas/UpdateMappingResponse","kind":"json-schema","title":"UpdateMappingResponse","data":{"title":"UpdateMappingResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Mapping"}},"required":["result"]}},"components/schemas/PatchMappingResponse":{"id":"components/schemas/PatchMappingResponse","kind":"json-schema","title":"PatchMappingResponse","data":{"title":"PatchMappingResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Mapping"}},"required":["result"]}},"components/schemas/ApplyMappingRequestBody":{"id":"components/schemas/ApplyMappingRequestBody","kind":"json-schema","title":"ApplyMappingRequestBody","data":{"title":"ApplyMappingRequestBody","type":"object","properties":{"mappings":{"type":"array","items":{"type":"string"},"description":"List of mappings to utilize. This can include custom mappings you have defined as well as Synqly built-in mappings."},"data":{"type":"object","additionalProperties":true,"description":"JSON input data to apply the mapping chain to."}},"required":["mappings","data"]}},"components/schemas/ApplyMappingResponseResult":{"id":"components/schemas/ApplyMappingResponseResult","kind":"json-schema","title":"ApplyMappingResponseResult","data":{"title":"ApplyMappingResponseResult","type":"object","properties":{"mapping":{"type":"object","additionalProperties":true,"description":"The JSON object resulting from applying the mapping chain defined by the request over the input data."}},"required":["mapping"]}},"components/schemas/ApplyMappingResponse":{"id":"components/schemas/ApplyMappingResponse","kind":"json-schema","title":"ApplyMappingResponse","data":{"title":"ApplyMappingResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/ApplyMappingResponseResult"}},"required":["result"]}},"components/schemas/MemberId":{"id":"components/schemas/MemberId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/MemberType":{"id":"components/schemas/MemberType","kind":"json-schema","title":"MemberType","data":{"title":"MemberType","type":"string","enum":["personal","service"]}},"components/schemas/State":{"id":"components/schemas/State","kind":"json-schema","title":"State","data":{"title":"State","type":"string","enum":["disabled","enabled","forgotten","invited","locked"]}},"components/schemas/Options":{"id":"components/schemas/Options","kind":"json-schema","title":"Options","data":{"title":"Options","type":"string","enum":["disabled","expired","forgotten","invited","locked"]}},"components/schemas/Member":{"id":"components/schemas/Member","kind":"json-schema","title":"Member","data":{"title":"Member","type":"object","properties":{"id":{"$ref":"#/components/schemas/MemberId"},"state":{"$ref":"#/components/schemas/State"},"last_logon":{"type":"string","format":"date-time","description":"Last logon time"},"fullname":{"type":"string","description":"User's full display name."},"nickname":{"type":"string","nullable":true,"description":"User's nickname"},"picture":{"type":"string","nullable":true,"description":"Url of user's picture"},"ttl":{"type":"string"},"token_ttl":{"type":"string"},"expires":{"type":"string","format":"date-time"},"pin_expires":{"type":"string","format":"date-time"},"role_binding":{"type":"array","items":{"$ref":"#/components/schemas/RoleName"},"description":"Roles granted to this member. Tokens inherit this access."},"type":{"$ref":"#/components/schemas/MemberType"}},"required":["id","state","last_logon","fullname","ttl","token_ttl","expires","pin_expires","role_binding","type"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/MemberOptions":{"id":"components/schemas/MemberOptions","kind":"json-schema","title":"MemberOptions","data":{"title":"MemberOptions","type":"object","properties":{"ttl":{"type":"string","nullable":true,"description":"Optional member time-to-live duration. After a member expires, system requires a change password to re-enable member. Minimum 1 day, Maximum 10 years. Defaults to 10 years."},"options":{"type":"array","items":{"$ref":"#/components/schemas/Options"},"nullable":true,"description":"Options: \"expired\" will force change password on first logon."},"token_ttl":{"type":"string","nullable":true,"description":"Optional token time-to-live duration. Tokens are created for this member with this duration as their TTL. Minimum 1 minute. For personal accounts this is a maximum 24 hours and defaults to 1 hour. For service accounts this is a maximum 90 days and defaults to 1 hour."}}}},"components/schemas/CreateMemberRequest":{"id":"components/schemas/CreateMemberRequest","kind":"json-schema","title":"CreateMemberRequest","data":{"title":"CreateMemberRequest","type":"object","properties":{"name":{"type":"string","description":"Name for this Member. For personal accounts this must be a unique email address. For service accounts this can be any unique identifier (e.g. \"ci-pipeline\"). Used for duplicate detection and default sort order."},"fullname":{"type":"string","nullable":true,"description":"User's full display name. Defaults to the same value as the 'name' field if not specified."},"nickname":{"type":"string","nullable":true,"description":"User's nickname"},"picture":{"type":"string","nullable":true,"description":"Url of user's picture"},"secret":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Member secret used to logon. Must be at least 8 characters long and fewer than 72 characters. There are no restrictions on the characters used; however, the secret must be sufficiently complex. It cannot be a common word, previously leaked password, or easily guessed sequences like "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"qwerty"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"12345"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"role_binding":{"type":"array","items":{"$ref":"#/components/schemas/RoleName"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Roles granted to this member. Tokens inherit this access. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"member"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"options":{"$ref":"#/components/schemas/MemberOptions","nullable":true},"type":{"$ref":"#/components/schemas/MemberType","nullable":true,"description":"Member type. Defaults to 'personal' if not specified."}},"required":["name","secret"]}},"components/schemas/CreateMemberResponseResult":{"id":"components/schemas/CreateMemberResponseResult","kind":"json-schema","title":"CreateMemberResponseResult","data":{"title":"CreateMemberResponseResult","type":"object","properties":{"member":{"$ref":"#/components/schemas/Member"}},"required":["member"]}},"components/schemas/CreateMemberResponse":{"id":"components/schemas/CreateMemberResponse","kind":"json-schema","title":"CreateMemberResponse","data":{"title":"CreateMemberResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CreateMemberResponseResult"}},"required":["result"]}},"components/schemas/ListMembersResponse":{"id":"components/schemas/ListMembersResponse","kind":"json-schema","title":"ListMembersResponse","data":{"title":"ListMembersResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Member"}}},"required":["result"]}},"components/schemas/GetMemberResponse":{"id":"components/schemas/GetMemberResponse","kind":"json-schema","title":"GetMemberResponse","data":{"title":"GetMemberResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Member"}},"required":["result"]}},"components/schemas/UpdateMemberRequest":{"id":"components/schemas/UpdateMemberRequest","kind":"json-schema","title":"Member","data":{"title":"Member","type":"object","properties":{"id":{"$ref":"#/components/schemas/MemberId"},"state":{"$ref":"#/components/schemas/State"},"last_logon":{"type":"string","format":"date-time","description":"Last logon time"},"fullname":{"type":"string","description":"User's full display name."},"nickname":{"type":"string","nullable":true,"description":"User's nickname"},"picture":{"type":"string","nullable":true,"description":"Url of user's picture"},"ttl":{"type":"string"},"token_ttl":{"type":"string"},"expires":{"type":"string","format":"date-time"},"pin_expires":{"type":"string","format":"date-time"},"role_binding":{"type":"array","items":{"$ref":"#/components/schemas/RoleName"},"description":"Roles granted to this member. Tokens inherit this access."},"type":{"$ref":"#/components/schemas/MemberType"}},"required":["id","state","last_logon","fullname","ttl","token_ttl","expires","pin_expires","role_binding","type"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateMemberResponse":{"id":"components/schemas/UpdateMemberResponse","kind":"json-schema","title":"UpdateMemberResponse","data":{"title":"UpdateMemberResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Member"}},"required":["result"]}},"components/schemas/PatchMemberResponse":{"id":"components/schemas/PatchMemberResponse","kind":"json-schema","title":"PatchMemberResponse","data":{"title":"PatchMemberResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Member"}},"required":["result"]}},"components/schemas/GetOpenApiSpecResponse":{"id":"components/schemas/GetOpenApiSpecResponse","kind":"json-schema","title":"GetOpenApiSpecResponse","data":{"title":"GetOpenApiSpecResponse"}},"components/schemas/OAuthAppSource":{"id":"components/schemas/OAuthAppSource","kind":"json-schema","title":"OAuthAppSource","data":{"title":"OAuthAppSource","type":"string","enum":["synqly","organization"],"description":"The source of the OAuth app an integration uses to authenticate with its provider.","x-fern-availability":"in-development"}},"components/schemas/OAuthAppInstallState":{"id":"components/schemas/OAuthAppInstallState","kind":"json-schema","title":"OAuthAppInstallState","data":{"title":"OAuthAppInstallState","type":"string","enum":["pending_authorization","active","needs_reconsent","revoked"],"description":"The state of an OAuth app install.","x-fern-availability":"in-development"}},"components/schemas/OAuthAppId":{"id":"components/schemas/OAuthAppId","kind":"json-schema","title":"OAuthAppId","data":{"title":"OAuthAppId","type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Identifier of an OAuth app. The apps Synqly provides have stable identifiers starting with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"synqly_"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"in-development"}},"components/schemas/OAuthAppReference":{"id":"components/schemas/OAuthAppReference","kind":"json-schema","title":"OAuthAppReference","data":{"title":"OAuthAppReference","type":"object","properties":{"source":{"$ref":"#/components/schemas/OAuthAppSource","description":"The source of the OAuth app."},"id":{"$ref":"#/components/schemas/OAuthAppId","description":"Identifier of the app."}},"required":["source","id"],"x-fern-availability":"in-development"}},"components/schemas/OAuthAppPermission":{"id":"components/schemas/OAuthAppPermission","kind":"json-schema","title":"OAuthAppPermission","data":{"title":"OAuthAppPermission","type":"object","description":"One permission an OAuth app is granted or requires, as the vendor grants it.","properties":{"kind":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The vendor's grant system and, for app roles, the API resource the permission is granted on: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"microsoft_graph_app_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (Microsoft Graph), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"defender_endpoint_app_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (Microsoft Defender for Endpoint) or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"defender_xdr_app_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (Microsoft Defender XDR). New kinds may be added."},"children":[],"type":"text"}],"type":"paragraph"}]},"value":{"type":"string","description":"The permission's name at that resource."}},"required":["kind","value"],"x-fern-availability":"in-development"}},"components/schemas/OAuthAppConsentedBy":{"id":"components/schemas/OAuthAppConsentedBy","kind":"json-schema","title":"OAuthAppConsentedBy","data":{"title":"OAuthAppConsentedBy","type":"object","properties":{"vendor_user_id":{"type":"string","description":"The vendor's identifier of the user who consented."},"name":{"type":"string","nullable":true,"description":"The user's sign-in name, when the vendor provides one."}},"required":["vendor_user_id"],"x-fern-availability":"in-development"}},"components/schemas/IntegrationOAuthAppInstall":{"id":"components/schemas/IntegrationOAuthAppInstall","kind":"json-schema","title":"IntegrationOAuthAppInstall","data":{"title":"IntegrationOAuthAppInstall","type":"object","description":"The install of an OAuth app that an integration uses to authenticate with its provider.","properties":{"app":{"$ref":"#/components/schemas/OAuthAppReference","description":"The OAuth app the integration uses to authenticate with its provider."},"state":{"$ref":"#/components/schemas/OAuthAppInstallState","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State of the install for this integration. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"needs_reconsent"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" depends on the permissions this integration's provider needs, so integrations sharing an install can differ."},"children":[],"type":"text"}],"type":"paragraph"}]},"install_id":{"type":"string","nullable":true,"description":"Identifier of the install this integration runs on, shared by every integration of the account in the same vendor instance. Absent until the integration is bound to an install."},"vendor_instance_id":{"type":"string","nullable":true,"description":"The vendor's identifier of what the app is installed into, as proven by the vendor during consent. Absent until the integration is bound to an install."},"consented_by":{"$ref":"#/components/schemas/OAuthAppConsentedBy","nullable":true,"description":"The user who completed the most recent consent."},"consented_at":{"type":"string","format":"date-time","nullable":true,"description":"When the most recent consent completed."},"granted_permissions":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAppPermission"},"nullable":true,"description":"Vendor permissions granted to the app. They are the install's, the same for every integration on it."},"missing_permissions":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAppPermission"},"nullable":true,"description":"Permissions this integration's provider requires that have not been granted to the app."},"last_checked_at":{"type":"string","format":"date-time","nullable":true,"description":"When Synqly last confirmed the install with the vendor."},"uninstall_instructions":{"type":"string","nullable":true,"description":"How to remove the app from the vendor. Deleting the integration does not remove it. Present once the app has been installed."}},"required":["app","state"],"x-fern-availability":"in-development"}},"components/schemas/OAuthAppAuthorizationLink":{"id":"components/schemas/OAuthAppAuthorizationLink","kind":"json-schema","title":"OAuthAppAuthorizationLink","data":{"title":"OAuthAppAuthorizationLink","type":"object","description":"A link to install the OAuth app. It can be opened once, within 10 minutes of being issued; after that, request a new link. Open it in the administrator's browser when it is issued rather than sending it to them.","properties":{"id":{"type":"string","description":"Identifier of the link."},"url":{"type":"string","description":"The link to open in the browser of the administrator installing the app."},"expires":{"type":"string","format":"date-time","description":"When the link expires, 10 minutes after it was issued."}},"required":["id","url","expires"],"x-fern-availability":"in-development"}},"components/schemas/OAuthAppInstall":{"id":"components/schemas/OAuthAppInstall","kind":"json-schema","title":"OAuthAppInstall","data":{"title":"OAuthAppInstall","type":"object","description":"An OAuth app installed in a vendor instance for an account.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Identifier of the install, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"install_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of the integrations on it."},"children":[],"type":"text"}],"type":"paragraph"}]},"app":{"$ref":"#/components/schemas/OAuthAppReference","description":"The OAuth app installed."},"vendor_instance_id":{"type":"string","description":"The vendor's identifier of what the app is installed into, as proven by the vendor during consent."},"state":{"$ref":"#/components/schemas/OAuthAppInstallState","description":"The state of the OAuth app install."},"granted_permissions":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAppPermission"},"description":"Vendor permissions granted to the app."},"consented_by":{"$ref":"#/components/schemas/OAuthAppConsentedBy","nullable":true,"description":"The user who completed the most recent consent."},"consented_at":{"type":"string","format":"date-time","nullable":true,"description":"When the most recent consent completed."},"last_checked_at":{"type":"string","format":"date-time","nullable":true,"description":"When Synqly last confirmed the install with the vendor."},"integration_ids":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationId"},"description":"The ids of the integrations that use this install."}},"required":["id","app","vendor_instance_id","state","granted_permissions","integration_ids"],"x-fern-availability":"in-development"}},"components/schemas/ListOAuthAppInstallsResponse":{"id":"components/schemas/ListOAuthAppInstallsResponse","kind":"json-schema","title":"ListOAuthAppInstallsResponse","data":{"title":"ListOAuthAppInstallsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAppInstall"}}},"required":["result"]}},"components/schemas/AsyncOperationRequestId":{"id":"components/schemas/AsyncOperationRequestId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/OperationInput":{"id":"components/schemas/OperationInput","kind":"json-schema","title":"OperationInput","data":{"title":"OperationInput","type":"object","properties":{"filters":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Limit the number of results returned by the operation. If not specified, the operation will return all results."},"limit":{"type":"integer","nullable":true,"description":"Limit query results by these filters."}}}},"components/schemas/Operation":{"id":"components/schemas/Operation","kind":"json-schema","title":"Operation","data":{"title":"Operation","type":"object","properties":{"id":{"$ref":"#/components/schemas/AsyncOperationRequestId","description":"ID of the operation"},"created_at":{"type":"string","format":"date-time","description":"Time object was originally created"},"updated_at":{"type":"string","format":"date-time","description":"Last time object was updated"},"account_id":{"$ref":"#/components/schemas/Id","description":"Account ID containing the integration."},"integration_id":{"$ref":"#/components/schemas/Id","description":"Integration ID to use for the operation."},"operation":{"type":"string","description":"Name of the operation that will be run for this operation."},"input":{"$ref":"#/components/schemas/OperationInput","description":"Parameters for the operation that will be run for this operation."},"status":{"$ref":"#/components/schemas/OperationStatus","description":"Status of the operation"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/OperationError"},"nullable":true,"description":"Errors that occurred during the operation"},"cpu_time":{"type":"integer","format":"int64","description":"Cpu time in microseconds"},"in_bytes":{"type":"integer","format":"int64","description":"Total number of bytes sent to the output integration."},"output_integration_id":{"type":"string","nullable":true,"description":"ID of the integration receiving operation output."}},"required":["id","created_at","updated_at","account_id","integration_id","operation","input","status","cpu_time","in_bytes"]}},"components/schemas/OperationStatus":{"id":"components/schemas/OperationStatus","kind":"json-schema","title":"OperationStatus","data":{"title":"OperationStatus","type":"string","enum":["SCHEDULED","PROCESSING","CANCELLED","COMPLETE","DISABLED"]}},"components/schemas/OperationError":{"id":"components/schemas/OperationError","kind":"json-schema","title":"OperationError","data":{"title":"OperationError","type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}},"components/schemas/OperationExecutionEvent":{"id":"components/schemas/OperationExecutionEvent","kind":"json-schema","title":"OperationExecutionEvent","data":{"title":"OperationExecutionEvent","type":"object","description":"A single execution of an operation, capturing start time, completion time,\nand metrics for that specific run.","properties":{"execution_id":{"$ref":"#/components/schemas/Id","description":"Unique identifier for this execution"},"operation_id":{"$ref":"#/components/schemas/Id","description":"ID of the operation that was executed"},"started_at":{"type":"string","format":"date-time","description":"When this execution started"},"completed_at":{"type":"string","format":"date-time","description":"When this execution completed"},"account_id":{"$ref":"#/components/schemas/Id","description":"Account ID containing the integration"},"integration_id":{"$ref":"#/components/schemas/Id","description":"Integration ID used for the operation"},"integration_point_id":{"$ref":"#/components/schemas/Id","nullable":true,"description":"Integration-point ID if triggered by a schedule, omitted if manually triggered\nvia the API"},"operation":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Name of the operation (e.g., \"assets_query_devices\")"},"children":[],"type":"text"}],"type":"paragraph"}]},"trigger_type":{"$ref":"#/components/schemas/OperationTriggerType","description":"How this execution was triggered"},"trigger_source":{"type":"string","description":"Source of trigger - \"manual\" for API calls, integration-point ID for linked scheduled operations, or integration ID for point-less scheduled operations"},"status":{"$ref":"#/components/schemas/OperationStatus","description":"Final status of the execution"},"records_processed":{"type":"integer","format":"int64","description":"Approximate number of records processed"},"cpu_time":{"type":"integer","format":"int64","description":"CPU time in microseconds"},"in_bytes":{"type":"integer","format":"int64","description":"Number of bytes sent to sink integration"},"duration":{"type":"integer","format":"int64","description":"Total execution duration in microseconds"},"initial_cursor":{"type":"string","nullable":true,"description":"Cursor value at execution start"},"final_cursor":{"type":"string","nullable":true,"description":"Cursor value at execution completion"},"cursor_advanced_to":{"type":"string","format":"date-time","nullable":true,"description":"Maximum data timestamp persisted by this execution; omitted when this execution did not advance the incremental cursor"},"error":{"type":"string","nullable":true,"description":"Error message if execution failed"}},"required":["execution_id","operation_id","started_at","completed_at","account_id","integration_id","operation","trigger_type","trigger_source","status","records_processed","cpu_time","in_bytes","duration"]}},"components/schemas/OperationTriggerType":{"id":"components/schemas/OperationTriggerType","kind":"json-schema","title":"OperationTriggerType","data":{"title":"OperationTriggerType","type":"string","enum":["API","SCHEDULED"],"description":"How an operation execution was initiated"}},"components/schemas/ListExecutionHistoryResponse":{"id":"components/schemas/ListExecutionHistoryResponse","kind":"json-schema","title":"ListExecutionHistoryResponse","data":{"title":"ListExecutionHistoryResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/OperationExecutionEvent"},"description":"List of execution events"}},"required":["result"]}},"components/schemas/OperationId":{"id":"components/schemas/OperationId","kind":"json-schema","title":"OperationId","data":{"title":"OperationId","type":"string","enum":["appsec_create_findings","appsec_get_application_finding_details","appsec_query_application_findings","appsec_query_application_scans","appsec_query_applications","appsec_query_findings","assets_create_asset","assets_create_devices","assets_create_software","assets_get_labels","assets_query_alerts","assets_query_device_software","assets_query_devices","assets_query_software","assets_query_utilization","assets_query_vulnerabilities","assets_update_software","chat_create_direct_message","chat_create_message","chat_delete_message","chat_query_conversation_members","chat_query_conversation_messages","chat_query_conversations","chat_query_messages","chat_query_user_conversation_members","chat_query_user_conversation_messages","chat_query_user_conversations","chat_query_users","chat_update_message","cloudsecurity_query_cloud_resource_inventory","cloudsecurity_query_compliance_findings","cloudsecurity_query_events","cloudsecurity_query_ioms","cloudsecurity_query_threats","custom_delete","custom_get","custom_patch","custom_post","custom_post_batch","custom_query","edr_create_ioa","edr_create_iocs","edr_create_threat_note","edr_delete_ioa","edr_delete_iocs","edr_execute_command","edr_execute_remote_script","edr_get_endpoint","edr_get_threat_notes","edr_network_quarantine","edr_query_alerts","edr_query_applications","edr_query_edr_events","edr_query_endpoints","edr_query_exclusions","edr_query_ioa","edr_query_iocs","edr_query_policies","edr_query_posture_score","edr_query_threatevents","edr_retrieve_file","edr_update_alert","emailsecurity_get_threat_details","emailsecurity_query_email_events","emailsecurity_query_threats","endpointmanagement_get_device","endpointmanagement_lock_device","endpointmanagement_query_compliance_findings","endpointmanagement_query_device_applications","endpointmanagement_query_devices","endpointmanagement_remediate_device","endpointmanagement_restart_device","endpointmanagement_update_device","endpointmanagement_wipe_device","grc_get_control","grc_get_device","grc_get_personnel","grc_get_test","grc_query_controls","grc_query_devices","grc_query_evidence","grc_query_frameworks","grc_query_personnel","grc_query_tests","identity_disable_user","identity_enable_user","identity_expire_all_user_sessions","identity_force_user_password_reset","identity_get_group","identity_get_group_members","identity_get_user","identity_get_user_picture","identity_query_access_grants","identity_query_applications","identity_query_audit_log","identity_query_groups","identity_query_policies","identity_query_risk_events","identity_query_risky_users","identity_query_users","incidentresponse_query_escalation_policies","incidentresponse_query_escalation_policy_users_on_call","networksecurity_query_dns_events","networksecurity_query_dns_log_configurations","networksecurity_query_firewall_rules","networksecurity_query_traffic_events","networksecurity_query_traffic_log_configurations","notifications_clear_message","notifications_create_message","notifications_get_message","securityawareness_get_phishing_simulation_details","securityawareness_get_training_campaign_details","securityawareness_get_user_details","securityawareness_query_phishing_simulations","securityawareness_query_training_campaigns","securityawareness_query_users","siem_get_alert","siem_get_evidence","siem_get_investigation","siem_patch_investigation","siem_post_events","siem_query_alerts","siem_query_events","siem_query_investigations","siem_query_log_providers","siem_update_alert","sink_post_events","ssf_get_transmitter_urls","ssf_jwks","ssf_post_event","storage_delete_file","storage_download_file","storage_list_files","storage_upload_file","threatintel_lookup_domain","threatintel_lookup_hash","threatintel_lookup_ip","threatintel_lookup_url","ticketing_create_attachment","ticketing_create_comment","ticketing_create_note","ticketing_create_ticket","ticketing_delete_attachment","ticketing_delete_comment","ticketing_delete_note","ticketing_download_attachment","ticketing_get_ticket","ticketing_list_attachments_metadata","ticketing_list_comments","ticketing_list_issue_type_remote_fields","ticketing_list_issue_types","ticketing_list_notes","ticketing_list_on_call","ticketing_list_projects","ticketing_list_remote_fields","ticketing_patch_note","ticketing_patch_ticket","ticketing_query_escalation_policies","ticketing_query_tickets","vulnerabilities_create_asset","vulnerabilities_create_findings","vulnerabilities_get_labels","vulnerabilities_get_scan_activities","vulnerabilities_get_scan_activity","vulnerabilities_get_scan_status","vulnerabilities_query_assets","vulnerabilities_query_findings","vulnerabilities_query_scan_findings","vulnerabilities_query_scans","vulnerabilities_update_asset","vulnerabilities_update_finding","vulnerabilities_upload_scan"]}},"components/schemas/ScheduledOperationId":{"id":"components/schemas/ScheduledOperationId","kind":"json-schema","title":"ScheduledOperationId","data":{"title":"ScheduledOperationId","type":"string","enum":["assets_query_devices","assets_query_alerts","assets_query_utilization","assets_query_vulnerabilities","cloudsecurity_query_cloud_resource_inventory","cloudsecurity_query_compliance_findings","cloudsecurity_query_events","cloudsecurity_query_ioms","cloudsecurity_query_threats","edr_query_alerts","edr_query_applications","edr_query_endpoints","edr_query_iocs","edr_query_policies","edr_query_posture_score","edr_query_threatevents","emailsecurity_query_threats","emailsecurity_query_email_events","endpointmanagement_query_devices","endpointmanagement_query_compliance_findings","identity_query_access_grants","identity_query_applications","identity_query_audit_log","identity_query_groups","identity_query_groups_enriched","identity_query_policies","identity_query_risk_events","identity_query_users","identity_query_users_enriched","siem_query_events","siem_query_investigations","vulnerabilities_query_assets","vulnerabilities_query_findings","vulnerabilities_query_scans","appsec_query_findings"]}},"components/schemas/OperationSchedule":{"id":"components/schemas/OperationSchedule","kind":"json-schema","title":"OperationSchedule","data":{"title":"OperationSchedule","type":"object","properties":{"operation":{"$ref":"#/components/schemas/ScheduledOperationId","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID of the operation to schedule (e.g., query_alerts, query_endpoints)."},"children":[],"type":"text"}],"type":"paragraph"}]},"enabled":{"type":"boolean","description":"Whether the schedule is active. When false, no executions will occur."},"frequency":{"$ref":"#/components/schemas/OperationFrequency","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How often the operation should execute (e.g., every 4 hours)."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The minimum interval is 5 minutes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operations that run as full snapshots — because the operation has no"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"time filter, the provider does not support the operation's time"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"filter, or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"incremental_config.mode"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"full_snapshot"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" — have a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"minimum interval of 12 hours: every run re-fetches the complete data"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"set. A shorter frequency is automatically raised to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"12h"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"change is reported in the response "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"messages"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If an execution takes longer than the interval, the next execution"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"will start immediately after the previous one completes."},"children":[],"type":"text"}],"type":"paragraph"}]},"filters":{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional filters to apply when querying data from the source API."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Format and available filters depend on the specific operation."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: \"severity[eq]critical\" or \"status[eq]active\"."},"children":[],"type":"text"}],"type":"paragraph"}]},"backfill_from_time":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Starting point for the initial data collection. No data before this time will be fetched."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Accepts:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339 datetime: \"2024-01-01T00:00:00Z\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Relative duration: \"7d\" (7 days ago), \"24h\" (24 hours ago), \"30m\" (30 minutes ago)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"max\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": the maximum one-year backfill window, resolved relative to operation creation"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The resolved starting point may be at most 1 year in the past; deeper backfills are rejected."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If not specified, starts from the operation's creation time."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},"incremental_config":{"$ref":"#/components/schemas/OperationIncrementalPullConfig","nullable":true,"description":"Configuration for how data is fetched on each execution.\nBy default, operations fetch only data that changed since the last run (incremental)\nand the time filter used depends on the operation.\nUse this to override the default behavior or switch to full snapshots."}},"required":["operation","enabled","frequency"]}},"components/schemas/OperationFrequency":{"id":"components/schemas/OperationFrequency","kind":"json-schema","title":"OperationFrequency","data":{"title":"OperationFrequency","oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["periodic"]},"value":{"$ref":"#/components/schemas/OperationFrequencyPeriodic"}},"required":["type"]}]}},"components/schemas/OperationFrequencyPeriodic":{"id":"components/schemas/OperationFrequencyPeriodic","kind":"json-schema","title":"OperationFrequencyPeriodic","data":{"title":"OperationFrequencyPeriodic","type":"string","description":"Frequency of operation executions is defined by a periodic interval. Value is a string in the format \"4h\" (every 4 hours).\nYou may use \"m\" for minutes, \"h\" for hours, and \"d\" for days."}},"components/schemas/OperationIncrementalPullConfig":{"id":"components/schemas/OperationIncrementalPullConfig","kind":"json-schema","title":"OperationIncrementalPullConfig","data":{"title":"OperationIncrementalPullConfig","type":"object","description":"Controls how data is fetched from the source API on each execution.","properties":{"mode":{"$ref":"#/components/schemas/OperationIncrementalPullMode","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch strategy: incremental (only changed data) or full_snapshot (all data every time)."},"children":[],"type":"text"}],"type":"paragraph"}]},"time_filter_field":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom field to use for time-based filtering in incremental mode."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Overrides the operation's default time filter field."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Examples: \"modified_time\" or \"finding.last_seen_time\"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The comparison operator is operation-specific: \"[gt]\" (greater than)"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"by default, or \"[gte]\" (greater than or equal) for operations whose"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"providers only accept inclusive range bounds — in which case the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"boundary record is re-fetched on each run."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"First run will use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"initial_backfill_start_time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as the filter value, and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"subsequent runs use the last execution time."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["mode"]}},"components/schemas/OperationIncrementalPullMode":{"id":"components/schemas/OperationIncrementalPullMode","kind":"json-schema","title":"OperationIncrementalPullMode","data":{"title":"OperationIncrementalPullMode","type":"string","enum":["incremental","full_snapshot"],"description":"Strategy for fetching data from the source API."}},"components/schemas/ListOperationsResponse":{"id":"components/schemas/ListOperationsResponse","kind":"json-schema","title":"ListOperationsResponse","data":{"title":"ListOperationsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}},"required":["result"]}},"components/schemas/OrganizationId":{"id":"components/schemas/OrganizationId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/Environment":{"id":"components/schemas/Environment","kind":"json-schema","title":"Environment","data":{"title":"Environment","type":"string","enum":["test","prod"]}},"components/schemas/OrganizationType":{"id":"components/schemas/OrganizationType","kind":"json-schema","title":"OrganizationType","data":{"title":"OrganizationType","type":"string","enum":["root","standard"]}},"components/schemas/OrganizationState":{"id":"components/schemas/OrganizationState","kind":"json-schema","title":"OrganizationState","data":{"title":"OrganizationState","type":"string","enum":["enabled","disabled","pov","plg"],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Organization state. When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disabled"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", all management and engine API requests for the organization return HTTP 402. An organization with no state set is enabled. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"pov"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (sales-run proof-of-value evaluation) and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"plg"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (self-signup) carry an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_date"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"plg"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" organization behaves like "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disabled"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" after its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_date"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" passes (end-of-day UTC), while "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"pov"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" never blocks automatically."},"children":[],"type":"text"}],"type":"paragraph"}]}},"components/schemas/OrganizationOptions":{"id":"components/schemas/OrganizationOptions","kind":"json-schema","title":"OrganizationOptions","data":{"title":"OrganizationOptions","type":"object","properties":{"invite_duration":{"type":"string","nullable":true,"description":"Duration new member invitations will be valid. Default: 168h (7 days), minimum 24h, maximum 168h (7 days)."},"forgot_duration":{"type":"string","nullable":true,"description":"Duration forgotten password invitations will be valid. Default: 24h, minimum 24h, maximum 168h (7 days)."},"password_duration":{"type":"string","nullable":true,"description":"Duration before member password expires, part of required password rotation. Default: 4320h (180 days), minimum: 24h, maximum: 8760h (365 days)."},"minimum_password_length":{"type":"integer","nullable":true,"description":"Minimum password length. Default: 8, minimum 8, maximum 72."},"oauth_app_return_origins":{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Origins a caller may name in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"return_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an OAuth app authorization link ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"return_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" on Authorize Integration, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"oauth_app_return_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" on Create Integration). Each is a scheme, host and optional port, such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"https://app.example.com"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", with no path, query or fragment: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"https"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"http"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" only for localhost. A "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"return_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must match one exactly; the deployment's result page is always allowed."},"children":[],"type":"text"}],"type":"paragraph"}],"x-fern-availability":"in-development"},"credentials":{"$ref":"#/components/schemas/OrganizationCredentialOptions","nullable":true,"description":"Credential types this organization opts into.","x-fern-availability":"in-development"}}}},"components/schemas/OrganizationCredentialOptions":{"id":"components/schemas/OrganizationCredentialOptions","kind":"json-schema","title":"OrganizationCredentialOptions","data":{"title":"OrganizationCredentialOptions","type":"object","properties":{"o_auth_code":{"$ref":"#/components/schemas/OrganizationOptionState","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"enabled"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the Capabilities API includes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credential type in the provider configs that support it, for requests authenticated as this organization. When unset or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disabled"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" it is left out, so configuration forms built from the capabilities schema never see it. Only the Capabilities API reads this option."},"children":[],"type":"text"}],"type":"paragraph"}]}},"x-fern-availability":"in-development"}},"components/schemas/OrganizationOptionState":{"id":"components/schemas/OrganizationOptionState","kind":"json-schema","title":"OrganizationOptionState","data":{"title":"OrganizationOptionState","type":"string","enum":["enabled","disabled"],"x-fern-availability":"in-development"}},"components/schemas/Organization":{"id":"components/schemas/Organization","kind":"json-schema","title":"Organization","data":{"title":"Organization","type":"object","properties":{"id":{"$ref":"#/components/schemas/OrganizationId"},"refresh_token_id":{"$ref":"#/components/schemas/TokenId","description":"Organization refresh token id"},"organization_type":{"$ref":"#/components/schemas/OrganizationType","description":"Organization type: root or standard"},"fullname":{"type":"string","description":"Human friendly display name for this Organization"},"contact":{"type":"string","nullable":true,"description":"Organization email address"},"reply_to":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com"},"children":[],"type":"text"}],"type":"paragraph"}]},"picture":{"type":"string","nullable":true,"description":"Picture URL of the organization"},"options":{"$ref":"#/components/schemas/OrganizationOptions","nullable":true,"description":"Organization options"},"state":{"$ref":"#/components/schemas/OrganizationState","nullable":true,"description":"Organization state. Omitted when the organization is enabled. Can only be changed through the private organizations API."},"end_date":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Evaluation end date (YYYY-MM-DD, end-of-day UTC) for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"pov"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"plg"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" organizations. Omitted otherwise. Set together with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"state"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" through the private organizations API."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["id","refresh_token_id","organization_type","fullname"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/CreateOrganizationRequest":{"id":"components/schemas/CreateOrganizationRequest","kind":"json-schema","title":"CreateOrganizationRequest","data":{"title":"CreateOrganizationRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Organization (lowercase [a-z0-9_-], can be used in URLs). Used for case insensitive duplicate name detection and default sort order. Defaults to OrganizationId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Organization, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"contact":{"type":"string","nullable":true,"description":"Organization email address"},"reply_to":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com"},"children":[],"type":"text"}],"type":"paragraph"}]},"picture":{"type":"string","nullable":true,"description":"URL of the organization"},"member":{"$ref":"#/components/schemas/CreateMemberRequest","nullable":true,"description":"Create organization member"}}}},"components/schemas/CreateOrganizationResponseResult":{"id":"components/schemas/CreateOrganizationResponseResult","kind":"json-schema","title":"CreateOrganizationResponseResult","data":{"title":"CreateOrganizationResponseResult","type":"object","properties":{"member":{"$ref":"#/components/schemas/Member","nullable":true},"organization":{"$ref":"#/components/schemas/Organization"},"token":{"$ref":"#/components/schemas/TokenPair"}},"required":["organization","token"]}},"components/schemas/CreateOrganizationResponse":{"id":"components/schemas/CreateOrganizationResponse","kind":"json-schema","title":"CreateOrganizationResponse","data":{"title":"CreateOrganizationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/CreateOrganizationResponseResult"}},"required":["result"]}},"components/schemas/GetOrganizationResponse":{"id":"components/schemas/GetOrganizationResponse","kind":"json-schema","title":"GetOrganizationResponse","data":{"title":"GetOrganizationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Organization"}},"required":["result"]}},"components/schemas/ListOrganizationResponse":{"id":"components/schemas/ListOrganizationResponse","kind":"json-schema","title":"ListOrganizationResponse","data":{"title":"ListOrganizationResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}},"required":["result"]}},"components/schemas/WebhookId":{"id":"components/schemas/WebhookId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/WebhookFilter":{"id":"components/schemas/WebhookFilter","kind":"json-schema","title":"WebhookFilter","data":{"title":"WebhookFilter","type":"string","enum":["all","account_create","account_delete","account_update","integration_create","integration_delete","integration_update","operation_complete"]}},"components/schemas/WebhookEvent":{"id":"components/schemas/WebhookEvent","kind":"json-schema","title":"WebhookEvent","data":{"title":"WebhookEvent","type":"string","enum":["TicketCreated","TicketUpdated","TicketDeleted","TicketCommentCreated","TicketCommentDeleted"]}},"components/schemas/OrganizationWebhook":{"id":"components/schemas/OrganizationWebhook","kind":"json-schema","title":"OrganizationWebhook","data":{"title":"OrganizationWebhook","type":"object","properties":{"id":{"$ref":"#/components/schemas/WebhookId"},"fullname":{"type":"string","description":"Human friendly slug for this webhook"},"environment":{"$ref":"#/components/schemas/Environment","description":"Environment that the webhook is configured for. Only events associated with this environment will trigger the webhook."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/WebhookFilter"},"description":"Specifies which Webhooks to send."},"url":{"type":"string","description":"URL that webhooks will be sent to"},"credential_id":{"$ref":"#/components/schemas/CredentialId","description":"Credential contain secret"}},"required":["id","fullname","environment","filters","url","credential_id"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/OrganizationWebhookSecret":{"id":"components/schemas/OrganizationWebhookSecret","kind":"json-schema","title":"OrganizationWebhookSecret","data":{"title":"OrganizationWebhookSecret","type":"object","properties":{"value":{"type":"string","description":"Secret used for signing webhooks. This value is used to verify the authenticity of the webhook payload."},"expires":{"type":"string","format":"date-time","nullable":true,"description":"Time when this secret expires and can no longer be used again."}},"required":["value"]}},"components/schemas/CreateOrganizationWebhookRequest":{"id":"components/schemas/CreateOrganizationWebhookRequest","kind":"json-schema","title":"CreateOrganizationWebhookRequest","data":{"title":"CreateOrganizationWebhookRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":"Human friendly slug for this webhook"},"fullname":{"type":"string","nullable":true,"description":"Fullname for this webhook"},"environment":{"$ref":"#/components/schemas/Environment","nullable":true,"description":"Environment that the webhook is configured for. Only events for accounts associated with this environment will trigger the webhook."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/WebhookFilter"},"description":"Specifies which Webhooks to send."},"url":{"type":"string","description":"URL that webhooks will be sent to."},"secret":{"$ref":"#/components/schemas/OrganizationWebhookSecret","description":"Secret used for signing webhooks. This value is used to verify the authenticity of the webhook payload."}},"required":["filters","url","secret"]}},"components/schemas/CreateOrganizationWebhookResponse":{"id":"components/schemas/CreateOrganizationWebhookResponse","kind":"json-schema","title":"CreateOrganizationWebhookResponse","data":{"title":"CreateOrganizationWebhookResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/OrganizationWebhook","description":"The created webhook."}},"required":["result"]}},"components/schemas/GetOrganizationWebhookResponse":{"id":"components/schemas/GetOrganizationWebhookResponse","kind":"json-schema","title":"GetOrganizationWebhookResponse","data":{"title":"GetOrganizationWebhookResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/OrganizationWebhook"}},"required":["result"]}},"components/schemas/ListOrganizationWebhooksResponse":{"id":"components/schemas/ListOrganizationWebhooksResponse","kind":"json-schema","title":"ListOrganizationWebhooksResponse","data":{"title":"ListOrganizationWebhooksResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationWebhook"},"description":"List of webhooks for the organization."}},"required":["result"]}},"components/schemas/PatchOrganizationWebhookResponse":{"id":"components/schemas/PatchOrganizationWebhookResponse","kind":"json-schema","title":"PatchOrganizationWebhookResponse","data":{"title":"PatchOrganizationWebhookResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/OrganizationWebhook"}},"required":["result"]}},"components/schemas/UpdateOrganizationWebhookRequest":{"id":"components/schemas/UpdateOrganizationWebhookRequest","kind":"json-schema","title":"OrganizationWebhook","data":{"title":"OrganizationWebhook","type":"object","properties":{"id":{"$ref":"#/components/schemas/WebhookId"},"fullname":{"type":"string","description":"Human friendly slug for this webhook"},"environment":{"$ref":"#/components/schemas/Environment","description":"Environment that the webhook is configured for. Only events associated with this environment will trigger the webhook."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/WebhookFilter"},"description":"Specifies which Webhooks to send."},"url":{"type":"string","description":"URL that webhooks will be sent to"},"credential_id":{"$ref":"#/components/schemas/CredentialId","description":"Credential contain secret"}},"required":["id","fullname","environment","filters","url","credential_id"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateOrganizationWebhookResponse":{"id":"components/schemas/UpdateOrganizationWebhookResponse","kind":"json-schema","title":"UpdateOrganizationWebhookResponse","data":{"title":"UpdateOrganizationWebhookResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/OrganizationWebhook"}},"required":["result"]}},"components/schemas/UpdateOrganizationRequest":{"id":"components/schemas/UpdateOrganizationRequest","kind":"json-schema","title":"Organization","data":{"title":"Organization","type":"object","properties":{"id":{"$ref":"#/components/schemas/OrganizationId"},"refresh_token_id":{"$ref":"#/components/schemas/TokenId","description":"Organization refresh token id"},"organization_type":{"$ref":"#/components/schemas/OrganizationType","description":"Organization type: root or standard"},"fullname":{"type":"string","description":"Human friendly display name for this Organization"},"contact":{"type":"string","nullable":true,"description":"Organization email address"},"reply_to":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com"},"children":[],"type":"text"}],"type":"paragraph"}]},"picture":{"type":"string","nullable":true,"description":"Picture URL of the organization"},"options":{"$ref":"#/components/schemas/OrganizationOptions","nullable":true,"description":"Organization options"},"state":{"$ref":"#/components/schemas/OrganizationState","nullable":true,"description":"Organization state. Omitted when the organization is enabled. Can only be changed through the private organizations API."},"end_date":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Evaluation end date (YYYY-MM-DD, end-of-day UTC) for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"pov"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"plg"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" organizations. Omitted otherwise. Set together with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"state"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" through the private organizations API."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["id","refresh_token_id","organization_type","fullname"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateOrganizationResponse":{"id":"components/schemas/UpdateOrganizationResponse","kind":"json-schema","title":"UpdateOrganizationResponse","data":{"title":"UpdateOrganizationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Organization"}},"required":["result"]}},"components/schemas/PatchOrganizationResponse":{"id":"components/schemas/PatchOrganizationResponse","kind":"json-schema","title":"PatchOrganizationResponse","data":{"title":"PatchOrganizationResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Organization"}},"required":["result"]}},"components/schemas/Permission":{"id":"components/schemas/Permission","kind":"json-schema","title":"Permission","data":{"title":"Permission","type":"object","properties":{"role_binding":{"type":"array","items":{"$ref":"#/components/schemas/RoleName"},"nullable":true,"description":"Roles granted to this token."},"adhoc_role":{"$ref":"#/components/schemas/AdhocRole","nullable":true,"description":"Adhoc role granted to this token."},"resource_id":{"$ref":"#/components/schemas/Id","description":"ID of the resource that this permission grants access to."},"resource_type":{"type":"string","description":"Type of the resource that this permission grants access to. Must be one of the following: \"organization, \"integration\""},"parent_id":{"$ref":"#/components/schemas/Id","description":"Token parentId"},"id":{"$ref":"#/components/schemas/Id","description":"Token Id"},"organization_id":{"$ref":"#/components/schemas/Id","description":"Token organizationId"},"root_organization_id":{"$ref":"#/components/schemas/Id","nullable":true,"description":"Token root organizationId"},"member_id":{"$ref":"#/components/schemas/Id","description":"Token memberId"}},"required":["resource_id","resource_type","parent_id","id","organization_id","member_id"]}},"components/schemas/Permissions":{"id":"components/schemas/Permissions","kind":"json-schema","title":"Permissions","data":{"title":"Permissions","type":"string","enum":["administrator","viewer","member","account-manager","connect-ui","token-issuer","mcp-integrations-use-only","mcp-management","account-provisioner"]}},"components/schemas/PermissionSet":{"id":"components/schemas/PermissionSet","kind":"json-schema","title":"PermissionSet","data":{"title":"PermissionSet","type":"object","properties":{"name":{"$ref":"#/components/schemas/Permissions"},"description":{"type":"string","nullable":true,"description":"Description of when the permission set should be used and what permissions are granted by the permission set."},"resource_restrictions":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRestrictions"},"nullable":true,"description":"Resources that can be used with this permission set"},"permissions":{"$ref":"#/components/schemas/ApiPermissionMap","description":"API permissions granted by the permission set."}},"required":["name","permissions"]}},"components/schemas/ApiPermissionMap":{"id":"components/schemas/ApiPermissionMap","kind":"json-schema","title":"ApiPermissionMap","data":{"title":"ApiPermissionMap","type":"object","properties":{"all":{"$ref":"#/components/schemas/ReadWritePermissions","nullable":true},"accounts":{"$ref":"#/components/schemas/AccountsPermissions","nullable":true},"alarms":{"$ref":"#/components/schemas/AlarmsPermissions","nullable":true},"alarm_policies":{"$ref":"#/components/schemas/AlarmPoliciesPermissions","nullable":true},"audit":{"$ref":"#/components/schemas/AuditPermissions","nullable":true},"auth":{"$ref":"#/components/schemas/AuthPermissions","nullable":true},"billing":{"$ref":"#/components/schemas/BillingPermissions","nullable":true},"bridges":{"$ref":"#/components/schemas/BridgesPermissions","nullable":true},"credentials":{"$ref":"#/components/schemas/CredentialsPermissions","nullable":true},"customs":{"$ref":"#/components/schemas/CustomsPermissions","nullable":true},"integrations":{"$ref":"#/components/schemas/IntegrationsPermissions","nullable":true},"integration_points":{"$ref":"#/components/schemas/IntegrationPointsPermissions","nullable":true},"operations":{"$ref":"#/components/schemas/OperationsPermissions","nullable":true},"mappings":{"$ref":"#/components/schemas/MappingsPermissions","nullable":true},"members":{"$ref":"#/components/schemas/MembersPermissions","nullable":true},"organizations":{"$ref":"#/components/schemas/OrganizationPermissions","nullable":true},"permission_set":{"$ref":"#/components/schemas/PermissionSetPermissions","nullable":true},"roles":{"$ref":"#/components/schemas/RolesPermissions","nullable":true},"status":{"$ref":"#/components/schemas/StatusPermissions","nullable":true},"suborgs":{"$ref":"#/components/schemas/SubOrgsPermissions","nullable":true},"tokens":{"$ref":"#/components/schemas/TokensPermissions","nullable":true},"transforms":{"$ref":"#/components/schemas/TransformsPermissions","nullable":true},"webhooks":{"$ref":"#/components/schemas/WebhooksPermissions","nullable":true},"idp":{"$ref":"#/components/schemas/IdpPermissions","nullable":true}}}},"components/schemas/ReadWritePermissions":{"id":"components/schemas/ReadWritePermissions","kind":"json-schema","title":"ReadWritePermissions","data":{"title":"ReadWritePermissions","type":"object","description":"Permissions for all accounts","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/ReadWriteActions"}}},"required":["actions"]}},"components/schemas/AccountsPermissions":{"id":"components/schemas/AccountsPermissions","kind":"json-schema","title":"AccountsPermissions","data":{"title":"AccountsPermissions","type":"object","description":"Permissions for the accounts API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/AccountsActions"}}},"required":["actions"]}},"components/schemas/AlarmsPermissions":{"id":"components/schemas/AlarmsPermissions","kind":"json-schema","title":"AlarmsPermissions","data":{"title":"AlarmsPermissions","type":"object","description":"Permissions for the alarms API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/AlarmsActions"}}},"required":["actions"]}},"components/schemas/AlarmPoliciesPermissions":{"id":"components/schemas/AlarmPoliciesPermissions","kind":"json-schema","title":"AlarmPoliciesPermissions","data":{"title":"AlarmPoliciesPermissions","type":"object","description":"Permissions for the alarm policy API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/AlarmPoliciesActions"}}},"required":["actions"]}},"components/schemas/AuditPermissions":{"id":"components/schemas/AuditPermissions","kind":"json-schema","title":"AuditPermissions","data":{"title":"AuditPermissions","type":"object","description":"Permissions for the audit API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/AuditActions"}}},"required":["actions"]}},"components/schemas/AuthPermissions":{"id":"components/schemas/AuthPermissions","kind":"json-schema","title":"AuthPermissions","data":{"title":"AuthPermissions","type":"object","description":"Permissions for the auth logon/logoff API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/AuthActions"}}},"required":["actions"]}},"components/schemas/BillingPermissions":{"id":"components/schemas/BillingPermissions","kind":"json-schema","title":"BillingPermissions","data":{"title":"BillingPermissions","type":"object","description":"Permissions for the billing API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/BillingActions"}}},"required":["actions"]}},"components/schemas/BridgesPermissions":{"id":"components/schemas/BridgesPermissions","kind":"json-schema","title":"BridgesPermissions","data":{"title":"BridgesPermissions","type":"object","description":"Permissions for the bridge API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/BridgesActions"}}},"required":["actions"]}},"components/schemas/CredentialsPermissions":{"id":"components/schemas/CredentialsPermissions","kind":"json-schema","title":"CredentialsPermissions","data":{"title":"CredentialsPermissions","type":"object","description":"Permissions for the credentials API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/CredentialsActions"}}},"required":["actions"]}},"components/schemas/CustomsPermissions":{"id":"components/schemas/CustomsPermissions","kind":"json-schema","title":"CustomsPermissions","data":{"title":"CustomsPermissions","type":"object","description":"Permissions for the customs API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/CustomsActions"}}},"required":["actions"]}},"components/schemas/IntegrationsPermissions":{"id":"components/schemas/IntegrationsPermissions","kind":"json-schema","title":"IntegrationsPermissions","data":{"title":"IntegrationsPermissions","type":"object","description":"Permissions for the integrations API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationsActions"}}},"required":["actions"]}},"components/schemas/IntegrationPointsPermissions":{"id":"components/schemas/IntegrationPointsPermissions","kind":"json-schema","title":"IntegrationPointsPermissions","data":{"title":"IntegrationPointsPermissions","type":"object","description":"Permissions for the integrations points API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationPointsActions"}}},"required":["actions"]}},"components/schemas/OperationsPermissions":{"id":"components/schemas/OperationsPermissions","kind":"json-schema","title":"OperationsPermissions","data":{"title":"OperationsPermissions","type":"object","description":"Permissions for the operations API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/OperationsActions"}}},"required":["actions"]}},"components/schemas/MappingsPermissions":{"id":"components/schemas/MappingsPermissions","kind":"json-schema","title":"MappingsPermissions","data":{"title":"MappingsPermissions","type":"object","description":"Permissions for the mappings API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/MappingsActions"}}},"required":["actions"]}},"components/schemas/MembersPermissions":{"id":"components/schemas/MembersPermissions","kind":"json-schema","title":"MembersPermissions","data":{"title":"MembersPermissions","type":"object","description":"Permissions for the members API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/MembersActions"}}},"required":["actions"]}},"components/schemas/OrganizationPermissions":{"id":"components/schemas/OrganizationPermissions","kind":"json-schema","title":"OrganizationPermissions","data":{"title":"OrganizationPermissions","type":"object","description":"Permissions for the organization API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationActions"}}},"required":["actions"]}},"components/schemas/PermissionSetPermissions":{"id":"components/schemas/PermissionSetPermissions","kind":"json-schema","title":"PermissionSetPermissions","data":{"title":"PermissionSetPermissions","type":"object","description":"Permissions for the permissionset API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionSetActions"}}},"required":["actions"]}},"components/schemas/RolesPermissions":{"id":"components/schemas/RolesPermissions","kind":"json-schema","title":"RolesPermissions","data":{"title":"RolesPermissions","type":"object","description":"Permissions for the roles API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/RolesActions"}}},"required":["actions"]}},"components/schemas/SubOrgsPermissions":{"id":"components/schemas/SubOrgsPermissions","kind":"json-schema","title":"SubOrgsPermissions","data":{"title":"SubOrgsPermissions","type":"object","description":"Permissions for the roles API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/SubOrgsActions"}}},"required":["actions"]}},"components/schemas/StatusPermissions":{"id":"components/schemas/StatusPermissions","kind":"json-schema","title":"StatusPermissions","data":{"title":"StatusPermissions","type":"object","description":"Permissions for the status API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/StatusActions"}}},"required":["actions"]}},"components/schemas/TokensPermissions":{"id":"components/schemas/TokensPermissions","kind":"json-schema","title":"TokensPermissions","data":{"title":"TokensPermissions","type":"object","description":"Permissions for the tokens API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/TokensActions"}}},"required":["actions"]}},"components/schemas/TransformsPermissions":{"id":"components/schemas/TransformsPermissions","kind":"json-schema","title":"TransformsPermissions","data":{"title":"TransformsPermissions","type":"object","description":"Permissions for the transforms API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/TransformsActions"}}},"required":["actions"]}},"components/schemas/WebhooksPermissions":{"id":"components/schemas/WebhooksPermissions","kind":"json-schema","title":"WebhooksPermissions","data":{"title":"WebhooksPermissions","type":"object","description":"Permissions for the webhooks API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/WebhooksActions"}}},"required":["actions"]}},"components/schemas/IdpPermissions":{"id":"components/schemas/IdpPermissions","kind":"json-schema","title":"IdpPermissions","data":{"title":"IdpPermissions","type":"object","description":"Permissions for the IdP configuration API","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/IdpActions"}}},"required":["actions"]}},"components/schemas/ResourceRestrictions":{"id":"components/schemas/ResourceRestrictions","kind":"json-schema","title":"ResourceRestrictions","data":{"title":"ResourceRestrictions","type":"string","enum":["accounts","integrations"]}},"components/schemas/ReadWriteActions":{"id":"components/schemas/ReadWriteActions","kind":"json-schema","title":"ReadWriteActions","data":{"title":"ReadWriteActions","type":"string","enum":["read","*"]}},"components/schemas/AccountsActions":{"id":"components/schemas/AccountsActions","kind":"json-schema","title":"AccountsActions","data":{"title":"AccountsActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/AlarmsActions":{"id":"components/schemas/AlarmsActions","kind":"json-schema","title":"AlarmsActions","data":{"title":"AlarmsActions","type":"string","enum":["list","get","mode","priority","clear","*"]}},"components/schemas/AlarmPoliciesActions":{"id":"components/schemas/AlarmPoliciesActions","kind":"json-schema","title":"AlarmPoliciesActions","data":{"title":"AlarmPoliciesActions","type":"string","enum":["get","update","patch","*"]}},"components/schemas/AuditActions":{"id":"components/schemas/AuditActions","kind":"json-schema","title":"AuditActions","data":{"title":"AuditActions","type":"string","enum":["list","*"]}},"components/schemas/AuthActions":{"id":"components/schemas/AuthActions","kind":"json-schema","title":"AuthActions","data":{"title":"AuthActions","type":"string","enum":["logon","change_password","logoff","*"]}},"components/schemas/BillingActions":{"id":"components/schemas/BillingActions","kind":"json-schema","title":"BillingActions","data":{"title":"BillingActions","type":"string","enum":["list","get","*"]}},"components/schemas/BridgesActions":{"id":"components/schemas/BridgesActions","kind":"json-schema","title":"BridgesActions","data":{"title":"BridgesActions","type":"string","enum":["list","create","get","update","patch","delete","status","*"]}},"components/schemas/CredentialsActions":{"id":"components/schemas/CredentialsActions","kind":"json-schema","title":"CredentialsActions","data":{"title":"CredentialsActions","type":"string","enum":["list","create","get","update","patch","delete","lookup","*"]}},"components/schemas/CustomsActions":{"id":"components/schemas/CustomsActions","kind":"json-schema","title":"CustomsActions","data":{"title":"CustomsActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/IntegrationsActions":{"id":"components/schemas/IntegrationsActions","kind":"json-schema","title":"IntegrationsActions","data":{"title":"IntegrationsActions","type":"string","enum":["list","create","get","update","patch","delete","list_account","verify","authorize","*"]}},"components/schemas/IntegrationPointsActions":{"id":"components/schemas/IntegrationPointsActions","kind":"json-schema","title":"IntegrationPointsActions","data":{"title":"IntegrationPointsActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/OperationsActions":{"id":"components/schemas/OperationsActions","kind":"json-schema","title":"OperationsActions","data":{"title":"OperationsActions","type":"string","enum":["list","list_history","*"]}},"components/schemas/MappingsActions":{"id":"components/schemas/MappingsActions","kind":"json-schema","title":"MappingsActions","data":{"title":"MappingsActions","type":"string","enum":["list","create","get","update","patch","delete","apply","*"]}},"components/schemas/MembersActions":{"id":"components/schemas/MembersActions","kind":"json-schema","title":"MembersActions","data":{"title":"MembersActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/OrganizationActions":{"id":"components/schemas/OrganizationActions","kind":"json-schema","title":"OrganizationActions","data":{"title":"OrganizationActions","type":"string","enum":["get","update","patch","*"]}},"components/schemas/PermissionSetActions":{"id":"components/schemas/PermissionSetActions","kind":"json-schema","title":"PermissionSetActions","data":{"title":"PermissionSetActions","type":"string","enum":["list","get","*"]}},"components/schemas/RolesActions":{"id":"components/schemas/RolesActions","kind":"json-schema","title":"RolesActions","data":{"title":"RolesActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/SubOrgsActions":{"id":"components/schemas/SubOrgsActions","kind":"json-schema","title":"SubOrgsActions","data":{"title":"SubOrgsActions","type":"string","enum":["list","create","get","delete","*"]}},"components/schemas/StatusActions":{"id":"components/schemas/StatusActions","kind":"json-schema","title":"StatusActions","data":{"title":"StatusActions","type":"string","enum":["list","get","reset","list_events","timeseries","integration_timeseries","*"]}},"components/schemas/TokensActions":{"id":"components/schemas/TokensActions","kind":"json-schema","title":"TokensActions","data":{"title":"TokensActions","type":"string","enum":["list","create","create_integration","create_synqly_integrations","provision","delete","get","reset","rotate","refresh","remove_secondary","*"]}},"components/schemas/TransformsActions":{"id":"components/schemas/TransformsActions","kind":"json-schema","title":"TransformsActions","data":{"title":"TransformsActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/WebhooksActions":{"id":"components/schemas/WebhooksActions","kind":"json-schema","title":"WebhooksActions","data":{"title":"WebhooksActions","type":"string","enum":["list","create","get","update","patch","delete","*"]}},"components/schemas/IdpActions":{"id":"components/schemas/IdpActions","kind":"json-schema","title":"IdpActions","data":{"title":"IdpActions","type":"string","enum":["get","create","update","delete","*"]}},"components/schemas/ListPermissionSetsResponse":{"id":"components/schemas/ListPermissionSetsResponse","kind":"json-schema","title":"ListPermissionSetsResponse","data":{"title":"ListPermissionSetsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PermissionSet"}}},"required":["result"]}},"components/schemas/GetPermissionSetResponse":{"id":"components/schemas/GetPermissionSetResponse","kind":"json-schema","title":"GetPermissionSetResponse","data":{"title":"GetPermissionSetResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/PermissionSet"}},"required":["result"]}},"components/schemas/APIRegion":{"id":"components/schemas/APIRegion","kind":"json-schema","title":"APIRegion","data":{"title":"APIRegion","type":"string","enum":["eu","de","us","ca","jpn"]}},"components/schemas/AbuseIPDBCredential":{"id":"components/schemas/AbuseIPDBCredential","kind":"json-schema","title":"AbuseIPDB Credential","data":{"title":"AbuseIPDB Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"Secret value of the AbuseIPDB API key."}},"description":"The AbuseIPDB API key to authenticate with the provider."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"AbuseIPDBCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"AbuseIPDBCredential"}}]}},"components/schemas/ApiConfig":{"id":"components/schemas/ApiConfig","kind":"json-schema","title":"ApiConfig","data":{"title":"ApiConfig","type":"object","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PantherApiCredential","description":"Authenticates calls to the Panther APIs."},{"title":"Credential","description":"Authenticates calls to the Panther APIs."}]},"url":{"allOf":[{"type":"string","description":"Base URL for your Panther instance APIs."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://api.instance-id.runpanther.net","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for your Panther instance APIs."}]}},"required":["credential","url"]}},"components/schemas/AppSec_ServiceNow":{"id":"components/schemas/AppSec_ServiceNow","kind":"json-schema","title":"appsec | ServiceNow Application Vulnerability Response","data":{"title":"appsec | ServiceNow Application Vulnerability Response","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for ServiceNow Application Vulnerability Response (AVR) as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/appsec-servicenow-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ServiceNowCredential","description":"Credentials used to access ServiceNow AVR."},{"title":"Credential","description":"Credentials used to access ServiceNow AVR."}]},"oauth_scopes":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope is required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"OAuth Scopes","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope is required."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","description":"HTTPS base URL for the ServiceNow API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.service-now.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"HTTPS base URL for the ServiceNow API."}]}},"required":["credential","url"]}},"components/schemas/AppSec_Snyk":{"id":"components/schemas/AppSec_Snyk","kind":"json-schema","title":"appsec | Snyk","data":{"title":"appsec | Snyk","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Snyk as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/snyk-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SnykCredential","description":"Credentials used for accessing the Snyk API."},{"title":"Credential","description":"Credentials used for accessing the Snyk API."}]},"organization_id":{"allOf":[{"type":"string","description":"The ID of the Snyk organization to use. This value can be found in the Snyk Organizations Settings page."},{"title":"Organization ID","description":"The ID of the Snyk organization to use. This value can be found in the Snyk Organizations Settings page."}]},"region":{"allOf":[{"$ref":"#/components/schemas/SnykRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The data region that the Snyk organization is hosted in. This value can be found in the Snyk URL and on the Snyk login page. For more information, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.snyk.io/snyk-data-and-governance/regional-hosting-and-data-residency#regional-urls"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Snyk documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Data Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The data region that the Snyk organization is hosted in. This value can be found in the Snyk URL and on the Snyk login page. For more information, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.snyk.io/snyk-data-and-governance/regional-hosting-and-data-residency#regional-urls"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Snyk documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","organization_id","region"]}},"components/schemas/AppSec_Tenable":{"id":"components/schemas/AppSec_Tenable","kind":"json-schema","title":"appsec | Tenable WAS","data":{"title":"appsec | Tenable WAS","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tenable Web Application Scanner as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tenable-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TenableCloudCredential","description":"Credentials used for accessing the Tenable Cloud API."},{"title":"Credential","description":"Credentials used for accessing the Tenable Cloud API."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Tenable Cloud API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://cloud.tenable.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tenable Cloud API."}]}},"required":["credential"]}},"components/schemas/AppSec_Veracode":{"id":"components/schemas/AppSec_Veracode","kind":"json-schema","title":"appsec | Veracode","data":{"title":"appsec | Veracode","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Veracode as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/veracode-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/VeracodeCredential","description":"Credentials used for accessing the Veracode API."},{"title":"Credential","description":"Credentials used for accessing the Veracode API."}]},"region":{"allOf":[{"$ref":"#/components/schemas/VeracodeRegion","description":"The region that matches your Veracode account (US or EU)."},{"title":"Region","description":"The region that matches your Veracode account (US or EU)."}]}},"required":["credential","region"]}},"components/schemas/Appsec_amazon_Inspector":{"id":"components/schemas/Appsec_amazon_Inspector","kind":"json-schema","title":"appsec | Amazon Inspector","data":{"title":"appsec | Amazon Inspector","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Amazon Inspector as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/amazon-inspector-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Inspector"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Credential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Inspector"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Inspector provider."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Inspector provider."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","region"]}},"components/schemas/AppsecOpentextCoreApplicationSecurityDataset":{"id":"components/schemas/AppsecOpentextCoreApplicationSecurityDataset","kind":"json-schema","title":"AppsecOpentextCoreApplicationSecurityDataset","data":{"title":"AppsecOpentextCoreApplicationSecurityDataset","type":"string","enum":["basic_v0"]}},"components/schemas/ArmisCredential":{"id":"components/schemas/ArmisCredential","kind":"json-schema","title":"Armis Credential","data":{"title":"Armis Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"required":["extra"],"type":"object","properties":{"extra":{"title":"Extra","required":["vendor_id"],"properties":{"vendor_id":{"title":"Vendor ID","type":"string"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Vendor ID for the Armis Centrix™ tenant."},"children":[],"type":"text"}],"type":"paragraph"}]},"token_url":{"title":"Token URL","description":"This field is ignored and should not be set.","readOnly":true}},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"ArmisCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"ArmisCredential"}},{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"Secret value of the API Key."}},"description":"Configuration when creating new API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"ArmisCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"ArmisCredential"}}]}},"components/schemas/AshbyCredential":{"id":"components/schemas/AshbyCredential","kind":"json-schema","title":"Ashby Credential","data":{"title":"Ashby Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"API key for Ashby with at minimum Organization Read permission."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"AshbyCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"AshbyCredential"}}]}},"components/schemas/Assets_ArmisCentrix":{"id":"components/schemas/Assets_ArmisCentrix","kind":"json-schema","title":"assets | Armis Centrix™","data":{"title":"assets | Armis Centrix™","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Armis Centrix™ for Asset Management and Security."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/armis-centrix-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ArmisCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the Armis Centrix™ API."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.armis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the Armis Centrix™ API."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","url"]}},"components/schemas/Assets_ArmisCentrix_Mock":{"id":"components/schemas/Assets_ArmisCentrix_Mock","kind":"json-schema","title":"assets | [MOCK] Armis Centrix","data":{"title":"assets | [MOCK] Armis Centrix","type":"object","description":"Configuration for a mocked Armis Centrix Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsArmisDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_Axonius":{"id":"components/schemas/Assets_Axonius","kind":"json-schema","title":"assets | Axonius","data":{"title":"assets | Axonius","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Axonius Assets Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/axonius-asset-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AxoniusCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Axonius API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.on.axonius.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Axonius API."}]}},"required":["credential","url"]}},"components/schemas/Assets_Axonius_Mock":{"id":"components/schemas/Assets_Axonius_Mock","kind":"json-schema","title":"assets | [MOCK] Axonius","data":{"title":"assets | [MOCK] Axonius","type":"object","description":"Configuration for a mocked Axonius as an Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsAxoniusDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_ClarotyXdome":{"id":"components/schemas/Assets_ClarotyXdome","kind":"json-schema","title":"assets | Claroty xDome","data":{"title":"assets | Claroty xDome","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Claroty xDome Assets Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/claroty-asset-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ClarotyCredential"},{"title":"Credential"}]},"url":{"allOf":[{"anyOf":[{"$ref":"#/components/schemas/ClarotyAPIURL","description":"Base URL for the Claroty xDome API."},{"pattern":"^synqly://labs/","type":"string"}]},{"format":"uri","example":"https://api.claroty.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"URL","description":"Base URL for the Claroty xDome API."}]}},"required":["credential","url"]}},"components/schemas/Assets_CrowdStrike":{"id":"components/schemas/Assets_CrowdStrike","kind":"json-schema","title":"assets | CrowdStrike Falcon Spotlight","data":{"title":"assets | CrowdStrike Falcon Spotlight","type":"object","description":"Configuration for CrowdStrike Falcon as an Assets Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdStrikeCredential","description":"The credential to use for the CrowdStrike Falcon tenant."},{"title":"Credential","description":"The credential to use for the CrowdStrike Falcon tenant."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the CrowdStrike Falcon Spotlight API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.crowdstrike.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the CrowdStrike Falcon Spotlight API."}]}},"required":["credential"]}},"components/schemas/Assets_CrowdStrike_Mock":{"id":"components/schemas/Assets_CrowdStrike_Mock","kind":"json-schema","title":"assets | [MOCK] CrowdStrike Falcon Spotlight","data":{"title":"assets | [MOCK] CrowdStrike Falcon Spotlight","type":"object","description":"Configuration for a mocked CrowdStrike Falcon as an Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsCrowdStrikeDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_Defender":{"id":"components/schemas/Assets_Defender","kind":"json-schema","title":"assets | Microsoft Defender for Endpoint","data":{"title":"assets | Microsoft Defender for Endpoint","type":"object","description":"Configuration for Microsoft Defender for Endpoint as an Assets Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DefenderCredential"},{"title":"Credential"}]},"tenant_id":{"allOf":[{"type":"string","description":"Tenant ID for the Microsoft Defender Management Console."},{"title":"Tenant ID","description":"Tenant ID for the Microsoft Defender Management Console."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Microsoft Defender API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://api-us3.securitycenter.microsoft.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Microsoft Defender API."}]}},"required":["credential","tenant_id","url"]}},"components/schemas/Assets_Iru":{"id":"components/schemas/Assets_Iru","kind":"json-schema","title":"assets | Iru","data":{"title":"assets | Iru","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Iru."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/iru-assets-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IruCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Iru API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{tenant}.api.kandji.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Iru API."}]}},"required":["credential","url"]}},"components/schemas/Assets_IvantiNeurons":{"id":"components/schemas/Assets_IvantiNeurons","kind":"json-schema","title":"assets | Ivanti Neurons","data":{"title":"assets | Ivanti Neurons","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Ivanti Neurons as an Assets Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/ivanti-asset-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"account_identifier":{"allOf":[{"type":"string"},{"format":"uuid","example":"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"},{"title":"Account ID"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/IvantiCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Ivanti Neurons API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://nvuprd-sfc.ivanticloud.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Ivanti Neurons API."}]}},"required":["account_identifier","credential","url"]}},"components/schemas/Assets_IvantiNeurons_Mock":{"id":"components/schemas/Assets_IvantiNeurons_Mock","kind":"json-schema","title":"assets | [MOCK] Ivanti Neurons","data":{"title":"assets | [MOCK] Ivanti Neurons","type":"object","description":"Configuration for a mocked Ivanti Neurons as an Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsIvantiNeuronsDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_JupiterOne":{"id":"components/schemas/Assets_JupiterOne","kind":"json-schema","title":"assets | JupiterOne","data":{"title":"assets | JupiterOne","type":"object","description":"Configuration for the JupiterOne Assets Provider","properties":{"account_id":{"allOf":[{"type":"string","description":"JupiterOne Account ID"},{"title":"Account ID","description":"JupiterOne Account ID"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/JupiterOneCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the JupiterOne GraphQL API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://graphql.us.jupiterone.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the JupiterOne GraphQL API."}]}},"required":["account_id","credential"]}},"components/schemas/Assets_NozomiVantage":{"id":"components/schemas/Assets_NozomiVantage","kind":"json-schema","title":"assets | Nozomi Vantage","data":{"title":"assets | Nozomi Vantage","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Nozomi Vantage."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/nozomi-vantage-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/NozomiVantageCredential","description":"Credentials used to authenticate with Nozomi Vantage."},{"title":"Credential","description":"Credentials used to authenticate with Nozomi Vantage."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Nozomi Vantage API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.us1.vantage.nozominetworks.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Nozomi Vantage API."}]}},"required":["credential","url"]}},"components/schemas/Assets_NozomiVantage_Mock":{"id":"components/schemas/Assets_NozomiVantage_Mock","kind":"json-schema","title":"assets | [MOCK] Nozomi Vantage","data":{"title":"assets | [MOCK] Nozomi Vantage","type":"object","description":"Configuration for a mocked Nozomi Vantage provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsNozomiVantageDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_QualysCloud":{"id":"components/schemas/Assets_QualysCloud","kind":"json-schema","title":"assets | Qualys VMDR","data":{"title":"assets | Qualys VMDR","type":"object","description":"Configuration for Qualys Cloud Platform as an Assets Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/QualysCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"URL for the Qualys Cloud API. This should be the base URL for the API, without any path components."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://qualys.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"URL for the Qualys Cloud API. This should be the base URL for the API, without any path components."}]}},"required":["credential","url"]}},"components/schemas/Assets_QualysCloud_Mock":{"id":"components/schemas/Assets_QualysCloud_Mock","kind":"json-schema","title":"assets | [MOCK] Qualys VMDR","data":{"title":"assets | [MOCK] Qualys VMDR","type":"object","description":"Configuration for a mock Qualys Cloud Platform as an Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsQualysCloudDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_ServiceNow":{"id":"components/schemas/Assets_ServiceNow","kind":"json-schema","title":"assets | ServiceNow CMDB","data":{"title":"assets | ServiceNow CMDB","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for ServiceNow Configuration Management Database (CMDB)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/servicenow-assets-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ServiceNowCredential"},{"title":"Credential"}]},"oauth_scopes":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cmdb_ci_hardware"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"OAuth Scopes","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cmdb_ci_hardware"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","description":"Base URL for the ServiceNow API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.service-now.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the ServiceNow API."}]}},"required":["credential","url"]}},"components/schemas/Assets_ServiceNow_Mock":{"id":"components/schemas/Assets_ServiceNow_Mock","kind":"json-schema","title":"assets | [MOCK] ServiceNow CMDB","data":{"title":"assets | [MOCK] ServiceNow CMDB","type":"object","description":"Configuration for a mocked ServiceNow as an Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsServiceNowDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_Sevco":{"id":"components/schemas/Assets_Sevco","kind":"json-schema","title":"assets | Sevco","data":{"title":"assets | Sevco","type":"object","description":"Configuration for the Sevco Assets Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SevcoCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"URL for the Sevco API. This should be the base URL for the API, without any path components."},{"pattern":"^https?:.+$","example":"https://api.sev.co"},{"title":"API URL","description":"URL for the Sevco API. This should be the base URL for the API, without any path components."}]}},"required":["credential","url"]}},"components/schemas/Assets_Sevco_Mock":{"id":"components/schemas/Assets_Sevco_Mock","kind":"json-schema","title":"assets | [MOCK] Sevco","data":{"title":"assets | [MOCK] Sevco","type":"object","description":"Configuration for a mocked Sevco Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsSevcoDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_TaniumCloud":{"id":"components/schemas/Assets_TaniumCloud","kind":"json-schema","title":"assets | Tanium Assets","data":{"title":"assets | Tanium Assets","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tanium Cloud as an Assets Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tanium-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TaniumCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Tanium Cloud API"},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{customername}-api.cloud.tanium.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tanium Cloud API"}]}},"required":["credential","url"]}},"components/schemas/Assets_TaniumCloud_Mock":{"id":"components/schemas/Assets_TaniumCloud_Mock","kind":"json-schema","title":"assets | [MOCK] Tanium Assets","data":{"title":"assets | [MOCK] Tanium Assets","type":"object","description":"Configuration for a mocked Tanium Cloud as an Assets Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsTaniumCloudDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Assets_TenableCloud":{"id":"components/schemas/Assets_TenableCloud","kind":"json-schema","title":"assets | Tenable Cloud","data":{"title":"assets | Tenable Cloud","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tenable Cloud."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tenable-asset-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TenableCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Tenable Cloud API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://cloud.tenable.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tenable Cloud API."}]}},"required":["credential"]}},"components/schemas/Assets_TenableCloud_Mock":{"id":"components/schemas/Assets_TenableCloud_Mock","kind":"json-schema","title":"assets | [MOCK] Tenable Cloud","data":{"title":"assets | [MOCK] Tenable Cloud","type":"object","description":"Configuration for a mock Tenable Cloud Assets provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AssetsTenableCloudDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/AssetsArmisDataset":{"id":"components/schemas/AssetsArmisDataset","kind":"json-schema","title":"AssetsArmisDataset","data":{"title":"AssetsArmisDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsAxoniusDataset":{"id":"components/schemas/AssetsAxoniusDataset","kind":"json-schema","title":"AssetsAxoniusDataset","data":{"title":"AssetsAxoniusDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsCrowdStrikeDataset":{"id":"components/schemas/AssetsCrowdStrikeDataset","kind":"json-schema","title":"AssetsCrowdStrikeDataset","data":{"title":"AssetsCrowdStrikeDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsIvantiNeuronsDataset":{"id":"components/schemas/AssetsIvantiNeuronsDataset","kind":"json-schema","title":"AssetsIvantiNeuronsDataset","data":{"title":"AssetsIvantiNeuronsDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsNozomiVantageDataset":{"id":"components/schemas/AssetsNozomiVantageDataset","kind":"json-schema","title":"AssetsNozomiVantageDataset","data":{"title":"AssetsNozomiVantageDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsQualysCloudDataset":{"id":"components/schemas/AssetsQualysCloudDataset","kind":"json-schema","title":"AssetsQualysCloudDataset","data":{"title":"AssetsQualysCloudDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsServiceNowDataset":{"id":"components/schemas/AssetsServiceNowDataset","kind":"json-schema","title":"AssetsServiceNowDataset","data":{"title":"AssetsServiceNowDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsSevcoDataset":{"id":"components/schemas/AssetsSevcoDataset","kind":"json-schema","title":"AssetsSevcoDataset","data":{"title":"AssetsSevcoDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsTaniumCloudDataset":{"id":"components/schemas/AssetsTaniumCloudDataset","kind":"json-schema","title":"AssetsTaniumCloudDataset","data":{"title":"AssetsTaniumCloudDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AssetsTenableCloudDataset":{"id":"components/schemas/AssetsTenableCloudDataset","kind":"json-schema","title":"AssetsTenableCloudDataset","data":{"title":"AssetsTenableCloudDataset","type":"string","enum":["basic_v0"]}},"components/schemas/AutomoxApiKeyCredential":{"id":"components/schemas/AutomoxApiKeyCredential","kind":"json-schema","title":"API Key","data":{"title":"API Key","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"Automox Console API key."}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"AutomoxApiKeyCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"AutomoxApiKeyCredential"}}]}},"components/schemas/AutotaskApiIntegrationCodeCredential":{"id":"components/schemas/AutotaskApiIntegrationCodeCredential","kind":"json-schema","title":"Autotask Api Integration Code Credential","data":{"title":"Autotask Api Integration Code Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{},"description":"Identifier used for individual tracking and management of API calls."}],"required":["type"],"title":"New API Tracking ID","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"AutotaskApiIntegrationCodeCredential"}},{"description":"Reference to existing API Tracking ID.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Tracking ID","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"AutotaskApiIntegrationCodeCredential"}}]}},"components/schemas/AutotaskSecretCredential":{"id":"components/schemas/AutotaskSecretCredential","kind":"json-schema","title":"Autotask Secret Credential","data":{"title":"Autotask Secret Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Secret."}],"required":["type"],"title":"New Secret","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"AutotaskSecretCredential"}},{"description":"Reference to existing Secret.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Secret","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"AutotaskSecretCredential"}}]}},"components/schemas/AwsProviderCredential":{"id":"components/schemas/AwsProviderCredential","kind":"json-schema","title":"Aws Provider Credential","data":{"title":"Aws Provider Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["aws"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AwsCredential"},{"type":"object","properties":{},"description":"Configuration when creating new AWS Access Keys."}],"required":["type"],"title":"New AWS Access Keys","type":"object","x-synqly-credential":{"extends":"AwsCredential","type":"AwsProviderCredential"}},{"description":"Reference to existing AWS Access Keys.","properties":{"type":{"enum":["aws_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/AwsCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing AWS Access Keys","type":"object","x-synqly-credential":{"extends":"AwsCredentialId","reference":true,"type":"AwsProviderCredential"}},{"allOf":[{"properties":{"type":{"enum":["aws_role"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AwsRoleCredential"},{"type":"object","properties":{},"description":"Configuration when creating new AWS Role."}],"required":["type"],"title":"New AWS Role","type":"object","x-synqly-credential":{"extends":"AwsRoleCredential","type":"AwsProviderCredential"}},{"description":"Reference to existing AWS Role.","properties":{"type":{"enum":["aws_role_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/AwsRoleCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing AWS Role","type":"object","x-synqly-credential":{"extends":"AwsRoleCredentialId","reference":true,"type":"AwsProviderCredential"}}]}},"components/schemas/AwsRegion":{"id":"components/schemas/AwsRegion","kind":"json-schema","title":"AwsRegion","data":{"title":"AwsRegion","type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","af-south-1","ap-east-1","ap-south-2","ap-southeast-3","ap-southeast-5","ap-southeast-4","ap-south-1","ap-northeast-3","ap-northeast-2","ap-southeast-1","ap-southeast-2","ap-east-2","ap-southeast-7","ap-northeast-1","ca-central-1","ca-west-1","eu-central-1","eu-west-1","eu-west-2","eu-south-1","eu-west-3","eu-south-2","eu-north-1","eu-central-2","il-central-1","mx-central-1","me-south-1","me-central-1","sa-east-1"]}},"components/schemas/AxoniusCredential":{"id":"components/schemas/AxoniusCredential","kind":"json-schema","title":"Axonius Credential","data":{"title":"Axonius Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This credential must be an API Key and API Secret. For more details, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.axonius.com/docs/axonius-rest-api#getting-an-api-key-and-api-secret"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Getting an API Key and API Secret"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"AxoniusCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"AxoniusCredential"}}]}},"components/schemas/AzureBlobCredential":{"id":"components/schemas/AzureBlobCredential","kind":"json-schema","title":"Azure Blob Credential","data":{"title":"Azure Blob Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Secret."}],"required":["type"],"title":"New Client Secret","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"AzureBlobCredential"}},{"description":"Reference to existing Client Secret.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Secret","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"AzureBlobCredential"}}]}},"components/schemas/AzureCloud":{"id":"components/schemas/AzureCloud","kind":"json-schema","title":"AzureCloud","data":{"title":"AzureCloud","type":"string","enum":["public","government","dod"]}},"components/schemas/AzureDevOpsTicketingCredential":{"id":"components/schemas/AzureDevOpsTicketingCredential","kind":"json-schema","title":"Azure DevOps PAT Credential","data":{"title":"Azure DevOps PAT Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"PAT","description":"The Personal Access Token.","example":"your-pat-token-here"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Personal Access Token (PAT) for authenticating with the Azure DevOps REST API. Requires vso.work and vso.work_write scopes."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Personal Access Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"AzureDevOpsTicketingCredential"}},{"description":"Reference to existing Personal Access Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Personal Access Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"AzureDevOpsTicketingCredential"}}]}},"components/schemas/AzureMonitorLogsCredential":{"id":"components/schemas/AzureMonitorLogsCredential","kind":"json-schema","title":"Azure Monitor Logs Credential","data":{"title":"Azure Monitor Logs Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Secret."}],"required":["type"],"title":"New Client Secret","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"AzureMonitorLogsCredential"}},{"description":"Reference to existing Client Secret.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Secret","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"AzureMonitorLogsCredential"}}]}},"components/schemas/AzureNetworkSecurityCredential":{"id":"components/schemas/AzureNetworkSecurityCredential","kind":"json-schema","title":"Azure Network Security Credential","data":{"title":"Azure Network Security Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Azure Client ID and Client Secret for a service principal with access to Network Watcher and related Azure networking resources."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"AzureNetworkSecurityCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"AzureNetworkSecurityCredential"}}]}},"components/schemas/BMCHelixCredential":{"id":"components/schemas/BMCHelixCredential","kind":"json-schema","title":"BMC Helix ITSM Credential","data":{"title":"BMC Helix ITSM Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"Password","description":"The password for the BMC Helix ITSM user account.","example":"your-password"},"username":{"title":"Username","description":"The username for authenticating with the BMC Helix AR REST API.","example":"admin_user"}},"description":"Username and password for BMC Helix ITSM AR REST API authentication."}],"required":["type"],"title":"New Username & Password","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"BMCHelixCredential"}},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reference to existing Username & Password."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Username & Password","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"BMCHelixCredential"}}]}},"components/schemas/BigFixCredential":{"id":"components/schemas/BigFixCredential","kind":"json-schema","title":"Big Fix Credential","data":{"title":"Big Fix Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Username and password for a BigFix operator account."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"BigFixCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"BigFixCredential"}}]}},"components/schemas/BitdefenderCredential":{"id":"components/schemas/BitdefenderCredential","kind":"json-schema","title":"API Key","data":{"title":"API Key","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"The API key for authenticating with the Bitdefender GravityZone API. Generated in GravityZone Control Center under My Account, API Keys."}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"BitdefenderCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"BitdefenderCredential"}}]}},"components/schemas/ChannelJoinBehavior":{"id":"components/schemas/ChannelJoinBehavior","kind":"json-schema","title":"ChannelJoinBehavior","data":{"title":"ChannelJoinBehavior","type":"string","enum":["auto","manual"]}},"components/schemas/Chat_MicrosoftCopilot":{"id":"components/schemas/Chat_MicrosoftCopilot","kind":"json-schema","title":"chat | Microsoft 365 Copilot","data":{"title":"chat | Microsoft 365 Copilot","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft 365 Copilot."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/microsoft-copilot-chat-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CopilotChatCredential"},{"title":"Credential"}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure Directory tenant identifier."},{"title":"Tenant ID","description":"Azure Directory tenant identifier."}]}},"required":["credential","tenant_id"]}},"components/schemas/Chat_MicrosoftTeams":{"id":"components/schemas/Chat_MicrosoftTeams","kind":"json-schema","title":"chat | Microsoft Teams","data":{"title":"chat | Microsoft Teams","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Teams."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/teams-chat-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TeamsGraphChatCredential"},{"title":"Credential"}]},"team_id":{"allOf":[{"type":"string","nullable":true,"description":"Team identifier, required for querying team channels. If omitted, only user-scoped chats (DMs and group chats) can be queried."},{"title":"Team ID","description":"Team identifier, required for querying team channels. If omitted, only user-scoped chats (DMs and group chats) can be queried."}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure Directory (tenant) identifier."},{"title":"Tenant ID","description":"Azure Directory (tenant) identifier."}]}},"required":["credential","tenant_id"]}},"components/schemas/Chat_Slack":{"id":"components/schemas/Chat_Slack","kind":"json-schema","title":"chat | Slack","data":{"title":"chat | Slack","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Slack."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/slack-chat-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"channels":{"allOf":[{"$ref":"#/components/schemas/ChannelJoinBehavior","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auto"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the bot automatically joins public channels on demand when interacting with channels it has not already been added to. When set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"manual"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the bot must be manually added to the channels, and will not automatically join a channel where it is mentioned or otherwise interacted with."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"manual"},{"title":"Channels","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"auto"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the bot automatically joins public channels on demand when interacting with channels it has not already been added to. When set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"manual"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the bot must be manually added to the channels, and will not automatically join a channel where it is mentioned or otherwise interacted with."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/SlackCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Slack API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://slack.com/","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Slack API."}]}},"required":["credential"]}},"components/schemas/ClarotyAPIURL":{"id":"components/schemas/ClarotyAPIURL","kind":"json-schema","title":"ClarotyAPIURL","data":{"title":"ClarotyAPIURL","type":"string","enum":["https://api.claroty.com","https://eu.api.claroty.com","https://ca.api.claroty.com","https://au.api.claroty.com","https://demo-api.claroty.com"]}},"components/schemas/ClarotyCredential":{"id":"components/schemas/ClarotyCredential","kind":"json-schema","title":"Claroty Credential","data":{"title":"Claroty Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Token."}],"required":["type"],"title":"New API Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"ClarotyCredential"}},{"description":"Reference to existing API Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"ClarotyCredential"}}]}},"components/schemas/CloudSecurity_AWS":{"id":"components/schemas/CloudSecurity_AWS","kind":"json-schema","title":"cloudsecurity | AWS Cloud Security","data":{"title":"cloudsecurity | AWS Cloud Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the AWS Cloud Security Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-cloudsecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/securityhub/latest/userguide/what-are-securityhub-services.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Security Hub"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Credential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/securityhub/latest/userguide/what-are-securityhub-services.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Security Hub"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"events":{"allOf":[{"$ref":"#/components/schemas/CloudSecurity_AWS_Events","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional configuration for querying security events (e.g. CloudTrail Lake). When configured, enables query_events for this integration."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Events","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional configuration for querying security events (e.g. CloudTrail Lake). When configured, enables query_events for this integration."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the AWS Cloud Security Provider."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the AWS Cloud Security Provider."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","region"]}},"components/schemas/CloudSecurity_AWS_CloudTrailLakeEvents":{"id":"components/schemas/CloudSecurity_AWS_CloudTrailLakeEvents","kind":"json-schema","title":"CloudSecurity_AWS_CloudTrailLakeEvents","data":{"title":"CloudSecurity_AWS_CloudTrailLakeEvents","type":"object","description":"CloudTrail Lake event data store IDs.","properties":{"event_data_store_id":{"allOf":[{"type":"string","description":"UUID of the event data store for Management, Data, and NetworkActivity events."},{"title":"Event Data Store ID","description":"UUID of the event data store for Management, Data, and NetworkActivity events."}]},"insights_event_data_store_id":{"allOf":[{"type":"string","nullable":true,"description":"UUID of the event data store for Insight events (optional)."},{"title":"Insights Event Data Store ID","description":"UUID of the event data store for Insight events (optional)."}]}},"required":["event_data_store_id"]}},"components/schemas/CloudSecurity_AWS_Events":{"id":"components/schemas/CloudSecurity_AWS_Events","kind":"json-schema","title":"CloudSecurity_AWS_Events","data":{"title":"CloudSecurity_AWS_Events","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudtrail_lake"]}}},{"$ref":"#/components/schemas/CloudSecurity_AWS_CloudTrailLakeEvents"}],"required":["type"]}],"description":"Union of event source configurations for AWS Cloud Security."}},"components/schemas/CloudSecurity_AWSEventBridgeSQS":{"id":"components/schemas/CloudSecurity_AWSEventBridgeSQS","kind":"json-schema","title":"cloudsecurity | AWS EventBridge SQS","data":{"title":"cloudsecurity | AWS EventBridge SQS","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the AWS EventBridge SQS Provider that reads operation-specific SQS queues populated by EventBridge."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-eventbridge-sqs-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":"AWS credentials with access to the configured SQS queue."},{"title":"Credential","description":"AWS credentials with access to the configured SQS queue."}]},"queue_url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL of the SQS queue for compliance findings (Security Hub compliance findings). When both queue_url and queues are present, queues takes precedence for the corresponding operation."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Queue URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL of the SQS queue for compliance findings (Security Hub compliance findings). When both queue_url and queues are present, queues takes precedence for the corresponding operation."},"children":[],"type":"text"}],"type":"paragraph"}],"deprecated":true,"x-fern-availability":"deprecated"}]},"queues":{"allOf":[{"$ref":"#/components/schemas/CloudSecurityEventBridgeSqsQueues","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SQS queue URLs per operation. Each EventBridge pipeline uses a different queue. At least one of queue_url or queues.query_compliance_findings must be set for query_compliance_findings. Add more entries as you enable additional operations."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Queues by operation","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SQS queue URLs per operation. Each EventBridge pipeline uses a different queue. At least one of queue_url or queues.query_compliance_findings must be set for query_compliance_findings. Add more entries as you enable additional operations."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/CloudSecurity_CrowdStrike":{"id":"components/schemas/CloudSecurity_CrowdStrike","kind":"json-schema","title":"cloudsecurity | CrowdStrike Cloud Security","data":{"title":"cloudsecurity | CrowdStrike Cloud Security","type":"object","description":"Configuration for the CrowdStrike Cloud Security Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdStrikeCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"The root domain where your CrowdStrike Falcon tenant is located."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.crowdstrike.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"The root domain where your CrowdStrike Falcon tenant is located."}]}},"required":["credential"]}},"components/schemas/CloudSecurity_CrowdStrike_Mock":{"id":"components/schemas/CloudSecurity_CrowdStrike_Mock","kind":"json-schema","title":"cloudsecurity | [MOCK] CrowdStrike Cloud Security","data":{"title":"cloudsecurity | [MOCK] CrowdStrike Cloud Security","type":"object","description":"Configuration for a mock CrowdStrike Cloud Security Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/CloudSecurityCrowdStrikeDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/CloudSecurity_Defender":{"id":"components/schemas/CloudSecurity_Defender","kind":"json-schema","title":"cloudsecurity | Microsoft Defender for Cloud","data":{"title":"cloudsecurity | Microsoft Defender for Cloud","type":"object","description":"Configuration for the Microsoft Defender for Cloud Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DefenderCredential"},{"title":"Credential"}]},"subscription_id":{"allOf":[{"type":"string","description":"The Azure subscription ID that contains the Microsoft Defender for Cloud workspace."},{"title":"Subscription ID","description":"The Azure subscription ID that contains the Microsoft Defender for Cloud workspace."}]},"tenant_id":{"allOf":[{"type":"string","description":"The Azure Active Directory tenant ID that contains the Microsoft Defender for Cloud workspace."},{"title":"Tenant ID","description":"The Azure Active Directory tenant ID that contains the Microsoft Defender for Cloud workspace."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL to your Microsoft Defender for Cloud workspace."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://management.azure.com/.default","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL to your Microsoft Defender for Cloud workspace."}]}},"required":["credential","subscription_id","tenant_id"]}},"components/schemas/CloudSecurity_Google":{"id":"components/schemas/CloudSecurity_Google","kind":"json-schema","title":"cloudsecurity | Google Security Command Center","data":{"title":"cloudsecurity | Google Security Command Center","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Google Security Command Center Cloud Security Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-security-command-center-cloudsecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GoogleServiceAccountCredential","description":"Credentials used for accessing Google Security Command Center."},{"title":"Credential","description":"Credentials used for accessing Google Security Command Center."}]},"scope_path":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Google Cloud scope path whose Security Command Center findings and Cloud Asset Inventory assets should be queried. Must be formatted as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizations/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"projects/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^organizations/[0-9]+$|^projects/(?:[0-9]+|[a-z][a-z0-9-]{4,28}[a-z0-9])$","example":"organizations/123456789012","x-validation-message":{"patternMismatch":"Input must match `organizations/{numeric id}` or `projects/{project id or number}`."}},{"title":"Scope Path","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Google Cloud scope path whose Security Command Center findings and Cloud Asset Inventory assets should be queried. Must be formatted as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"organizations/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"projects/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","scope_path"]}},"components/schemas/CloudSecurity_Orca":{"id":"components/schemas/CloudSecurity_Orca","kind":"json-schema","title":"cloudsecurity | Orca Security","data":{"title":"cloudsecurity | Orca Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Orca Security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/orca-cloudsecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"compliance_framework_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"Limit compliance findings to these frameworks, using the framework IDs shown in the Orca console. Leaving this empty will cover every framework in your account."},{"title":"Compliance Framework IDs","description":"Limit compliance findings to these frameworks, using the framework IDs shown in the Orca console. Leaving this empty will cover every framework in your account."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/OrcaCredential"},{"title":"API Token"}]},"region":{"allOf":[{"$ref":"#/components/schemas/OrcaRegion","description":"The Orca region your account is hosted in."},{"title":"Region","description":"The Orca region your account is hosted in."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for custom or proxied environments. When set, the region field is ignored."},{"title":"Base URL","description":"Base URL override for custom or proxied environments. When set, the region field is ignored."}]}},"required":["credential","region"]}},"components/schemas/CloudSecurity_PaloAlto":{"id":"components/schemas/CloudSecurity_PaloAlto","kind":"json-schema","title":"cloudsecurity | Palo Alto Networks Cortex Cloud Security","data":{"title":"cloudsecurity | Palo Alto Networks Cortex Cloud Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Palo Alto Networks Cortex Cloud Security"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/paloalto-cloudsecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PaloAltoCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Palo Alto Networks Cortex Cloud Security API."},{"example":"https://api-{tenant}.xdr.{region}.paloaltonetworks.com"},{"title":"Base URL","description":"Base URL for the Palo Alto Networks Cortex Cloud Security API."}]}},"required":["credential","url"]}},"components/schemas/CloudSecurity_SentinelOne":{"id":"components/schemas/CloudSecurity_SentinelOne","kind":"json-schema","title":"cloudsecurity | SentinelOne Cloud Native Security","data":{"title":"cloudsecurity | SentinelOne Cloud Native Security","type":"object","description":"Configuration for the SentinelOne Singularity Cloud Native Security Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SentinelOneCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL of the SentinelOne management console. Cloud Native Security requires the Singularity Operations Center."},{"pattern":"^(https:.+|synqly:.+)$","format":"uri","example":"https://{tenant}.sentinelone.net","x-validation-message":{"patternMismatch":"Must be a valid HTTPS URL."}},{"title":"Base URL","description":"Base URL of the SentinelOne management console. Cloud Native Security requires the Singularity Operations Center."}]}},"required":["credential","url"]}},"components/schemas/CloudSecurity_Tenable":{"id":"components/schemas/CloudSecurity_Tenable","kind":"json-schema","title":"cloudsecurity | Tenable Cloud Security","data":{"title":"cloudsecurity | Tenable Cloud Security","type":"object","description":"Configuration for the Tenable Cloud Security provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TenableCloudSecurityCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/TenableCloudSecurityRegion","nullable":true,"description":"Region of the Tenable Cloud Security tenant."},{"default":"global"},{"title":"Region","description":"Region of the Tenable Cloud Security tenant."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for custom or proxied environments. When set, the region field is ignored."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL override for custom or proxied environments. When set, the region field is ignored."}]}},"required":["credential"]}},"components/schemas/CloudSecurity_Upwind":{"id":"components/schemas/CloudSecurity_Upwind","kind":"json-schema","title":"cloudsecurity | Upwind Cloud Security","data":{"title":"cloudsecurity | Upwind Cloud Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Upwind Cloud Security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/upwind-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/UpwindCredential","description":"Upwind OAuth client credentials."},{"title":"Credential","description":"Upwind OAuth client credentials."}]},"organization_id":{"allOf":[{"type":"string","description":"Organization ID used in the Upwind API path."},{"title":"Organization ID","description":"Organization ID used in the Upwind API path."}]},"region":{"allOf":[{"$ref":"#/components/schemas/UpwindRegion","description":"Region used to determine the OAuth audience for token requests."},{"title":"Region","description":"Region used to determine the OAuth audience for token requests."}]}},"required":["credential","organization_id","region"]}},"components/schemas/CloudSecurity_Wiz":{"id":"components/schemas/CloudSecurity_Wiz","kind":"json-schema","title":"cloudsecurity | Wiz Cloud Security","data":{"title":"cloudsecurity | Wiz Cloud Security","type":"object","description":"Configuration for the Wiz Cloud Security Provider","properties":{"api_endpoint_url":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Wiz GraphQL API endpoint URL. Copy this from the Wiz tenant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"API Endpoint URL"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field (for example https://api.us17.app.wiz.io/graphql). The OAuth token endpoint is inferred from the environment in this URL (app.wiz.io, app.wiz.us, or gov.wiz.io)."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTPS URL."}},{"title":"API Endpoint URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Wiz GraphQL API endpoint URL. Copy this from the Wiz tenant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"API Endpoint URL"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field (for example https://api.us17.app.wiz.io/graphql). The OAuth token endpoint is inferred from the environment in this URL (app.wiz.io, app.wiz.us, or gov.wiz.io)."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/WizCredential"},{"title":"Credential"}]}},"required":["api_endpoint_url","credential"]}},"components/schemas/CloudSecurityCrowdStrikeDataset":{"id":"components/schemas/CloudSecurityCrowdStrikeDataset","kind":"json-schema","title":"CloudSecurityCrowdStrikeDataset","data":{"title":"CloudSecurityCrowdStrikeDataset","type":"string","enum":["basic_v0"]}},"components/schemas/CloudSecurityEventBridgeSqsQueues":{"id":"components/schemas/CloudSecurityEventBridgeSqsQueues","kind":"json-schema","title":"Queues by operation","data":{"title":"Queues by operation","type":"object","description":"SQS queue URLs per cloud security operation. Each EventBridge pipeline (for example, compliance, threats, inventory, or events) uses a different queue. ","properties":{"query_cloud_resource_inventory":{"allOf":[{"type":"string","nullable":true,"description":"URL of the SQS queue for cloud resource inventory events."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Cloud resource inventory queue URL","description":"URL of the SQS queue for cloud resource inventory events."}]},"query_compliance_findings":{"allOf":[{"type":"string","nullable":true,"description":"URL of the SQS queue for Security Hub compliance findings."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Compliance findings queue URL","description":"URL of the SQS queue for Security Hub compliance findings."}]},"query_events":{"allOf":[{"type":"string","nullable":true,"description":"URL of the SQS queue for cloud security event activity."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Events queue URL","description":"URL of the SQS queue for cloud security event activity."}]},"query_threats":{"allOf":[{"type":"string","nullable":true,"description":"URL of the SQS queue for Security Hub detection findings and/or GuardDuty threat events."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Threats queue URL","description":"URL of the SQS queue for Security Hub detection findings and/or GuardDuty threat events."}]}}}},"components/schemas/CopilotChatCredential":{"id":"components/schemas/CopilotChatCredential","kind":"json-schema","title":"Copilot Chat Credential","data":{"title":"Copilot Chat Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Azure Client ID and Client Secret for a service principal."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"CopilotChatCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"CopilotChatCredential"}}]}},"components/schemas/CrowdStrikeCredential":{"id":"components/schemas/CrowdStrikeCredential","kind":"json-schema","title":"Crowd Strike Credential","data":{"title":"Crowd Strike Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"CrowdStrikeCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"CrowdStrikeCredential"}}]}},"components/schemas/CrowdstrikeHECCredential":{"id":"components/schemas/CrowdstrikeHECCredential","kind":"json-schema","title":"Crowdstrike HECCredential","data":{"title":"Crowdstrike HECCredential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"CrowdstrikeHECCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"CrowdstrikeHECCredential"}}]}},"components/schemas/Custom_Synqly":{"id":"components/schemas/Custom_Synqly","kind":"json-schema","title":"custom | Custom Provider","data":{"title":"custom | Custom Provider","type":"object","description":"Configuration for Synqly Custom Provider.","properties":{"custom_id":{"allOf":[{"type":"string","description":"Customer provider ID associated with this credential configuration"},{"title":"Custom provider ID","description":"Customer provider ID associated with this credential configuration"}]},"endpoints":{"allOf":[{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomEndpoint"},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom endpoints. Review the custom provider definition for the custom_id you supplied for the list of endpoints that must be defined. All endpoint in the provider definition are required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Custom endpoints","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom endpoints. Review the custom provider definition for the custom_id you supplied for the list of endpoints that must be defined. All endpoint in the provider definition are required."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"tags":{"allOf":[{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tags that customize how provider requests are made, such as supplying a URL path parameter or account ID. Review the custom provider definition for the custom_id you supplied for the list of tags that must be defined. All tags in the provider definition are required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Tags","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tags that customize how provider requests are made, such as supplying a URL path parameter or account ID. Review the custom provider definition for the custom_id you supplied for the list of tags that must be defined. All tags in the provider definition are required."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["custom_id","endpoints","tags"]}},"components/schemas/CustomCredential":{"id":"components/schemas/CustomCredential","kind":"json-schema","title":"Custom Credential","data":{"title":"Custom Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["aws"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AwsCredential"},{"type":"object","properties":{},"description":"Configuration when creating new AWS Access Keys."}],"required":["type"],"title":"New AWS Access Keys","type":"object","x-synqly-credential":{"extends":"AwsCredential","type":"CustomCredential"}},{"description":"Reference to existing AWS Access Keys.","properties":{"type":{"enum":["aws_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/AwsCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing AWS Access Keys","type":"object","x-synqly-credential":{"extends":"AwsCredentialId","reference":true,"type":"CustomCredential"}},{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Basic Credentials."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"CustomCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"CustomCredential"}},{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"CustomCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"CustomCredential"}},{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Secret."}],"required":["type"],"title":"New Secret","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"CustomCredential"}},{"description":"Reference to existing Secret.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Secret","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"CustomCredential"}},{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"CustomCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"CustomCredential"}}]}},"components/schemas/CustomEndpoint":{"id":"components/schemas/CustomEndpoint","kind":"json-schema","title":"Custom Endpoint","data":{"title":"Custom Endpoint","type":"object","description":"Defines URL and Credential to use for the endpoint","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CustomCredential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The credential to use for the custom endpoint. Review the custom provider definition for the custom_id you supplied for the credential type that must be defined."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Custom endpoint credential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The credential to use for the custom endpoint. Review the custom provider definition for the custom_id you supplied for the credential type that must be defined."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the TLS certificate."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom URL for the provider. If not provided, the default endpoint URL defined in the provider definition for the provided custom_id will be used instead."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Custom endpoint URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom URL for the provider. If not provided, the default endpoint URL defined in the provider definition for the provided custom_id will be used instead."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/CustomFieldMapping":{"id":"components/schemas/CustomFieldMapping","kind":"json-schema","title":"CustomFieldMapping","data":{"title":"CustomFieldMapping","type":"object","properties":{"name":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Name for the custom field that you will use in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"custom_fields"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field in the returned ticket objects."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Name","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Name for the custom field that you will use in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"custom_fields"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field in the returned ticket objects."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"project_id":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID of the project this field mapping is associated with. ID of \"*\" is used to apply to all projects."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Project ID","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID of the project this field mapping is associated with. ID of \"*\" is used to apply to all projects."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"provider_field_path":{"allOf":[{"type":"string","description":"Path to or name of the custom field in the provider."},{"title":"Field Path (Provider)","description":"Path to or name of the custom field in the provider."}]}},"required":["name","project_id","provider_field_path"]}},"components/schemas/DatadogApiKeyCredential":{"id":"components/schemas/DatadogApiKeyCredential","kind":"json-schema","title":"API Key","data":{"title":"API Key","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Datadog API key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"DatadogApiKeyCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"DatadogApiKeyCredential"}}]}},"components/schemas/DatadogApplicationKeyCredential":{"id":"components/schemas/DatadogApplicationKeyCredential","kind":"json-schema","title":"Application Key","data":{"title":"Application Key","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Datadog application key."}],"required":["type"],"title":"New Application Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"DatadogApplicationKeyCredential"}},{"description":"Reference to existing Application Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Application Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"DatadogApplicationKeyCredential"}}]}},"components/schemas/DefenderCredential":{"id":"components/schemas/DefenderCredential","kind":"json-schema","title":"Defender Credential","data":{"title":"Defender Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Microsoft Defender OAuth client credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"DefenderCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"DefenderCredential"}}]}},"components/schemas/DefenderEasmCredential":{"id":"components/schemas/DefenderEasmCredential","kind":"json-schema","title":"Defender Easm Credential","data":{"title":"Defender Easm Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Microsoft Entra ID service principal credentials (client ID and client secret) with Reader permissions on the EASM workspace."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"DefenderEasmCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"DefenderEasmCredential"}}]}},"components/schemas/DrataCredential":{"id":"components/schemas/DrataCredential","kind":"json-schema","title":"Drata Credential","data":{"title":"Drata Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key"}},"description":"A Drata API key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"DrataCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"DrataCredential"}}]}},"components/schemas/DrataRegion":{"id":"components/schemas/DrataRegion","kind":"json-schema","title":"DrataRegion","data":{"title":"DrataRegion","type":"string","enum":["NA","EU","APAC"]}},"components/schemas/DuoSecurityCredential":{"id":"components/schemas/DuoSecurityCredential","kind":"json-schema","title":"Duo Security Credential","data":{"title":"Duo Security Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"Secret Key","description":"Duo Admin API secret key (skey)."},"username":{"title":"Integration Key","description":"Duo Admin API integration key (ikey)."}},"description":"Integration key (ikey) and secret key (skey) for a Duo Admin API application."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"DuoSecurityCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"DuoSecurityCredential"}}]}},"components/schemas/ESETCredential":{"id":"components/schemas/ESETCredential","kind":"json-schema","title":"ESETCredential","data":{"title":"ESETCredential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"token_url":{"title":"Token URL","description":"This field is ignored and should not be set.","readOnly":true}},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"ESETCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"ESETCredential"}}]}},"components/schemas/Edr_Bitdefender":{"id":"components/schemas/Edr_Bitdefender","kind":"json-schema","title":"edr | Bitdefender GravityZone EDR","data":{"title":"edr | Bitdefender GravityZone EDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Bitdefender GravityZone EDR."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/bitdefender-edr-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/BitdefenderCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"The URL of your Bitdefender GravityZone Control Center."},{"example":"https://cloud.gravityzone.bitdefender.com"},{"title":"Control Center URL","description":"The URL of your Bitdefender GravityZone Control Center."}]}},"required":["credential","url"]}},"components/schemas/Edr_CrowdStrike":{"id":"components/schemas/Edr_CrowdStrike","kind":"json-schema","title":"edr | CrowdStrike Insight EDR","data":{"title":"edr | CrowdStrike Insight EDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for CrowdStrike Falcon® Insight EDR."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/crowdstrike-edr-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdStrikeCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the CrowdStrike Falcon® API."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.crowdstrike.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the CrowdStrike Falcon® API."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/Edr_CrowdStrike_Mock":{"id":"components/schemas/Edr_CrowdStrike_Mock","kind":"json-schema","title":"edr | [MOCK] CrowdStrike Insight EDR","data":{"title":"edr | [MOCK] CrowdStrike Insight EDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] CrowdStrike Falcon® Insight EDR."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/EdrCrowdStrikeDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Edr_Defender":{"id":"components/schemas/Edr_Defender","kind":"json-schema","title":"edr | Microsoft Defender","data":{"title":"edr | Microsoft Defender","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Defender for Endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/defender-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DefenderCredential"},{"title":"Credential"}]},"security_url":{"allOf":[{"type":"string","description":"Base URL for the Microsoft Defender for Endpoint API (the api.security.microsoft.com host). US Government and regional tenants use a different host."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.security.microsoft.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Security API URL","description":"Base URL for the Microsoft Defender for Endpoint API (the api.security.microsoft.com host). US Government and regional tenants use a different host."}]},"tenant_id":{"allOf":[{"type":"string","description":"Tenant ID for the Microsoft Defender Management Console."},{"title":"Tenant ID","description":"Tenant ID for the Microsoft Defender Management Console."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Microsoft Defender for Endpoint API (the legacy api.securitycenter host)."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api-us.securitycenter.windows.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Microsoft Defender for Endpoint API (the legacy api.securitycenter host)."}]}},"required":["credential","security_url","tenant_id","url"]}},"components/schemas/Edr_EsetConnect":{"id":"components/schemas/Edr_EsetConnect","kind":"json-schema","title":"edr | ESET Connect","data":{"title":"edr | ESET Connect","type":"object","description":"Configuration for ESET Connect as a EDR Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ESETCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/APIRegion","description":"Region to use when connecting to the ESET Connect API."},{"example":"eu"},{"title":"Region","description":"Region to use when connecting to the ESET Connect API."}]}},"required":["credential","region"]}},"components/schemas/Edr_Huntress":{"id":"components/schemas/Edr_Huntress","kind":"json-schema","title":"edr | Huntress Managed EDR","data":{"title":"edr | Huntress Managed EDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Huntress Managed EDR."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/huntress-edr-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/HuntressCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"The base URL of the Huntress API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.huntress.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"The base URL of the Huntress API."}]}},"required":["credential","url"]}},"components/schemas/Edr_Iru":{"id":"components/schemas/Edr_Iru","kind":"json-schema","title":"edr | Iru","data":{"title":"edr | Iru","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Iru as a EDR Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/iru-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IruCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Iru API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{tenant}.api.kandji.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Iru API."}]}},"required":["credential","url"]}},"components/schemas/Edr_Malwarebytes":{"id":"components/schemas/Edr_Malwarebytes","kind":"json-schema","title":"edr | ThreatDown EDR","data":{"title":"edr | ThreatDown EDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for ThreatDown Endpoint Detection & Response."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/malwarebytes-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"account_identifier":{"allOf":[{"type":"string","description":"Account identifier for the ThreatDown EDR tenant."},{"pattern":"^(https:\\/\\/cloud\\.malwarebytes\\.com\\/)?((?:[\\dA-Za-z]+-){4}[\\dA-Za-z]+)(\\/.*)?$","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - OR - https://cloud.malwarebytes.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/dashboard","x-validation-message":{"patternMismatch":"Must be a valid Account ID (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`) or tenant URL (`https://cloud.malwarebytes.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/dashboard`)."}},{"title":"Account ID","description":"Account identifier for the ThreatDown EDR tenant."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/MalwarebytesCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the ThreatDown EDR API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.malwarebytes.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the ThreatDown EDR API."}]}},"required":["account_identifier","credential"]}},"components/schemas/Edr_SentinelOne":{"id":"components/schemas/Edr_SentinelOne","kind":"json-schema","title":"edr | SentinelOne Endpoint","data":{"title":"edr | SentinelOne Endpoint","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for SentinelOne Singularity™ Endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/sentinelone-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SentinelOneCredential"},{"title":"Credential"}]},"edr_events_credential":{"allOf":[{"$ref":"#/components/schemas/SentinelOneEdrEventsCredential","nullable":true,"description":"Credential used for the SentinelOne Singularity Data Lake API. This credential is required when querying EDR events."},{"title":"Events Credential","description":"Credential used for the SentinelOne Singularity Data Lake API. This credential is required when querying EDR events."}]},"edr_events_url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the SentinelOne Singularity Data Lake API. This URL is required is required when querying EDR events."},{"example":"https://xdr.{region}.sentinelone.net"},{"title":"Events Base URL","description":"Base URL for the SentinelOne Singularity Data Lake API. This URL is required is required when querying EDR events."}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the SentinelOne TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the SentinelOne TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the SentinelOne Management API."},{"example":"https://{tenant}.sentinelone.net"},{"title":"Base URL","description":"Base URL for the SentinelOne Management API."}]}},"required":["credential","url"]}},"components/schemas/Edr_Sophos":{"id":"components/schemas/Edr_Sophos","kind":"json-schema","title":"edr | Sophos Endpoint","data":{"title":"edr | Sophos Endpoint","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Sophos Endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/sophos-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SophosCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Sophos Central API. Leave blank to discover the region automatically."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://api-us01.central.sophos.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Sophos Central API. Leave blank to discover the region automatically."}]}},"required":["credential"]}},"components/schemas/Edr_Tanium":{"id":"components/schemas/Edr_Tanium","kind":"json-schema","title":"edr | Tanium EDR","data":{"title":"edr | Tanium EDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tanium Cloud as a EDR Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tanium-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TaniumCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Tanium Cloud API"},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{customername}-api.cloud.tanium.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tanium Cloud API"}]}},"required":["credential","url"]}},"components/schemas/Edr_Trellix":{"id":"components/schemas/Edr_Trellix","kind":"json-schema","title":"edr | Trellix ePO","data":{"title":"edr | Trellix ePO","type":"object","description":"Configuration for Trellix ePolicy Orchestrator as an EDR provider. A tenant with only the Trellix EDR product enabled cannot use ePO-backed device queries.","properties":{"api_key":{"allOf":[{"$ref":"#/components/schemas/TrellixApiKeyCredential","description":"Tenant-scoped Trellix API key."},{"title":"API Key","description":"Tenant-scoped Trellix API key."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/TrellixCredential","description":"OAuth client credentials for a Trellix IAM client."},{"title":"Credential","description":"OAuth client credentials for a Trellix IAM client."}]},"tenant_id":{"allOf":[{"type":"string","description":"Trellix tenant GUID for the customer tenancy you want to query."},{"format":"uuid","example":"A1530A76-4B41-4756-8108-E7C3738222A1","x-validation-message":{"typeMismatch":"Must be a valid tenant GUID (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)."}},{"title":"Tenant ID","description":"Trellix tenant GUID for the customer tenancy you want to query."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for the Trellix ePO API. Only required for custom or proxied environments."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.manage.trellix.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL override for the Trellix ePO API. Only required for custom or proxied environments."}]}},"required":["api_key","credential","tenant_id"]}},"components/schemas/Edr_TrellixEns":{"id":"components/schemas/Edr_TrellixEns","kind":"json-schema","title":"edr | Trellix ENS","data":{"title":"edr | Trellix ENS","type":"object","description":"Configuration for Trellix Endpoint Security (ENS) via ePolicy Orchestrator. Use this provider for tenants running Trellix ENS rather than the Trellix EDR product.","properties":{"api_key":{"allOf":[{"$ref":"#/components/schemas/TrellixEnsApiKeyCredential","description":"Tenant-scoped Trellix API key."},{"title":"API Key","description":"Tenant-scoped Trellix API key."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/TrellixEnsCredential","description":"OAuth client credentials for a Trellix IAM client."},{"title":"Credential","description":"OAuth client credentials for a Trellix IAM client."}]},"tenant_id":{"allOf":[{"type":"string","description":"Trellix tenant GUID for the customer tenancy you want to query."},{"format":"uuid","example":"A1530A76-4B41-4756-8108-E7C3738222A1","x-validation-message":{"typeMismatch":"Must be a valid tenant GUID (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)."}},{"title":"Tenant ID","description":"Trellix tenant GUID for the customer tenancy you want to query."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for the Trellix ePO API. Only required for custom or proxied environments."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.manage.trellix.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL override for the Trellix ePO API. Only required for custom or proxied environments."}]}},"required":["api_key","credential","tenant_id"]}},"components/schemas/EdrCrowdStrikeDataset":{"id":"components/schemas/EdrCrowdStrikeDataset","kind":"json-schema","title":"EdrCrowdStrikeDataset","data":{"title":"EdrCrowdStrikeDataset","type":"string","enum":["basic_v0"]}},"components/schemas/ElasticsearchAuthOptions":{"id":"components/schemas/ElasticsearchAuthOptions","kind":"json-schema","title":"Elasticsearch Authentication Options","data":{"title":"Elasticsearch Authentication Options","type":"object","description":"Options used to control how requests are made to Elasticsearch when different authentication types are used.","properties":{"run_as":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Submit API requests as a specific user, with all of their roles and permissions. When populated, this option will send the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"es-security-runas-user"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header with every request made to the Elasticsearch API."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Run As","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Submit API requests as a specific user, with all of their roles and permissions. When populated, this option will send the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"es-security-runas-user"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header with every request made to the Elasticsearch API."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"shared_secret":{"allOf":[{"$ref":"#/components/schemas/ElasticsearchSharedSecret","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Some auth cases, notably JWT auth, can be configured to require sending a shared secret in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ES-Client-Authentication"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header. When this secret is populated it will get added as the shared secret for every request made to Elasticsearch."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Shared Secret","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Some auth cases, notably JWT auth, can be configured to require sending a shared secret in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ES-Client-Authentication"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header. When this secret is populated it will get added as the shared secret for every request made to Elasticsearch."},"children":[],"type":"text"}],"type":"paragraph"}]}]}}}},"components/schemas/ElasticsearchCredential":{"id":"components/schemas/ElasticsearchCredential","kind":"json-schema","title":"Elasticsearch Credential","data":{"title":"Elasticsearch Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Basic authentication credentials for Elasticsearch. It is recommended to use API keys or OAuth client credentials whenever possible."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"ElasticsearchCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"ElasticsearchCredential"}},{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"required":["token_url"],"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Client credentials and connection data for an identity provider (IdP) that has been configured for use as a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.elastic.co/guide/en/elasticsearch/reference/8.15/jwt-auth-realm.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"JWT realm"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in Elasticsearch. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.elastic.co/guide/en/cloud/current/ec-securing-clusters-JWT.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instructions for Elastic Cloud"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":".)"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Requires a Token URL for the third party identity provider. To send specific scopes during the client credentials OAuth flow, specify them in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"extra.scopes"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as a list of strings."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"ElasticsearchCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"ElasticsearchCredential"}},{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Elasticsearch API Key. Follow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.elastic.co/guide/en/kibana/current/api-keys.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this guide to generate an API Key"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The API Key must have sufficient permissions to the target index."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"ElasticsearchCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"ElasticsearchCredential"}}]}},"components/schemas/ElasticsearchSharedSecret":{"id":"components/schemas/ElasticsearchSharedSecret","kind":"json-schema","title":"Shared Secret","data":{"title":"Shared Secret","oneOf":[{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shared secret used to populate the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ES-Client-Authentication"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header during Elasticsearch requests."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Shared Secret","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"ElasticsearchSharedSecret"}},{"description":"Reference to existing Shared Secret.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Shared Secret","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"ElasticsearchSharedSecret"}}]}},"components/schemas/EmailSecurity_DefenderForOffice":{"id":"components/schemas/EmailSecurity_DefenderForOffice","kind":"json-schema","title":"emailsecurity | Microsoft Defender","data":{"title":"emailsecurity | Microsoft Defender","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Defender for Office 365."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/microsoft-defender-for-office-emailsecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DefenderCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/MicrosoftDefenderRegion","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Region used to determine the API endpoint. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"global"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"global"},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Region used to determine the API endpoint. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"global"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"tenant_id":{"allOf":[{"type":"string","description":"Tenant ID for the Microsoft Defender Management Console."},{"title":"Tenant ID","description":"Tenant ID for the Microsoft Defender Management Console."}]}},"required":["credential","tenant_id"]}},"components/schemas/EmailSecurity_DefenderForOffice_Mock":{"id":"components/schemas/EmailSecurity_DefenderForOffice_Mock","kind":"json-schema","title":"emailsecurity | [MOCK] Microsoft Defender for Office 365","data":{"title":"emailsecurity | [MOCK] Microsoft Defender for Office 365","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] Microsoft Defender for Office 365."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/EmailSecurityDefenderForOfficeDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/EmailSecurity_ExchangeOnline":{"id":"components/schemas/EmailSecurity_ExchangeOnline","kind":"json-schema","title":"emailsecurity | Microsoft Exchange Online","data":{"title":"emailsecurity | Microsoft Exchange Online","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Exchange Online."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/exchange-online-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ExchangeOnlineCredential"},{"title":"Credential"}]},"tenant_id":{"allOf":[{"type":"string","description":"Microsoft Entra tenant ID for the Exchange Online organization."},{"title":"Tenant ID","description":"Microsoft Entra tenant ID for the Exchange Online organization."}]}},"required":["credential","tenant_id"]}},"components/schemas/EmailSecurity_Ironscales":{"id":"components/schemas/EmailSecurity_Ironscales","kind":"json-schema","title":"emailsecurity | Ironscales","data":{"title":"emailsecurity | Ironscales","type":"object","description":"Configuration for Ironscales as an email security provider.","properties":{"company_id":{"allOf":[{"type":"string","description":"Ironscales company ID."},{"title":"Company ID","description":"Ironscales company ID."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/IronscalesCredential","description":"Credentials for the Ironscales App API."},{"title":"Credential","description":"Credentials for the Ironscales App API."}]},"region":{"allOf":[{"$ref":"#/components/schemas/IronscalesRegion","description":"Region of the Ironscales portal."},{"title":"Region","description":"Region of the Ironscales portal."}]}},"required":["company_id","credential","region"]}},"components/schemas/EmailSecurity_MimecastCloudGateway":{"id":"components/schemas/EmailSecurity_MimecastCloudGateway","kind":"json-schema","title":"emailsecurity | Mimecast Cloud Gateway","data":{"title":"emailsecurity | Mimecast Cloud Gateway","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Mimecast Cloud Gateway as an email security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/mimecast-cloud-gateway-emailsecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"api_gateway":{"allOf":[{"$ref":"#/components/schemas/MimecastAPIGateway","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option to override the Mimecast Cloud Gateway API region. If not specified this defaults to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"global"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" region. For more information, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://developer.services.mimecast.com/api-overview#api-gateway-options"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Mimecast API Gateway documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"API Gateway","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option to override the Mimecast Cloud Gateway API region. If not specified this defaults to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"global"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" region. For more information, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://developer.services.mimecast.com/api-overview#api-gateway-options"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Mimecast API Gateway documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/MimecastCloudGatewayCredential","description":"Credentials for the Mimecast Cloud Gateway API."},{"title":"Credential","description":"Credentials for the Mimecast Cloud Gateway API."}]}},"required":["credential"]}},"components/schemas/EmailSecurity_MimecastCloudGateway_Mock":{"id":"components/schemas/EmailSecurity_MimecastCloudGateway_Mock","kind":"json-schema","title":"emailsecurity | [MOCK] Mimecast Cloud Gateway","data":{"title":"emailsecurity | [MOCK] Mimecast Cloud Gateway","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] Mimecast Cloud Gateway."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/EmailSecurityMimecastCloudGatewayDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/EmailSecurity_O365ManagementActivity":{"id":"components/schemas/EmailSecurity_O365ManagementActivity","kind":"json-schema","title":"emailsecurity | Microsoft 365 Management Activity","data":{"title":"emailsecurity | Microsoft 365 Management Activity","type":"object","description":"Configuration for Microsoft 365 Management Activity as an Email Security provider.","properties":{"cloud":{"allOf":[{"$ref":"#/components/schemas/O365ManagementActivityCloud","nullable":true,"description":"Microsoft 365 cloud that hosts the tenant."},{"default":"global"},{"title":"Cloud","description":"Microsoft 365 cloud that hosts the tenant."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/O365ManagementActivityCredential"},{"title":"Credential"}]},"operations":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"Audit operations to report."},{"default":["Send","SendAs","SendOnBehalf","MipLabel"]},{"title":"Operations","description":"Audit operations to report."}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure Directory (tenant) identifier."},{"format":"uuid","example":"f81d4fae-7dec-11d0-a765-00a0c91e6bf6","x-validation-message":{"typeMismatch":"Must be a valid tenant GUID (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)."}},{"title":"Tenant ID","description":"Azure Directory (tenant) identifier."}]}},"required":["credential","tenant_id"]}},"components/schemas/EmailSecurityDefenderForOfficeDataset":{"id":"components/schemas/EmailSecurityDefenderForOfficeDataset","kind":"json-schema","title":"EmailSecurityDefenderForOfficeDataset","data":{"title":"EmailSecurityDefenderForOfficeDataset","type":"string","enum":["basic_v0"]}},"components/schemas/EmailSecurityMimecastCloudGatewayDataset":{"id":"components/schemas/EmailSecurityMimecastCloudGatewayDataset","kind":"json-schema","title":"EmailSecurityMimecastCloudGatewayDataset","data":{"title":"EmailSecurityMimecastCloudGatewayDataset","type":"string","enum":["basic_v0"]}},"components/schemas/Endpointmanagement_Automox":{"id":"components/schemas/Endpointmanagement_Automox","kind":"json-schema","title":"endpointmanagement | Automox","data":{"title":"endpointmanagement | Automox","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Automox."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/automox-endpointmgmt-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AutomoxApiKeyCredential"},{"title":"API Key"}]},"org_id":{"allOf":[{"type":"string","description":"Automox organization ID."},{"title":"Organization ID","description":"Automox organization ID."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Automox Console API. Override for proxied or custom environments."},{"default":"https://console.automox.com"},{"title":"Base URL","description":"Base URL for the Automox Console API. Override for proxied or custom environments."}]}},"required":["credential","org_id"]}},"components/schemas/Endpointmanagement_Bigfix":{"id":"components/schemas/Endpointmanagement_Bigfix","kind":"json-schema","title":"endpointmanagement | HCL BigFix","data":{"title":"endpointmanagement | HCL BigFix","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for HCL BigFix."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/bigfix-endpointmanagement-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/BigFixCredential"},{"title":"Credential"}]},"skip_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"Skip TLS certificate verification. Enable only when the server uses a self-signed or internally-issued certificate."},{"title":"Skip TLS Verification","description":"Skip TLS certificate verification. Enable only when the server uses a self-signed or internally-issued certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL of the BigFix server's REST API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://bigfix.example.com:8443","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL of the BigFix server's REST API."}]}},"required":["credential","url"]}},"components/schemas/Endpointmanagement_Intune":{"id":"components/schemas/Endpointmanagement_Intune","kind":"json-schema","title":"endpointmanagement | Microsoft Intune","data":{"title":"endpointmanagement | Microsoft Intune","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Intune."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/intune-endpointmgmt-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IntuneCredential"},{"title":"Credential"}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure Directory (tenant) identifier."},{"title":"Tenant ID","description":"Azure Directory (tenant) identifier."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Microsoft Graph API. Override for national cloud deployments."},{"default":"https://graph.microsoft.com"},{"title":"Base URL","description":"Base URL for the Microsoft Graph API. Override for national cloud deployments."}]}},"required":["credential","tenant_id"]}},"components/schemas/Endpointmanagement_Iru":{"id":"components/schemas/Endpointmanagement_Iru","kind":"json-schema","title":"endpointmanagement | Iru","data":{"title":"endpointmanagement | Iru","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Iru."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/iru-endpointmgmt-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IruCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Iru API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{tenant}.api.kandji.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Iru API."}]}},"required":["credential","url"]}},"components/schemas/Endpointmanagement_Jamf":{"id":"components/schemas/Endpointmanagement_Jamf","kind":"json-schema","title":"endpointmanagement | Jamf Pro","data":{"title":"endpointmanagement | Jamf Pro","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Jamf Pro."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/jamf-endpointmgmt-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/JamfCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Jamf Pro instance."},{"example":"https://yourorg.jamfcloud.com"},{"title":"Base URL","description":"Base URL for the Jamf Pro instance."}]}},"required":["credential","url"]}},"components/schemas/Endpointmanagement_Ninjaone":{"id":"components/schemas/Endpointmanagement_Ninjaone","kind":"json-schema","title":"endpointmanagement | NinjaOne","data":{"title":"endpointmanagement | NinjaOne","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for NinjaOne."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/ninjaone-endpointmanagement-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/NinjaOneCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/NinjaOneRegion","description":"NinjaOne instance region. Determines the base URL for API requests."},{"title":"Region","description":"NinjaOne instance region. Determines the base URL for API requests."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for custom or proxied environments. When set, the region field is ignored."},{"title":"Base URL","description":"Base URL override for custom or proxied environments. When set, the region field is ignored."}]}},"required":["credential","region"]}},"components/schemas/EntraIdCredential":{"id":"components/schemas/EntraIdCredential","kind":"json-schema","title":"Entra Id Credential","data":{"title":"Entra Id Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Client ID and Client Secret for an Azure service principal with access to Microsoft Graph. To use risk and risky-user features, the service principal also needs Identity Protection permissions (requires a Microsoft Entra ID P2 license). See the setup guide for the full list of required permissions."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"EntraIdCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"EntraIdCredential"}},{"allOf":[{"properties":{"type":{"enum":["o_auth_code"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthCodeCredential"},{"type":"object","properties":{},"description":"Install a pre-registered Entra ID app in your tenant through an administrator's consent, instead of supplying a client ID and secret. Not available with a bridge, a custom Base URL, or the GCC High and DoD clouds."}],"required":["type"],"title":"New Entra ID App","type":"object","x-fern-availability":"in-development","x-synqly-credential":{"extends":"OAuthCodeCredential","type":"EntraIdCredential"},"x-synqly-hidden":true},{"description":"Reference to existing Entra ID App.","properties":{"type":{"enum":["o_auth_code_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthCodeCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Entra ID App","type":"object","x-fern-availability":"in-development","x-synqly-credential":{"extends":"OAuthCodeCredentialId","reference":true,"type":"EntraIdCredential"},"x-synqly-hidden":true}]}},"components/schemas/ExchangeOnlineCredential":{"id":"components/schemas/ExchangeOnlineCredential","kind":"json-schema","title":"Exchange Online Credential","data":{"title":"Exchange Online Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Microsoft Entra application (client) ID and secret for a service principal with the ExchangeMessageTrace.Read.All application permission."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"ExchangeOnlineCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"ExchangeOnlineCredential"}}]}},"components/schemas/FreshdeskCredential":{"id":"components/schemas/FreshdeskCredential","kind":"json-schema","title":"Freshdesk Credential","data":{"title":"Freshdesk Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"You can use your personal API key to authenticate the request. If you use the API key, there is no need for a password. The token is supplied as \"Your API Key\". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://developer.freshdesk.com/api/#authentication"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Freshdesk API token generation documentation"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}]}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"FreshdeskCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"FreshdeskCredential"}}]}},"components/schemas/GCSCredential":{"id":"components/schemas/GCSCredential","kind":"json-schema","title":"GCSCredential","data":{"title":"GCSCredential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["aws"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AwsCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS like credential that stores "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://cloud.google.com/storage/docs/authentication/hmackeys"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"hash-based message authentication code (HMAC) keys"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with write access to the GCS bucket."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New AWS Access Keys","type":"object","x-synqly-credential":{"extends":"AwsCredential","type":"GCSCredential"}},{"description":"Reference to existing AWS Access Keys.","properties":{"type":{"enum":["aws_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/AwsCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing AWS Access Keys","type":"object","x-synqly-credential":{"extends":"AwsCredentialId","reference":true,"type":"GCSCredential"}}]}},"components/schemas/GCSJsonCredential":{"id":"components/schemas/GCSJsonCredential","kind":"json-schema","title":"GCSJson Credential","data":{"title":"GCSJson Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"GCSJsonCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"GCSJsonCredential"}}]}},"components/schemas/GitHubCredential":{"id":"components/schemas/GitHubCredential","kind":"json-schema","title":"Git Hub Credential","data":{"title":"Git Hub Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"GitHubCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"GitHubCredential"}}]}},"components/schemas/GitLabCredential":{"id":"components/schemas/GitLabCredential","kind":"json-schema","title":"Git Lab Credential","data":{"title":"Git Lab Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"GitLabCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"GitLabCredential"}}]}},"components/schemas/GoogleChronicleCredential":{"id":"components/schemas/GoogleChronicleCredential","kind":"json-schema","title":"Google Chronicle Credential","data":{"title":"Google Chronicle Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"required":["extra"],"type":"object","properties":{"extra":{"title":"Extra","required":["client_email"],"properties":{"client_email":{"title":"Client Email","type":"string"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connection specific JSON map, must include the field "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"client_email"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"token_url":{"title":"Token URL"}},"description":"OAuth client credentials for a Google Cloud Service Account with permissions for Google Security Operations (formerly Google Chronicle)."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"GoogleChronicleCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"GoogleChronicleCredential"}}]}},"components/schemas/GoogleCredential":{"id":"components/schemas/GoogleCredential","kind":"json-schema","title":"Google Credential","data":{"title":"Google Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"extra":{"title":"Extra","properties":{"scopes":{"default":["https://www.googleapis.com/auth/cloud-platform","https://www.googleapis.com/auth/admin.directory.group","https://www.googleapis.com/auth/admin.directory.user","https://www.googleapis.com/auth/admin.directory.user.security","https://www.googleapis.com/auth/admin.reports.audit.readonly"],"description":"List of OAuth scopes to request. Defaults to the full set of scopes required for all Google Workspace identity operations. Override this to request a reduced set of scopes. Some operations may fail if the scopes they require are missing. This setting should exactly match the scopes allowed for domain-wide delegation with the service account.","items":{"type":"string"},"title":"OAuth Scopes","type":"array"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional connection-specific configuration. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"scopes"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to override the default OAuth scopes requested during authentication."},"children":[],"type":"text"}],"type":"paragraph"}],"nullable":true}},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"GoogleCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"GoogleCredential"}}]}},"components/schemas/GoogleServiceAccountCredential":{"id":"components/schemas/GoogleServiceAccountCredential","kind":"json-schema","title":"Google Service Account Credential","data":{"title":"Google Service Account Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"required":["extra"],"type":"object","properties":{"extra":{"title":"Extra","required":["client_email"],"properties":{"client_email":{"title":"Client Email","type":"string"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connection specific JSON map, must include the field "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"client_email"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"token_url":{"title":"Token URL"}},"description":"OAuth client credentials for a Google Cloud Service Account with permissions for Google Security Operations."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"GoogleServiceAccountCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"GoogleServiceAccountCredential"}}]}},"components/schemas/Grc_Drata":{"id":"components/schemas/Grc_Drata","kind":"json-schema","title":"grc | Drata","data":{"title":"grc | Drata","type":"object","description":"Configuration for Drata as a GRC provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DrataCredential","description":"Credentials used for accessing the Drata API."},{"title":"Credential","description":"Credentials used for accessing the Drata API."}]},"region":{"allOf":[{"$ref":"#/components/schemas/DrataRegion","description":"The Drata data region that hosts this organization's tenant."},{"title":"Data Region","description":"The Drata data region that hosts this organization's tenant."}]}},"required":["credential","region"]}},"components/schemas/Grc_Secureframe":{"id":"components/schemas/Grc_Secureframe","kind":"json-schema","title":"grc | Secureframe","data":{"title":"grc | Secureframe","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Secureframe as a GRC provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/secureframe-grc-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SecureframeCredential","description":"Credentials used for accessing the Secureframe API."},{"title":"Credential","description":"Credentials used for accessing the Secureframe API."}]},"region":{"allOf":[{"$ref":"#/components/schemas/SecureframeRegion","description":"The Secureframe data region that hosts this organization's tenant."},{"title":"Data Region","description":"The Secureframe data region that hosts this organization's tenant."}]}},"required":["credential","region"]}},"components/schemas/GreenhouseCredential":{"id":"components/schemas/GreenhouseCredential","kind":"json-schema","title":"Greenhouse Credential","data":{"title":"Greenhouse Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"extra":{"title":"Extra","properties":{"sub":{"description":"Greenhouse User ID that API requests are attributed to.","example":"12345","pattern":"^\\s*(?:\\d+|https?:\\/\\/(?:[a-z0-9-]+\\.)?greenhouse\\.io\\/account\\/users\\/\\d+(?:\\/.*)?)?\\s*$","title":"User ID","type":"string","x-validation-message":{"patternMismatch":"Must be a valid User ID (`12345`) or Greenhouse user URL (`https://app.greenhouse.io/account/users/12345`)."}}},"description":"Optional connection-specific JSON map. Sets the Greenhouse User ID that requests should be attributed to.","nullable":true},"token_url":{"title":"Token URL","pattern":"^(https?:.+|synqly:.+)$","description":"Greenhouse OAuth token URL. Defaults to https://auth.greenhouse.io/token.","format":"uri","example":"https://auth.greenhouse.io/token","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}}},"description":"Greenhouse Harvest v3 OAuth client credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"GreenhouseCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"GreenhouseCredential"}}]}},"components/schemas/HCLAppScanOnCloudCredential":{"id":"components/schemas/HCLAppScanOnCloudCredential","kind":"json-schema","title":"HCLApp Scan On Cloud Credential","data":{"title":"HCLApp Scan On Cloud Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"HCLAppScanOnCloudCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"HCLAppScanOnCloudCredential"}}]}},"components/schemas/HCLAppScanOnCloudUrl":{"id":"components/schemas/HCLAppScanOnCloudUrl","kind":"json-schema","title":"HCLAppScanOnCloudUrl","data":{"title":"HCLAppScanOnCloudUrl","type":"string","enum":["https://cloud.appscan.com","https://eu.cloud.appscan.com"]}},"components/schemas/Horizon3Credential":{"id":"components/schemas/Horizon3Credential","kind":"json-schema","title":"Horizon3Credential","data":{"title":"Horizon3Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Horizon3 NodeZero API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"Horizon3Credential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"Horizon3Credential"}}]}},"components/schemas/Horizon3Region":{"id":"components/schemas/Horizon3Region","kind":"json-schema","title":"Horizon3Region","data":{"title":"Horizon3Region","type":"string","enum":["us","eu"]}},"components/schemas/HttpIngest":{"id":"components/schemas/HttpIngest","kind":"json-schema","title":"HttpIngest","data":{"title":"HttpIngest","type":"object","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PantherIngestionCredential","description":"Authenticates calls to your HTTP Ingest log source."},{"title":"Authentication","description":"Authenticates calls to your HTTP Ingest log source."}]},"url":{"allOf":[{"type":"string","description":"The URL for your HTTP Log Source."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://logs.instance-id.runpanther.net/http/log-source-id","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Ingest URL","description":"The URL for your HTTP Log Source."}]}},"required":["credential","url"]}},"components/schemas/HttpReceiverAuthConfig":{"id":"components/schemas/HttpReceiverAuthConfig","kind":"json-schema","title":"HttpReceiverAuthConfig","data":{"title":"HttpReceiverAuthConfig","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["basic_config"]}}},{"$ref":"#/components/schemas/HttpReceiverBasicAuthConfig"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["o_auth_client_config"]}}},{"$ref":"#/components/schemas/HttpReceiverOAuthConfig"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["token_config"]}}},{"$ref":"#/components/schemas/HttpReceiverTokenAuthConfig"}],"required":["type"]}]}},"components/schemas/HttpReceiverBasicAuthConfig":{"id":"components/schemas/HttpReceiverBasicAuthConfig","kind":"json-schema","title":"Basic Authorization","data":{"title":"Basic Authorization","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Standard HTTP Basic authentication (RFC 7617). Credentials are sent in the Authorization header as Base64-encoded "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"username:password"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverBasicCredential"},{"title":"Basic Credentials"}]}},"required":["credential"]}},"components/schemas/HttpReceiverBasicCredential":{"id":"components/schemas/HttpReceiverBasicCredential","kind":"json-schema","title":"Http Receiver Basic Credential","data":{"title":"Http Receiver Basic Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Basic Credentials."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"HttpReceiverBasicCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"HttpReceiverBasicCredential"}}]}},"components/schemas/HttpReceiverMethod":{"id":"components/schemas/HttpReceiverMethod","kind":"json-schema","title":"HTTP Method","data":{"title":"HTTP Method","type":"string","enum":["POST","PUT","PATCH","GET"],"description":"HTTP method to use for sending events."}},"components/schemas/HttpReceiverOAuthConfig":{"id":"components/schemas/HttpReceiverOAuthConfig","kind":"json-schema","title":"OAuth Client Credentials","data":{"title":"OAuth Client Credentials","type":"object","description":"OAuth 2.0 client credentials flow (RFC 6749) for service-to-service authentication.","properties":{"auth_style":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverOAuthStyle","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How to send client credentials when requesting OAuth access tokens:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in_header"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Send client credentials via HTTP Basic authentication. This is the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"recommended and most secure method"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", used by most modern OAuth 2.0 providers."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in_params"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Send client credentials URL-encoded in the request body as form parameters. Required by some legacy OAuth servers and specific provider implementations. Consult your OAuth provider documentation for details."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},{"default":"in_header"},{"title":"Auth Style","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How to send client credentials when requesting OAuth access tokens:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in_header"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Send client credentials via HTTP Basic authentication. This is the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"recommended and most secure method"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", used by most modern OAuth 2.0 providers."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in_params"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Send client credentials URL-encoded in the request body as form parameters. Required by some legacy OAuth servers and specific provider implementations. Consult your OAuth provider documentation for details."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverOAuthCredential"},{"title":"Client Credentials"}]},"endpoint_params":{"allOf":[{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Additional parameters to include in OAuth token request"},{"example":{"audience":"https://api.example.com","resource":"https://graph.example.com"}},{"title":"Endpoint Parameters","description":"Additional parameters to include in OAuth token request"}]},"scopes":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"OAuth2 scopes to request when fetching access token"},{"example":["https://api.example.com/.default","events.write"]},{"title":"Scopes","description":"OAuth2 scopes to request when fetching access token"}]}},"required":["credential"]}},"components/schemas/HttpReceiverOAuthCredential":{"id":"components/schemas/HttpReceiverOAuthCredential","kind":"json-schema","title":"Http Receiver OAuth Credential","data":{"title":"Http Receiver OAuth Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"HttpReceiverOAuthCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"HttpReceiverOAuthCredential"}}]}},"components/schemas/HttpReceiverOAuthStyle":{"id":"components/schemas/HttpReceiverOAuthStyle","kind":"json-schema","title":"OAuth Style","data":{"title":"OAuth Style","type":"string","enum":["in_header","in_params"],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How to send client credentials when requesting OAuth access tokens:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in_header"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Send client credentials via HTTP Basic authentication. This is the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"recommended and most secure method"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", used by most modern OAuth 2.0 providers."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in_params"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Send client credentials URL-encoded in the request body as form parameters. Required by some legacy OAuth servers and specific provider implementations. Consult your OAuth provider documentation for details."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}},"components/schemas/HttpReceiverSigningCredential":{"id":"components/schemas/HttpReceiverSigningCredential","kind":"json-schema","title":"Payload Signing Credential","data":{"title":"Payload Signing Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{"secret":{"title":"HMAC-SHA256 Signing Secret","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Secret key for signing HTTP request payloads using HMAC-SHA256. The signature is computed over the request body and sent in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"X-Synqly-Signature"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header with format "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sha256={hex_signature}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}},"description":"Configuration when creating new Secret."}],"required":["type"],"title":"New Secret","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"HttpReceiverSigningCredential"}},{"description":"Reference to existing Secret.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Secret","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"HttpReceiverSigningCredential"}}]}},"components/schemas/HttpReceiverTokenAuthConfig":{"id":"components/schemas/HttpReceiverTokenAuthConfig","kind":"json-schema","title":"Token Authorization","data":{"title":"Token Authorization","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Token-based authentication for API keys, bearer tokens, and custom token schemes. By default, sends token in Authorization header as a Bearer token. Use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Header Name"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Template"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" options to override this behavior."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverTokenCredential"},{"title":"Token Credential"}]},"header_name":{"allOf":[{"type":"string","nullable":true,"description":"HTTP header name to use when sending the token."},{"default":"Authorization","example":"X-API-Key"},{"title":"Header Name","description":"HTTP header name to use when sending the token."}]},"template":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Template to use when building the HTTP header value. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{{token}}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as a placeholder for the secret token value. This will be substituted at runtime. Do not store any secrets in this field."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"Bearer {{token}}","example":"ApiKey {{token}}"},{"title":"Header Value Template","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Template to use when building the HTTP header value. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{{token}}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as a placeholder for the secret token value. This will be substituted at runtime. Do not store any secrets in this field."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/HttpReceiverTokenCredential":{"id":"components/schemas/HttpReceiverTokenCredential","kind":"json-schema","title":"Http Receiver Token Credential","data":{"title":"Http Receiver Token Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"HttpReceiverTokenCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"HttpReceiverTokenCredential"}}]}},"components/schemas/HttpRequestBodyFormat":{"id":"components/schemas/HttpRequestBodyFormat","kind":"json-schema","title":"Body Format","data":{"title":"Body Format","type":"string","enum":["jsonl","json_array"],"description":"Format for serializing events in the request body sent to the receiving endpoint."}},"components/schemas/HuntressCredential":{"id":"components/schemas/HuntressCredential","kind":"json-schema","title":"Huntress Credential","data":{"title":"Huntress Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"API Secret Key","pattern":"^hs_.+$","description":"The Huntress API secret key.","x-validation-message":{"patternMismatch":"Huntress API secret key must start with `hs_`."}},"username":{"title":"API Key","pattern":"^hk_.+$","description":"The Huntress API key.","x-validation-message":{"patternMismatch":"Huntress API key must start with `hk_`."}}},"description":"Configuration when creating new Basic Credentials."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"HuntressCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"HuntressCredential"}}]}},"components/schemas/Identity_Ashby":{"id":"components/schemas/Identity_Ashby","kind":"json-schema","title":"identity | Ashby Identity","data":{"title":"identity | Ashby Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Ashby Identity."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/ashby-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AshbyCredential"},{"title":"Credential"}]}},"required":["credential"]}},"components/schemas/Identity_AwsIam":{"id":"components/schemas/Identity_AwsIam","kind":"json-schema","title":"identity | AWS IAM Identity","data":{"title":"identity | AWS IAM Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lists IAM users and groups, and queries CloudTrail management events for audit logs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-iam-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion"},{"title":"Region"}]}},"required":["credential","region"]}},"components/schemas/Identity_CrowdStrike":{"id":"components/schemas/Identity_CrowdStrike","kind":"json-schema","title":"identity | CrowdStrike Falcon Identity Protection","data":{"title":"identity | CrowdStrike Falcon Identity Protection","type":"object","description":"Configuration for CrowdStrike Falcon Identity Protection.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdStrikeCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the CrowdStrike Falcon API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.crowdstrike.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the CrowdStrike Falcon API."}]}},"required":["credential"]}},"components/schemas/Identity_CrowdStrike_Mock":{"id":"components/schemas/Identity_CrowdStrike_Mock","kind":"json-schema","title":"identity | [MOCK] CrowdStrike Falcon Identity Protection","data":{"title":"identity | [MOCK] CrowdStrike Falcon Identity Protection","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] CrowdStrike Falcon Identity Protection."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/IdentityCrowdStrikeDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Identity_DuoSecurity":{"id":"components/schemas/Identity_DuoSecurity","kind":"json-schema","title":"identity | Duo Security Identity","data":{"title":"identity | Duo Security Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Duo Security Identity."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/duosecurity-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DuoSecurityCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL of the Duo Admin API."},{"example":"https://api-XXXXXXXX.duosecurity.com"},{"title":"Base URL","description":"Base URL of the Duo Admin API."}]}},"required":["credential","url"]}},"components/schemas/Identity_EntraId":{"id":"components/schemas/Identity_EntraId","kind":"json-schema","title":"identity | Microsoft Entra ID","data":{"title":"identity | Microsoft Entra ID","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Entra ID."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/entra-id-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/EntraIdCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/MicrosoftDefenderRegion","nullable":true,"description":"Government cloud selector."},{"default":"global"},{"title":"Region","description":"Government cloud selector."}]},"tenant_id":{"allOf":[{"type":"string","nullable":true,"description":"The Directory (tenant) ID of your Microsoft Entra tenant, shown on the Overview page of Microsoft Entra ID in the Azure portal. With a client ID and secret, a verified domain of the tenant also works. When you install the Entra ID App, the tenant ID is optional. If the app is already installed in that tenant, the integration uses it without asking an administrator to consent again. Otherwise, the administrator must consent in that tenant. After the app is installed, the tenant cannot be changed."},{"title":"Tenant ID","description":"The Directory (tenant) ID of your Microsoft Entra tenant, shown on the Overview page of Microsoft Entra ID in the Azure portal. With a client ID and secret, a verified domain of the tenant also works. When you install the Entra ID App, the tenant ID is optional. If the app is already installed in that tenant, the integration uses it without asking an administrator to consent again. Otherwise, the administrator must consent in that tenant. After the app is installed, the tenant cannot be changed."},{"x-synqly-capabilities-required":true}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the the Microsoft Graph API."},{"title":"Base URL","description":"Base URL for the the Microsoft Graph API."}]}},"required":["credential"]}},"components/schemas/Identity_EntraId_Mock":{"id":"components/schemas/Identity_EntraId_Mock","kind":"json-schema","title":"identity | [MOCK] Microsoft Entra ID","data":{"title":"identity | [MOCK] Microsoft Entra ID","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] Microsoft Entra ID."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/IdentityEntraIdDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Identity_GitHub":{"id":"components/schemas/Identity_GitHub","kind":"json-schema","title":"identity | GitHub Identity","data":{"title":"identity | GitHub Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for GitHub as an identity provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/github-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GitHubCredential","description":"Credentials used for accessing the GitHub API."},{"title":"Credential","description":"Credentials used for accessing the GitHub API."}]},"organization_slug":{"allOf":[{"type":"string","description":"GitHub organization slug."},{"example":"my-github-organization"},{"title":"Organization Slug","description":"GitHub organization slug."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the GitHub environment. Required for GitHub Enterprise Server deployments."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://github.com","example":"https://your-github-instance.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the GitHub environment. Required for GitHub Enterprise Server deployments."}]}},"required":["credential","organization_slug"]}},"components/schemas/Identity_Google":{"id":"components/schemas/Identity_Google","kind":"json-schema","title":"identity | Google Workspace","data":{"title":"identity | Google Workspace","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Workspace."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-workspace-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"client_email":{"allOf":[{"type":"string","description":"Client email associated with the service account key."},{"example":"{service-account-name}@{project-id}.iam.gserviceaccount.com"},{"title":"Client Email","description":"Client email associated with the service account key."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/GoogleCredential"},{"title":"Credential"}]},"delegate":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Email address of the user that the service account is impersonating for domain-wide delegation. For more information, see "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://support.google.com/a/answer/162106"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this Google support article"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Delegate","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Email address of the user that the service account is impersonating for domain-wide delegation. For more information, see "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://support.google.com/a/answer/162106"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this Google support article"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional base URL override for the Google Workspace Admin APIs. Give the root only — the Directory and Reports paths are appended for you. Leave empty to use Google's standard endpoints."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://admin.googleapis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional base URL override for the Google Workspace Admin APIs. Give the root only — the Directory and Reports paths are appended for you. Leave empty to use Google's standard endpoints."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["client_email","credential","delegate"]}},"components/schemas/Identity_Google_Mock":{"id":"components/schemas/Identity_Google_Mock","kind":"json-schema","title":"identity | [MOCK] Google Workspace","data":{"title":"identity | [MOCK] Google Workspace","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] Google Workspace."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/IdentityGoogleDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Identity_Greenhouse":{"id":"components/schemas/Identity_Greenhouse","kind":"json-schema","title":"identity | Greenhouse Identity","data":{"title":"identity | Greenhouse Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Greenhouse Identity."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/greenhouse-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GreenhouseCredential"},{"title":"Credential"}]}},"required":["credential"]}},"components/schemas/Identity_Okta":{"id":"components/schemas/Identity_Okta","kind":"json-schema","title":"identity | Okta Identity","data":{"title":"identity | Okta Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Okta Identity."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/okta-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/OktaCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Okta API."},{"example":"https://{tenant}.okta.com"},{"title":"Base URL","description":"Base URL for the Okta API."}]}},"required":["credential","url"]}},"components/schemas/Identity_Okta_Mock":{"id":"components/schemas/Identity_Okta_Mock","kind":"json-schema","title":"identity | [MOCK] Okta Identity","data":{"title":"identity | [MOCK] Okta Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] Okta Identity."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/IdentityOktaDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Identity_PingOne":{"id":"components/schemas/Identity_PingOne","kind":"json-schema","title":"identity | PingOne Cloud Platform","data":{"title":"identity | PingOne Cloud Platform","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for PingOne Cloud Platform."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/ping-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"auth_url":{"allOf":[{"$ref":"#/components/schemas/PingOneAuthURL","description":"Base URL for making authentication requests to PingOne."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://auth.pingone.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Auth URL","description":"Base URL for making authentication requests to PingOne."}]},"client_id":{"allOf":[{"type":"string","description":"Client ID for the application set up as a worker."},{"title":"Client ID","description":"Client ID for the application set up as a worker."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/PingOneCredential"},{"title":"Credential"}]},"organization_id":{"allOf":[{"type":"string","description":"The PingOne environment ID that the worker application belongs to."},{"title":"Organization ID","description":"The PingOne environment ID that the worker application belongs to."}]},"url":{"allOf":[{"$ref":"#/components/schemas/PingOneAPIURL","description":"Base URL for the PingOne API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.pingone.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the PingOne API."}]}},"required":["auth_url","client_id","credential","organization_id","url"]}},"components/schemas/Identity_PingOne_Mock":{"id":"components/schemas/Identity_PingOne_Mock","kind":"json-schema","title":"identity | [MOCK] PingOne Cloud Platform","data":{"title":"identity | [MOCK] PingOne Cloud Platform","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] PingOne Cloud Platform."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/IdentityPingOneDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Identity_Workday":{"id":"components/schemas/Identity_Workday","kind":"json-schema","title":"identity | Workday Identity","data":{"title":"identity | Workday Identity","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Workday Identity."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/workday-identity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/WorkdayCredential"},{"title":"Credential"}]}},"required":["credential"]}},"components/schemas/IdentityCrowdStrikeDataset":{"id":"components/schemas/IdentityCrowdStrikeDataset","kind":"json-schema","title":"IdentityCrowdStrikeDataset","data":{"title":"IdentityCrowdStrikeDataset","type":"string","enum":["basic_v0"]}},"components/schemas/IdentityEntraIdDataset":{"id":"components/schemas/IdentityEntraIdDataset","kind":"json-schema","title":"IdentityEntraIdDataset","data":{"title":"IdentityEntraIdDataset","type":"string","enum":["basic_v0"]}},"components/schemas/IdentityGoogleDataset":{"id":"components/schemas/IdentityGoogleDataset","kind":"json-schema","title":"IdentityGoogleDataset","data":{"title":"IdentityGoogleDataset","type":"string","enum":["basic_v0"]}},"components/schemas/IdentityOktaDataset":{"id":"components/schemas/IdentityOktaDataset","kind":"json-schema","title":"IdentityOktaDataset","data":{"title":"IdentityOktaDataset","type":"string","enum":["basic_v0"]}},"components/schemas/IdentityPingOneDataset":{"id":"components/schemas/IdentityPingOneDataset","kind":"json-schema","title":"IdentityPingOneDataset","data":{"title":"IdentityPingOneDataset","type":"string","enum":["basic_v0"]}},"components/schemas/IncidentIOCredential":{"id":"components/schemas/IncidentIOCredential","kind":"json-schema","title":"Incident IOCredential","data":{"title":"Incident IOCredential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"IncidentIOCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"IncidentIOCredential"}}]}},"components/schemas/IncidentResponse_IncidentIO":{"id":"components/schemas/IncidentResponse_IncidentIO","kind":"json-schema","title":"incidentresponse | incident.io","data":{"title":"incidentresponse | incident.io","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for incident.io as an Incident Response Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/incident-io-incident-response-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IncidentIOCredential","description":"Credential used for accessing the incident.io API."},{"title":"Credential","description":"Credential used for accessing the incident.io API."}]}},"required":["credential"]}},"components/schemas/IncidentResponse_PagerDuty":{"id":"components/schemas/IncidentResponse_PagerDuty","kind":"json-schema","title":"incidentresponse | PagerDuty","data":{"title":"incidentresponse | PagerDuty","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for PagerDuty as an incident response provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/pagerduty-incident-response-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PagerDutyCredential"},{"title":"Credential"}]}},"required":["credential"]}},"components/schemas/IntuneCredential":{"id":"components/schemas/IntuneCredential","kind":"json-schema","title":"Intune Credential","data":{"title":"Intune Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Azure Client ID and Client Secret for a service principal with Intune device management permissions."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"IntuneCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"IntuneCredential"}}]}},"components/schemas/IronscalesCredential":{"id":"components/schemas/IronscalesCredential","kind":"json-schema","title":"Ironscales Credential","data":{"title":"Ironscales Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"IronscalesCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"IronscalesCredential"}}]}},"components/schemas/IronscalesRegion":{"id":"components/schemas/IronscalesRegion","kind":"json-schema","title":"IronscalesRegion","data":{"title":"IronscalesRegion","type":"string","enum":["US","CA","EU","UAE"]}},"components/schemas/IruCredential":{"id":"components/schemas/IruCredential","kind":"json-schema","title":"API Token","data":{"title":"API Token","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Token","description":"The API token for authenticating with the Iru API."}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"IruCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"IruCredential"}}]}},"components/schemas/IvantiCredential":{"id":"components/schemas/IvantiCredential","kind":"json-schema","title":"Ivanti Credential","data":{"title":"Ivanti Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"token_url":{"title":"Token URL","description":"This field is ignored and should not be set.","readOnly":true}},"description":"Configuration when creating new Token URL."}],"required":["type"],"title":"New Token URL","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"IvantiCredential"}},{"description":"Reference to existing Token URL.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token URL","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"IvantiCredential"}}]}},"components/schemas/IvantiCredentialTicketing":{"id":"components/schemas/IvantiCredentialTicketing","kind":"json-schema","title":"Ivanti ITSM Credential","data":{"title":"Ivanti ITSM Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"The Reference ID (REST API Key) generated for your tenant in Ivanti ITSM.","example":"abc123def456ghi789"}},"description":"REST API Key used for authenticating with Ivanti ITSM. This key is static  and does not expire, unlike Session IDs."}],"required":["type"],"title":"New REST API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"IvantiCredentialTicketing"}},{"description":"Reference to existing REST API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing REST API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"IvantiCredentialTicketing"}}]}},"components/schemas/JamfCredential":{"id":"components/schemas/JamfCredential","kind":"json-schema","title":"Jamf Credential","data":{"title":"Jamf Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"OAuth2 client credentials for Jamf Pro API access."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"JamfCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"JamfCredential"}}]}},"components/schemas/JiraCredential":{"id":"components/schemas/JiraCredential","kind":"json-schema","title":"Jira Credential","data":{"title":"Jira Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Classic user email and API token. See the Jira service account guide for Atlassian organization service accounts."}],"required":["type"],"title":"New User API Token","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"JiraCredential"}},{"description":"Reference to existing User API Token.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing User API Token","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"JiraCredential"}},{"allOf":[{"properties":{"type":{"enum":["service_account"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Atlassian organization service account email and scoped API token."}],"required":["type"],"title":"New Service Account","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"JiraCredential"}},{"description":"Reference to existing Service Account.","properties":{"type":{"enum":["service_account_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_account"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Service Account","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"JiraCredential"}}]}},"components/schemas/JupiterOneCredential":{"id":"components/schemas/JupiterOneCredential","kind":"json-schema","title":"Jupiter One Credential","data":{"title":"Jupiter One Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This credential must be an API Key. For more details, see "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.jupiterone.io/api-reference/creating-an-api-key/"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creating an API Key"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"JupiterOneCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"JupiterOneCredential"}}]}},"components/schemas/KnowBe4Credential":{"id":"components/schemas/KnowBe4Credential","kind":"json-schema","title":"Know Be4Credential","data":{"title":"Know Be4Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"KnowBe4Credential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"KnowBe4Credential"}}]}},"components/schemas/KnowBe4Region":{"id":"components/schemas/KnowBe4Region","kind":"json-schema","title":"KnowBe4Region","data":{"title":"KnowBe4Region","type":"string","enum":["US","EU","CA","UK","DE"]}},"components/schemas/LinearCredential":{"id":"components/schemas/LinearCredential","kind":"json-schema","title":"Linear Credential","data":{"title":"Linear Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","pattern":"^lin_api_.+$","x-validation-message":{"patternMismatch":"Linear API key must start with `lin_api_`."}}},"description":"A personal API key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"LinearCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"LinearCredential"}}]}},"components/schemas/MalwarebytesCredential":{"id":"components/schemas/MalwarebytesCredential","kind":"json-schema","title":"Malwarebytes Credential","data":{"title":"Malwarebytes Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"MalwarebytesCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"MalwarebytesCredential"}}]}},"components/schemas/MicrosoftDefenderRegion":{"id":"components/schemas/MicrosoftDefenderRegion","kind":"json-schema","title":"MicrosoftDefenderRegion","data":{"title":"MicrosoftDefenderRegion","type":"string","enum":["global","us","uk","eu","gcc","gcc_high","dod"]}},"components/schemas/MimecastAPIGateway":{"id":"components/schemas/MimecastAPIGateway","kind":"json-schema","title":"API Gateway","data":{"title":"API Gateway","type":"object","properties":{"region":{"allOf":[{"$ref":"#/components/schemas/MimecastAPIGatewayRegion"},{"default":"global"},{"title":"Region"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the Mimecast Cloud Gateway API. This field is intended for advanced use cases where the default API Gateways are not sufficient. The base URL is ignored when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Region"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is set to anything but "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"custom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the Mimecast Cloud Gateway API. This field is intended for advanced use cases where the default API Gateways are not sufficient. The base URL is ignored when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Region"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is set to anything but "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"custom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["region"]}},"components/schemas/MimecastAPIGatewayRegion":{"id":"components/schemas/MimecastAPIGatewayRegion","kind":"json-schema","title":"MimecastAPIGatewayRegion","data":{"title":"MimecastAPIGatewayRegion","type":"string","enum":["global","us","uk","custom"]}},"components/schemas/MimecastCloudGatewayCredential":{"id":"components/schemas/MimecastCloudGatewayCredential","kind":"json-schema","title":"Mimecast Cloud Gateway Credential","data":{"title":"Mimecast Cloud Gateway Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"MimecastCloudGatewayCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"MimecastCloudGatewayCredential"}}]}},"components/schemas/NetworkSecurity_AWS":{"id":"components/schemas/NetworkSecurity_AWS","kind":"json-schema","title":"networksecurity | AWS Network Security","data":{"title":"networksecurity | AWS Network Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the AWS Network Security Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-networksecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":"AWS credentials with sufficient access."},{"title":"Credential","description":"AWS credentials with sufficient access."}]},"dns_log_configuration_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List of Route 53 Resolver query log configuration IDs ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"rqlc-..."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Leave empty to include all query log configurations in the region."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"DNS Log Configuration IDs","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List of Route 53 Resolver query log configuration IDs ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"rqlc-..."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Leave empty to include all query log configurations in the region."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Network Security provider."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Network Security provider."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"traffic_log_configuration_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional list of VPC Flow Log IDs ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"fl-..."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Leave empty to include all flow logs in the region."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Traffic Log Configuration IDs","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional list of VPC Flow Log IDs ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"fl-..."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Leave empty to include all flow logs in the region."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","region"]}},"components/schemas/NetworkSecurity_Azure":{"id":"components/schemas/NetworkSecurity_Azure","kind":"json-schema","title":"networksecurity | Microsoft Azure Network Security","data":{"title":"networksecurity | Microsoft Azure Network Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Microsoft Azure Network Security Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/azure-networksecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"azure_cloud":{"allOf":[{"$ref":"#/components/schemas/AzureCloud","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Which Microsoft cloud to use: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"public"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" both use Azure Government."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"public"},{"title":"Azure Cloud","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Which Microsoft cloud to use: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"public"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" both use Azure Government."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/AzureNetworkSecurityCredential","description":"Client ID and secret for the Entra app."},{"title":"Credential","description":"Client ID and secret for the Entra app."}]},"dns_log_configuration_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional list of DNS log configuration IDs, in the form "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{resourceId}|{category}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Leave empty to include all DNS logging in the subscription."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"DNS Log Configuration IDs","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional list of DNS log configuration IDs, in the form "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{resourceId}|{category}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Leave empty to include all DNS logging in the subscription."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"subscription_id":{"allOf":[{"type":"string","description":"Azure subscription that owns the network security resources."},{"title":"Subscription ID","description":"Azure subscription that owns the network security resources."}]},"tenant_id":{"allOf":[{"type":"string","description":"Directory (tenant) ID of your Microsoft Entra tenant."},{"title":"Tenant ID","description":"Directory (tenant) ID of your Microsoft Entra tenant."}]},"traffic_log_configuration_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of flow log resource IDs. Leave empty to include all flow logs in the subscription."},{"title":"Traffic Log Configuration IDs","description":"Optional list of flow log resource IDs. Leave empty to include all flow logs in the subscription."}]}},"required":["credential","subscription_id","tenant_id"]}},"components/schemas/NetworkSecurity_Google":{"id":"components/schemas/NetworkSecurity_Google","kind":"json-schema","title":"networksecurity | Google Network Security","data":{"title":"networksecurity | Google Network Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Google Cloud Platform Network Security Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-networksecurity-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GoogleServiceAccountCredential","description":"Service account credentials with sufficient access."},{"title":"Credential","description":"Service account credentials with sufficient access."}]},"dns_log_configuration_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of DNS logging to read. Leave empty to include all DNS logging in the project."},{"example":["example-dns-policy","projects/example-project/managedZones/example-public-zone"]},{"title":"DNS Server Policies and Public Zones","description":"Optional list of DNS logging to read. Leave empty to include all DNS logging in the project."}]},"log_resource_names":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"Projects or log buckets to read VPC flow and DNS logs from. Each entry is a Log Router sink destination, a project, or a log bucket view."},{"example":["logging.googleapis.com/projects/secondary-project/locations/global/buckets/central-bucket","projects/{project_id}","logging.googleapis.com/projects/secondary-project/locations/global/buckets/central-bucket/views/_AllLogs"]},{"title":"Log Resource Names","description":"Projects or log buckets to read VPC flow and DNS logs from. Each entry is a Log Router sink destination, a project, or a log bucket view."}]},"project_id":{"allOf":[{"type":"string","description":"The ID of the Google Cloud project to read from."},{"title":"Project ID","description":"The ID of the Google Cloud project to read from."}]},"traffic_log_configuration_ids":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of VPC flow logs to read from. Leave empty to include all flow log configurations in the project."},{"example":["netsec-example-flow-logs","us-east1/example-subnet","projects/example-project/locations/global/vpcFlowLogsConfigs/company-flow-logs"]},{"title":"Flow Log Configurations","description":"Optional list of VPC flow logs to read from. Leave empty to include all flow log configurations in the project."}]}},"required":["credential","project_id"]}},"components/schemas/NinjaOneCredential":{"id":"components/schemas/NinjaOneCredential","kind":"json-schema","title":"Ninja One Credential","data":{"title":"Ninja One Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"OAuth2 client credentials for NinjaOne API access."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"NinjaOneCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"NinjaOneCredential"}}]}},"components/schemas/NinjaOneRegion":{"id":"components/schemas/NinjaOneRegion","kind":"json-schema","title":"NinjaOneRegion","data":{"title":"NinjaOneRegion","type":"string","enum":["app","us2","eu","ca","oc"]}},"components/schemas/Notifications_Jira":{"id":"components/schemas/Notifications_Jira","kind":"json-schema","title":"notifications | Atlassian Jira","data":{"title":"notifications | Atlassian Jira","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Atlassian Jira."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/jira-notification-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/JiraCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Jira tenant."},{"example":"https://tenant.atlassian.net"},{"title":"Base URL","description":"Base URL for the Jira tenant."}]}},"required":["credential","url"]}},"components/schemas/Notifications_Mock":{"id":"components/schemas/Notifications_Mock","kind":"json-schema","title":"notifications | Test Provider","data":{"title":"notifications | Test Provider","type":"object","description":"Configuration for the Synqly mock in-memory SIEM Provider. This provider is for testing purposes only and does not retain noficiations pushed to it.","properties":{"channel":{"allOf":[{"type":"string","nullable":true,"description":"The channel to send notifications to."},{"title":"Channel","description":"The channel to send notifications to."}]}}}},"components/schemas/Notifications_Slack":{"id":"components/schemas/Notifications_Slack","kind":"json-schema","title":"notifications | Slack","data":{"title":"notifications | Slack","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Slack."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/slack-notification-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"channel":{"allOf":[{"type":"string","description":"Channel to send notifications to. Must be a valid existing channel."},{"title":"Channel","description":"Channel to send notifications to. Must be a valid existing channel."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/SlackCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Slack API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://slack.com/","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Slack API."}]}},"required":["channel","credential"]}},"components/schemas/Notifications_Slack_Webhook":{"id":"components/schemas/Notifications_Slack_Webhook","kind":"json-schema","title":"notifications | Slack Incoming Webhook","data":{"title":"notifications | Slack Incoming Webhook","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Slack Notification Provider using Incoming Webhooks."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Incoming Webhooks are a way to post messages from apps into Slack. They cannot be used for any other actions, such as reading or deleting messages."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/slack-webhook-notification-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"webhook_url":{"allOf":[{"$ref":"#/components/schemas/SlackWebhookCredential"},{"title":"Incoming Webhook URL"}]}},"required":["webhook_url"]}},"components/schemas/Notifications_Teams":{"id":"components/schemas/Notifications_Teams","kind":"json-schema","title":"notifications | Microsoft Teams","data":{"title":"notifications | Microsoft Teams","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Teams."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/teams-notification-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"channel_id":{"allOf":[{"type":"string","description":"Identifier of the channel to send messages to."},{"title":"Channel ID","description":"Identifier of the channel to send messages to."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/TeamsCredential"},{"title":"Credential"}]},"endpoint":{"allOf":[{"type":"string","nullable":true,"description":"URL of the endpoint to send messages to. Only required if OAuth Client Credentials are used for authentication."},{"title":"Message Endpoint","description":"URL of the endpoint to send messages to. Only required if OAuth Client Credentials are used for authentication."}]},"team_id":{"allOf":[{"type":"string","description":"Identifier of the team to send messages to."},{"title":"Team ID","description":"Identifier of the team to send messages to."}]},"tenant_id":{"allOf":[{"type":"string","nullable":true,"description":"Azure Directory (tenant) ID. Only required if OAuth Client Credentials are used for authentication."},{"title":"Tenant ID","description":"Azure Directory (tenant) ID. Only required if OAuth Client Credentials are used for authentication."}]}},"required":["channel_id","credential","team_id"]}},"components/schemas/NozomiVantageCredential":{"id":"components/schemas/NozomiVantageCredential","kind":"json-schema","title":"Nozomi Vantage Credential","data":{"title":"Nozomi Vantage Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"Token Secret"},"username":{"title":"Token Name"}},"description":"API key name and secret value of your Nozomi Vantage API token."}],"required":["type"],"title":"New API Token","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"NozomiVantageCredential"}},{"description":"Reference to existing API Token.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Token","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"NozomiVantageCredential"}}]}},"components/schemas/NucleusCredential":{"id":"components/schemas/NucleusCredential","kind":"json-schema","title":"Nucleus Credential","data":{"title":"Nucleus Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"NucleusCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"NucleusCredential"}}]}},"components/schemas/O365ManagementActivityCloud":{"id":"components/schemas/O365ManagementActivityCloud","kind":"json-schema","title":"Microsoft 365 cloud","data":{"title":"Microsoft 365 cloud","type":"string","enum":["global","gcc","gcc_high","dod"],"description":"Microsoft 365 cloud instance that hosts the Office 365 Management Activity API. The value selects the API base URL and the Microsoft Entra login host together; the two cannot be set independently."}},"components/schemas/O365ManagementActivityCredential":{"id":"components/schemas/O365ManagementActivityCredential","kind":"json-schema","title":"O365Management Activity Credential","data":{"title":"O365Management Activity Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"client_id":{"title":"Client ID","description":"The Azure Application registration client ID."},"client_secret":{"title":"Client Secret"},"token_url":{"title":"Token URL","readOnly":true}},"description":"Client ID and client secret of the Azure application registration."}],"required":["type"],"title":"New Client Secret","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"O365ManagementActivityCredential"}},{"description":"Reference to existing Client Secret.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Secret","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"O365ManagementActivityCredential"}},{"allOf":[{"properties":{"type":{"enum":["tls_certificate"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TlsCertificateCredential"},{"required":["extra"],"type":"object","properties":{"certificate":{"title":"Certificate","description":"Contents of the certificate file."},"extra":{"title":"Extra","required":["client_id"],"properties":{"client_id":{"description":"The Azure application registration client ID.","title":"Client ID","type":"string"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connection specific JSON map, must include the field "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"client_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"private_key":{"title":"Private Key","description":"Contents of the private key file for the certificate. The key must have no passphrase."}},"description":"Certificate, private key, and client ID of the Azure application registration."}],"required":["type"],"title":"New Certificate","type":"object","x-synqly-credential":{"extends":"TlsCertificateCredential","type":"O365ManagementActivityCredential"}},{"description":"Reference to existing Certificate.","properties":{"type":{"enum":["tls_certificate_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TlsCertificateCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tls_certificate"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tls_certificate"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Certificate","type":"object","x-synqly-credential":{"extends":"TlsCertificateCredentialId","reference":true,"type":"O365ManagementActivityCredential"}}]}},"components/schemas/OktaCredential":{"id":"components/schemas/OktaCredential","kind":"json-schema","title":"Okta Credential","data":{"title":"Okta Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"OAuth 2.0 Token URL, Client ID, and Client Secret for a Synqly Identity Connector API service application."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"OktaCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"OktaCredential"}},{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Token to authenticate with Okta. Follow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/create-an-api-token"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this guide to generate an API token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The token must have access to list records in the system audit log. (Not for production use. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" instead)"},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"OktaCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"OktaCredential"}}]}},"components/schemas/OpenSearchCredential":{"id":"components/schemas/OpenSearchCredential","kind":"json-schema","title":"Open Search Credential","data":{"title":"Open Search Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Basic authentication credentials for OpenSearch.\n"}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"OpenSearchCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"OpenSearchCredential"}}]}},"components/schemas/OpenTextApplicationSecurityCredential":{"id":"components/schemas/OpenTextApplicationSecurityCredential","kind":"json-schema","title":"Open Text Application Security Credential","data":{"title":"Open Text Application Security Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"OpenTextApplicationSecurityCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"OpenTextApplicationSecurityCredential"}}]}},"components/schemas/OpenTextCoreApplicationSecurityCredential":{"id":"components/schemas/OpenTextCoreApplicationSecurityCredential","kind":"json-schema","title":"Open Text Core Application Security Credential","data":{"title":"Open Text Core Application Security Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"OpenTextCoreApplicationSecurityCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"OpenTextCoreApplicationSecurityCredential"}}]}},"components/schemas/OpenTextCoreApplicationSecurityUrl":{"id":"components/schemas/OpenTextCoreApplicationSecurityUrl","kind":"json-schema","title":"OpenTextCoreApplicationSecurityUrl","data":{"title":"OpenTextCoreApplicationSecurityUrl","type":"string","enum":["https://api.ams.fortify.com","https://api.emea.fortify.com","https://api.apac.fortify.com","https://api.sgp.fortify.com","https://api.fed.fortifygov.com","https://api.trial.fortify.com"]}},"components/schemas/OrcaCredential":{"id":"components/schemas/OrcaCredential","kind":"json-schema","title":"Orca API Token","data":{"title":"Orca API Token","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Token"}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"OrcaCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"OrcaCredential"}}]}},"components/schemas/OrcaRegion":{"id":"components/schemas/OrcaRegion","kind":"json-schema","title":"OrcaRegion","data":{"title":"OrcaRegion","type":"string","enum":["us","eu","au","in","sa"]}},"components/schemas/PagerDutyCredential":{"id":"components/schemas/PagerDutyCredential","kind":"json-schema","title":"Pager Duty Credential","data":{"title":"Pager Duty Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"PagerDutyCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"PagerDutyCredential"}}]}},"components/schemas/PaloAltoCredential":{"id":"components/schemas/PaloAltoCredential","kind":"json-schema","title":"Palo Alto Credential","data":{"title":"Palo Alto Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"API Key for the Palo Alto Networks Cortex Cloud Security API."},"username":{"title":"API Key ID","description":"API Key ID for the Palo Alto Networks Cortex Cloud Security API."}},"description":"Configuration when creating new API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"PaloAltoCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"PaloAltoCredential"}}]}},"components/schemas/PantherApiCredential":{"id":"components/schemas/PantherApiCredential","kind":"json-schema","title":"API Credential","data":{"title":"API Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Token","description":"Your API Token value generated in the Panther console."}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"PantherApiCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"PantherApiCredential"}}]}},"components/schemas/PantherIngestionCredential":{"id":"components/schemas/PantherIngestionCredential","kind":"json-schema","title":"Ingestion Credential","data":{"title":"Ingestion Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"Bearer Token","description":"The Bearer Token generated when creating your Panther HTTP Log Source."}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"PantherIngestionCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"PantherIngestionCredential"}}]}},"components/schemas/PenteraCredential":{"id":"components/schemas/PenteraCredential","kind":"json-schema","title":"Pentera Credential","data":{"title":"Pentera Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"TGT Token","description":"Pentera TGT secret token for authentication."},"username":{"title":"Client ID","description":"Pentera API Client ID."}},"description":"Configuration when creating new Basic Credentials."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"PenteraCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"PenteraCredential"}}]}},"components/schemas/PingOneAPIURL":{"id":"components/schemas/PingOneAPIURL","kind":"json-schema","title":"PingOneAPIURL","data":{"title":"PingOneAPIURL","type":"string","enum":["https://api.pingone.com","https://api.pingone.ca","https://api.pingone.eu","https://api.pingone.com.au","https://api.pingone.sg","https://api.pingone.asia"]}},"components/schemas/PingOneAuthURL":{"id":"components/schemas/PingOneAuthURL","kind":"json-schema","title":"PingOneAuthURL","data":{"title":"PingOneAuthURL","type":"string","enum":["https://auth.pingone.com","https://auth.pingone.ca","https://auth.pingone.eu","https://auth.pingone.com.au","https://auth.pingone.sg","https://auth.pingone.asia"]}},"components/schemas/PingOneCredential":{"id":"components/schemas/PingOneCredential","kind":"json-schema","title":"Ping One Credential","data":{"title":"Ping One Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"PingOneCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"PingOneCredential"}}]}},"components/schemas/ProviderConfig":{"id":"components/schemas/ProviderConfig","kind":"json-schema","title":"ProviderConfig","data":{"title":"ProviderConfig","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_amazon_inspector"]}}},{"$ref":"#/components/schemas/Appsec_amazon_Inspector"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_github"]}}},{"$ref":"#/components/schemas/appsec_GitHub"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_gitlab"]}}},{"$ref":"#/components/schemas/appsec_GitLab"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_hcl_appscan_on_cloud"]}}},{"$ref":"#/components/schemas/appsec_HCLAppScanOnCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_opentext_application_security"]}}},{"$ref":"#/components/schemas/appsec_OpenTextApplicationSecurity"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_opentext_core_application_security"]}}},{"$ref":"#/components/schemas/appsec_OpenTextCoreApplicationSecurity"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_opentext_core_application_security_mock"]}}},{"$ref":"#/components/schemas/appsec_OpenTextCoreApplicationSecurityMock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_servicenow"]}}},{"$ref":"#/components/schemas/AppSec_ServiceNow"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_snyk"]}}},{"$ref":"#/components/schemas/AppSec_Snyk"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_sonarqube_server"]}}},{"$ref":"#/components/schemas/appsec_SonarQubeServer"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_tenable"]}}},{"$ref":"#/components/schemas/AppSec_Tenable"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["appsec_veracode"]}}},{"$ref":"#/components/schemas/AppSec_Veracode"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_armis_centrix"]}}},{"$ref":"#/components/schemas/Assets_ArmisCentrix"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_armis_centrix_mock"]}}},{"$ref":"#/components/schemas/Assets_ArmisCentrix_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_axonius"]}}},{"$ref":"#/components/schemas/Assets_Axonius"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_axonius_mock"]}}},{"$ref":"#/components/schemas/Assets_Axonius_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_claroty_xdome"]}}},{"$ref":"#/components/schemas/Assets_ClarotyXdome"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_crowdstrike"]}}},{"$ref":"#/components/schemas/Assets_CrowdStrike"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_crowdstrike_mock"]}}},{"$ref":"#/components/schemas/Assets_CrowdStrike_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_defender"]}}},{"$ref":"#/components/schemas/Assets_Defender"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_iru"]}}},{"$ref":"#/components/schemas/Assets_Iru"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_ivanti_neurons"]}}},{"$ref":"#/components/schemas/Assets_IvantiNeurons"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_ivanti_neurons_mock"]}}},{"$ref":"#/components/schemas/Assets_IvantiNeurons_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_jupiterone"]}}},{"$ref":"#/components/schemas/Assets_JupiterOne"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_nozomi_vantage"]}}},{"$ref":"#/components/schemas/Assets_NozomiVantage"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_nozomi_vantage_mock"]}}},{"$ref":"#/components/schemas/Assets_NozomiVantage_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_qualys_cloud"]}}},{"$ref":"#/components/schemas/Assets_QualysCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_qualys_cloud_mock"]}}},{"$ref":"#/components/schemas/Assets_QualysCloud_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_servicenow"]}}},{"$ref":"#/components/schemas/Assets_ServiceNow"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_servicenow_mock"]}}},{"$ref":"#/components/schemas/Assets_ServiceNow_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_sevco"]}}},{"$ref":"#/components/schemas/Assets_Sevco"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_sevco_mock"]}}},{"$ref":"#/components/schemas/Assets_Sevco_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_tanium_cloud"]}}},{"$ref":"#/components/schemas/Assets_TaniumCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_tanium_cloud_mock"]}}},{"$ref":"#/components/schemas/Assets_TaniumCloud_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_tenable_cloud"]}}},{"$ref":"#/components/schemas/Assets_TenableCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["assets_tenable_cloud_mock"]}}},{"$ref":"#/components/schemas/Assets_TenableCloud_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["chat_microsoft_copilot"]}}},{"$ref":"#/components/schemas/Chat_MicrosoftCopilot"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["chat_microsoft_teams"]}}},{"$ref":"#/components/schemas/Chat_MicrosoftTeams"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["chat_slack"]}}},{"$ref":"#/components/schemas/Chat_Slack"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_aws"]}}},{"$ref":"#/components/schemas/CloudSecurity_AWS"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_awseventbridgesqs"]}}},{"$ref":"#/components/schemas/CloudSecurity_AWSEventBridgeSQS"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_crowdstrike"]}}},{"$ref":"#/components/schemas/CloudSecurity_CrowdStrike"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_crowdstrike_mock"]}}},{"$ref":"#/components/schemas/CloudSecurity_CrowdStrike_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_defender"]}}},{"$ref":"#/components/schemas/CloudSecurity_Defender"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_google"]}}},{"$ref":"#/components/schemas/CloudSecurity_Google"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_orca"]}}},{"$ref":"#/components/schemas/CloudSecurity_Orca"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_paloalto"]}}},{"$ref":"#/components/schemas/CloudSecurity_PaloAlto"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_sentinelone"]}}},{"$ref":"#/components/schemas/CloudSecurity_SentinelOne"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_tenable"]}}},{"$ref":"#/components/schemas/CloudSecurity_Tenable"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_upwind"]}}},{"$ref":"#/components/schemas/CloudSecurity_Upwind"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["cloudsecurity_wiz"]}}},{"$ref":"#/components/schemas/CloudSecurity_Wiz"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["custom_synqly"]}}},{"$ref":"#/components/schemas/Custom_Synqly"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_bitdefender"]}}},{"$ref":"#/components/schemas/Edr_Bitdefender"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_crowdstrike"]}}},{"$ref":"#/components/schemas/Edr_CrowdStrike"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_crowdstrike_mock"]}}},{"$ref":"#/components/schemas/Edr_CrowdStrike_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_defender"]}}},{"$ref":"#/components/schemas/Edr_Defender"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_eset_connect"]}}},{"$ref":"#/components/schemas/Edr_EsetConnect"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_huntress"]}}},{"$ref":"#/components/schemas/Edr_Huntress"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_iru"]}}},{"$ref":"#/components/schemas/Edr_Iru"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_malwarebytes"]}}},{"$ref":"#/components/schemas/Edr_Malwarebytes"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_sentinelone"]}}},{"$ref":"#/components/schemas/Edr_SentinelOne"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_sophos"]}}},{"$ref":"#/components/schemas/Edr_Sophos"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_tanium"]}}},{"$ref":"#/components/schemas/Edr_Tanium"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_trellix"]}}},{"$ref":"#/components/schemas/Edr_Trellix"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["edr_trellix_ens"]}}},{"$ref":"#/components/schemas/Edr_TrellixEns"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_defender_for_office"]}}},{"$ref":"#/components/schemas/EmailSecurity_DefenderForOffice"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_defender_for_office_mock"]}}},{"$ref":"#/components/schemas/EmailSecurity_DefenderForOffice_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_exchange_online"]}}},{"$ref":"#/components/schemas/EmailSecurity_ExchangeOnline"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_ironscales"]}}},{"$ref":"#/components/schemas/EmailSecurity_Ironscales"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_mimecast_cloud_gateway"]}}},{"$ref":"#/components/schemas/EmailSecurity_MimecastCloudGateway"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_mimecast_cloud_gateway_mock"]}}},{"$ref":"#/components/schemas/EmailSecurity_MimecastCloudGateway_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["emailsecurity_o365_management_activity"]}}},{"$ref":"#/components/schemas/EmailSecurity_O365ManagementActivity"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["endpointmanagement_automox"]}}},{"$ref":"#/components/schemas/Endpointmanagement_Automox"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["endpointmanagement_bigfix"]}}},{"$ref":"#/components/schemas/Endpointmanagement_Bigfix"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["endpointmanagement_intune"]}}},{"$ref":"#/components/schemas/Endpointmanagement_Intune"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["endpointmanagement_iru"]}}},{"$ref":"#/components/schemas/Endpointmanagement_Iru"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["endpointmanagement_jamf"]}}},{"$ref":"#/components/schemas/Endpointmanagement_Jamf"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["endpointmanagement_ninjaone"]}}},{"$ref":"#/components/schemas/Endpointmanagement_Ninjaone"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["grc_drata"]}}},{"$ref":"#/components/schemas/Grc_Drata"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["grc_secureframe"]}}},{"$ref":"#/components/schemas/Grc_Secureframe"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_ashby"]}}},{"$ref":"#/components/schemas/Identity_Ashby"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_aws_iam"]}}},{"$ref":"#/components/schemas/Identity_AwsIam"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_crowdstrike"]}}},{"$ref":"#/components/schemas/Identity_CrowdStrike"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_crowdstrike_mock"]}}},{"$ref":"#/components/schemas/Identity_CrowdStrike_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_duosecurity"]}}},{"$ref":"#/components/schemas/Identity_DuoSecurity"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_entra_id"]}}},{"$ref":"#/components/schemas/Identity_EntraId"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_entra_id_mock"]}}},{"$ref":"#/components/schemas/Identity_EntraId_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_github"]}}},{"$ref":"#/components/schemas/Identity_GitHub"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_google"]}}},{"$ref":"#/components/schemas/Identity_Google"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_google_mock"]}}},{"$ref":"#/components/schemas/Identity_Google_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_greenhouse"]}}},{"$ref":"#/components/schemas/Identity_Greenhouse"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_okta"]}}},{"$ref":"#/components/schemas/Identity_Okta"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_okta_mock"]}}},{"$ref":"#/components/schemas/Identity_Okta_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_pingone"]}}},{"$ref":"#/components/schemas/Identity_PingOne"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_pingone_mock"]}}},{"$ref":"#/components/schemas/Identity_PingOne_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["identity_workday"]}}},{"$ref":"#/components/schemas/Identity_Workday"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["incidentresponse_incidentio"]}}},{"$ref":"#/components/schemas/IncidentResponse_IncidentIO"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["incidentresponse_pagerduty"]}}},{"$ref":"#/components/schemas/IncidentResponse_PagerDuty"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["networksecurity_aws"]}}},{"$ref":"#/components/schemas/NetworkSecurity_AWS"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["networksecurity_azure"]}}},{"$ref":"#/components/schemas/NetworkSecurity_Azure"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["networksecurity_google"]}}},{"$ref":"#/components/schemas/NetworkSecurity_Google"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["notifications_jira"]}}},{"$ref":"#/components/schemas/Notifications_Jira"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["notifications_mock_notifications"]}}},{"$ref":"#/components/schemas/Notifications_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["notifications_slack"]}}},{"$ref":"#/components/schemas/Notifications_Slack"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["notifications_slack_webhook"]}}},{"$ref":"#/components/schemas/Notifications_Slack_Webhook"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["notifications_teams"]}}},{"$ref":"#/components/schemas/Notifications_Teams"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["securityawareness_knowbe4"]}}},{"$ref":"#/components/schemas/SecurityAwareness_KnowBe4"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_amazon_security_lake"]}}},{"$ref":"#/components/schemas/SIEM_AmazonSecurityLake"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_crowdstrike"]}}},{"$ref":"#/components/schemas/SIEM_Crowdstrike"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_datadog"]}}},{"$ref":"#/components/schemas/SIEM_Datadog"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_elasticsearch"]}}},{"$ref":"#/components/schemas/SIEM_Elasticsearch"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_google_chronicle"]}}},{"$ref":"#/components/schemas/SIEM_GoogleChronicle"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_google_security_operations"]}}},{"$ref":"#/components/schemas/SIEM_GoogleSecurityOperations"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_mock_siem"]}}},{"$ref":"#/components/schemas/SIEM_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_opensearch"]}}},{"$ref":"#/components/schemas/SIEM_OpenSearch"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_panther"]}}},{"$ref":"#/components/schemas/SIEM_Panther"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_q_radar"]}}},{"$ref":"#/components/schemas/SIEM_QRadar"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_rapid7_insightidr"]}}},{"$ref":"#/components/schemas/SIEM_Rapid7InsightIDR"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_sentinel"]}}},{"$ref":"#/components/schemas/SIEM_Sentinel"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_splunk"]}}},{"$ref":"#/components/schemas/SIEM_Splunk"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["siem_sumo_logic"]}}},{"$ref":"#/components/schemas/SIEM_SumoLogic"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_amazon_security_lake"]}}},{"$ref":"#/components/schemas/Sink_AmazonSecurityLake"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_aws_s3"]}}},{"$ref":"#/components/schemas/Sink_AwsS3"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_aws_security_lake"]}}},{"$ref":"#/components/schemas/Sink_AwsSecurityLake"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_aws_sqs"]}}},{"$ref":"#/components/schemas/Sink_AwsSQS"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_azure_blob"]}}},{"$ref":"#/components/schemas/Sink_AzureBlob"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_azure_monitor_logs"]}}},{"$ref":"#/components/schemas/Sink_AzureMonitorLogs"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_crowdstrike_hec"]}}},{"$ref":"#/components/schemas/Sink_CrowdstrikeHEC"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_datadog"]}}},{"$ref":"#/components/schemas/Sink_Datadog"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_elasticsearch"]}}},{"$ref":"#/components/schemas/Sink_Elasticsearch"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_gcs"]}}},{"$ref":"#/components/schemas/Sink_Gcs"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_google_sec_ops"]}}},{"$ref":"#/components/schemas/Sink_GoogleSecOps"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_google_security_operations"]}}},{"$ref":"#/components/schemas/Sink_GoogleSecurityOperations"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_http"]}}},{"$ref":"#/components/schemas/Sink_Http"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_mock_sink"]}}},{"$ref":"#/components/schemas/Sink_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_opensearch"]}}},{"$ref":"#/components/schemas/Sink_OpenSearch"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_panther"]}}},{"$ref":"#/components/schemas/Sink_Panther"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_q_radar"]}}},{"$ref":"#/components/schemas/Sink_QRadar"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_splunk"]}}},{"$ref":"#/components/schemas/Sink_Splunk"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_sumo_logic"]}}},{"$ref":"#/components/schemas/Sink_SumoLogic"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_swimlane"]}}},{"$ref":"#/components/schemas/Sink_Swimlane"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sink_trimedx"]}}},{"$ref":"#/components/schemas/Sink_Trimedx"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ssf_okta"]}}},{"$ref":"#/components/schemas/SSF_Okta"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["storage_aws_s3"]}}},{"$ref":"#/components/schemas/Storage_AwsS3"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["storage_azure_blob"]}}},{"$ref":"#/components/schemas/Storage_AzureBlob"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["storage_gcs"]}}},{"$ref":"#/components/schemas/Storage_GCS"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["storage_mock_storage"]}}},{"$ref":"#/components/schemas/Storage_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["threatintel_abuseipdb"]}}},{"$ref":"#/components/schemas/ThreatIntel_AbuseIPDB"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["threatintel_threatfox"]}}},{"$ref":"#/components/schemas/ThreatIntel_ThreatFox"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["threatintel_virustotal"]}}},{"$ref":"#/components/schemas/ThreatIntel_VirusTotal"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_autotask"]}}},{"$ref":"#/components/schemas/Ticketing_Autotask"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_azure_devops"]}}},{"$ref":"#/components/schemas/Ticketing_AzureDevOps"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_bmchelix"]}}},{"$ref":"#/components/schemas/Ticketing_Bmchelix"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_freshdesk"]}}},{"$ref":"#/components/schemas/Ticketing_Freshdesk"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_github"]}}},{"$ref":"#/components/schemas/Ticketing_GitHub"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_ivanti"]}}},{"$ref":"#/components/schemas/Ticketing_Ivanti"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_ivanti_mock"]}}},{"$ref":"#/components/schemas/Ticketing_Ivanti_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_jira"]}}},{"$ref":"#/components/schemas/Ticketing_Jira"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_jira_service_management"]}}},{"$ref":"#/components/schemas/Ticketing_JiraServiceManagement"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_linear"]}}},{"$ref":"#/components/schemas/Ticketing_Linear"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_mock_ticketing"]}}},{"$ref":"#/components/schemas/Ticketing_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_pagerduty"]}}},{"$ref":"#/components/schemas/Ticketing_PagerDuty"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_pagerduty_mock"]}}},{"$ref":"#/components/schemas/Ticketing_PagerDutyMock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_servicenow"]}}},{"$ref":"#/components/schemas/Ticketing_ServiceNow"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_servicenow_sir"]}}},{"$ref":"#/components/schemas/Ticketing_ServiceNowSIR"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_torq"]}}},{"$ref":"#/components/schemas/Ticketing_Torq"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_xurrent"]}}},{"$ref":"#/components/schemas/Ticketing_Xurrent"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ticketing_zendesk"]}}},{"$ref":"#/components/schemas/Ticketing_Zendesk"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_amazon_inspector"]}}},{"$ref":"#/components/schemas/Vulnerabilities_AmazonInspector"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_axonius"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Axonius"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_axonius_mock"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Axonius_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_crowdstrike"]}}},{"$ref":"#/components/schemas/Vulnerabilities_CrowdStrike"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_crowdstrike_mock"]}}},{"$ref":"#/components/schemas/Vulnerabilities_CrowdStrike_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_defender"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Defender"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_defender_easm"]}}},{"$ref":"#/components/schemas/Vulnerabilities_DefenderEasm"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_horizon3"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Horizon3"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_iru"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Iru"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_nucleus"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Nucleus"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_pentera"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Pentera"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_qualys_cloud"]}}},{"$ref":"#/components/schemas/Vulnerabilities_QualysCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_qualys_cloud_mock"]}}},{"$ref":"#/components/schemas/Vulnerabilities_QualysCloud_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_rapid7_insight_cloud"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Rapid7InsightCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_rapid7_insight_cloud_mock"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Rapid7InsightCloud_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_servicenow_usem"]}}},{"$ref":"#/components/schemas/Vulnerabilities_ServiceNow_Usem"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_servicenow_vr"]}}},{"$ref":"#/components/schemas/Vulnerabilities_ServiceNow"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_tanium_cloud"]}}},{"$ref":"#/components/schemas/Vulnerabilities_TaniumCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_tanium_cloud_mock"]}}},{"$ref":"#/components/schemas/Vulnerabilities_TaniumCloud_Mock"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_tenable_asm"]}}},{"$ref":"#/components/schemas/Vulnerabilities_TenableAsm"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_tenable_cloud"]}}},{"$ref":"#/components/schemas/Vulnerabilities_TenableCloud"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_tenable_sc"]}}},{"$ref":"#/components/schemas/Vulnerabilities_TenableSc"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["vulnerabilities_wiz"]}}},{"$ref":"#/components/schemas/Vulnerabilities_Wiz"}],"required":["type"]}]}},"components/schemas/ProviderConfigId":{"id":"components/schemas/ProviderConfigId","kind":"json-schema","title":"ProviderConfigId","data":{"title":"ProviderConfigId","type":"string","enum":["appsec_amazon_inspector","appsec_github","appsec_gitlab","appsec_hcl_appscan_on_cloud","appsec_opentext_application_security","appsec_opentext_core_application_security","appsec_opentext_core_application_security_mock","appsec_servicenow","appsec_snyk","appsec_sonarqube_server","appsec_tenable","appsec_veracode","assets_armis_centrix","assets_armis_centrix_mock","assets_axonius","assets_axonius_mock","assets_claroty_xdome","assets_crowdstrike","assets_crowdstrike_mock","assets_defender","assets_iru","assets_ivanti_neurons","assets_ivanti_neurons_mock","assets_jupiterone","assets_nozomi_vantage","assets_nozomi_vantage_mock","assets_qualys_cloud","assets_qualys_cloud_mock","assets_servicenow","assets_servicenow_mock","assets_sevco","assets_sevco_mock","assets_tanium_cloud","assets_tanium_cloud_mock","assets_tenable_cloud","assets_tenable_cloud_mock","chat_microsoft_copilot","chat_microsoft_teams","chat_slack","cloudsecurity_aws","cloudsecurity_awseventbridgesqs","cloudsecurity_crowdstrike","cloudsecurity_crowdstrike_mock","cloudsecurity_defender","cloudsecurity_google","cloudsecurity_orca","cloudsecurity_paloalto","cloudsecurity_sentinelone","cloudsecurity_tenable","cloudsecurity_upwind","cloudsecurity_wiz","custom_synqly","edr_bitdefender","edr_crowdstrike","edr_crowdstrike_mock","edr_defender","edr_eset_connect","edr_huntress","edr_iru","edr_malwarebytes","edr_sentinelone","edr_sophos","edr_tanium","edr_trellix","edr_trellix_ens","emailsecurity_defender_for_office","emailsecurity_defender_for_office_mock","emailsecurity_exchange_online","emailsecurity_ironscales","emailsecurity_mimecast_cloud_gateway","emailsecurity_mimecast_cloud_gateway_mock","emailsecurity_o365_management_activity","endpointmanagement_automox","endpointmanagement_bigfix","endpointmanagement_intune","endpointmanagement_iru","endpointmanagement_jamf","endpointmanagement_ninjaone","grc_drata","grc_secureframe","identity_ashby","identity_aws_iam","identity_crowdstrike","identity_crowdstrike_mock","identity_duosecurity","identity_entra_id","identity_entra_id_mock","identity_github","identity_google","identity_google_mock","identity_greenhouse","identity_okta","identity_okta_mock","identity_pingone","identity_pingone_mock","identity_workday","incidentresponse_incidentio","incidentresponse_pagerduty","networksecurity_aws","networksecurity_azure","networksecurity_google","notifications_jira","notifications_mock_notifications","notifications_slack_webhook","notifications_slack","notifications_teams","securityawareness_knowbe4","siem_amazon_security_lake","siem_crowdstrike","siem_datadog","siem_elasticsearch","siem_google_chronicle","siem_google_security_operations","siem_mock_siem","siem_opensearch","siem_panther","siem_q_radar","siem_rapid7_insightidr","siem_sentinel","siem_splunk","siem_sumo_logic","sink_amazon_security_lake","sink_aws_s3","sink_aws_security_lake","sink_aws_sqs","sink_azure_blob","sink_azure_monitor_logs","sink_crowdstrike_hec","sink_datadog","sink_elasticsearch","sink_gcs","sink_google_sec_ops","sink_google_security_operations","sink_http","sink_mock_sink","sink_opensearch","sink_panther","sink_q_radar","sink_splunk","sink_sumo_logic","sink_swimlane","sink_trimedx","ssf_okta","storage_aws_s3","storage_azure_blob","storage_gcs","storage_mock_storage","threatintel_abuseipdb","threatintel_threatfox","threatintel_virustotal","ticketing_autotask","ticketing_azure_devops","ticketing_bmchelix","ticketing_freshdesk","ticketing_github","ticketing_ivanti","ticketing_ivanti_mock","ticketing_jira","ticketing_jira_service_management","ticketing_linear","ticketing_mock_ticketing","ticketing_pagerduty","ticketing_pagerduty_mock","ticketing_servicenow","ticketing_servicenow_sir","ticketing_torq","ticketing_xurrent","ticketing_zendesk","vulnerabilities_amazon_inspector","vulnerabilities_axonius","vulnerabilities_axonius_mock","vulnerabilities_crowdstrike","vulnerabilities_crowdstrike_mock","vulnerabilities_defender","vulnerabilities_defender_easm","vulnerabilities_horizon3","vulnerabilities_iru","vulnerabilities_nucleus","vulnerabilities_pentera","vulnerabilities_qualys_cloud","vulnerabilities_qualys_cloud_mock","vulnerabilities_rapid7_insight_cloud","vulnerabilities_rapid7_insight_cloud_mock","vulnerabilities_servicenow_vr","vulnerabilities_servicenow_usem","vulnerabilities_tanium_cloud","vulnerabilities_tanium_cloud_mock","vulnerabilities_tenable_asm","vulnerabilities_tenable_cloud","vulnerabilities_tenable_sc","vulnerabilities_wiz","*"],"description":"List of supported providers."}},"components/schemas/QRadarCredential":{"id":"components/schemas/QRadarCredential","kind":"json-schema","title":"QRadar Credential","data":{"title":"QRadar Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorized service token for QRadar Operations. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.ibm.com/docs/en/qradar-common?topic=app-creating-authorized-service-token-qradar-operations"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guide to generate a token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Authorized Service Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"QRadarCredential"}},{"description":"Reference to existing Authorized Service Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Authorized Service Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"QRadarCredential"}}]}},"components/schemas/QualysCloudCredential":{"id":"components/schemas/QualysCloudCredential","kind":"json-schema","title":"Qualys Cloud Credential","data":{"title":"Qualys Cloud Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":"Username and password used to authenticate with Qualys Cloud."}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"QualysCloudCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"QualysCloudCredential"}}]}},"components/schemas/Rapid7InsightCloudCredential":{"id":"components/schemas/Rapid7InsightCloudCredential","kind":"json-schema","title":"Rapid7Insight Cloud Credential","data":{"title":"Rapid7Insight Cloud Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Token."}],"required":["type"],"title":"New API Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"Rapid7InsightCloudCredential"}},{"description":"Reference to existing API Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"Rapid7InsightCloudCredential"}}]}},"components/schemas/SIEM_AmazonSecurityLake":{"id":"components/schemas/SIEM_AmazonSecurityLake","kind":"json-schema","title":"siem | Amazon Security Lake","data":{"title":"siem | Amazon Security Lake","type":"object","description":"Configuration for Amazon Security Lake as a SIEM provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Security Lake"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Credential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Security Lake"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"custom_log_sources":{"allOf":[{"$ref":"#/components/schemas/amazon_security_lake_custom_log_sources_config","nullable":true,"description":"Amazon Security Lake custom log sources to write events to. Required to enable the Post Events operation."},{"title":"Custom Log Sources","description":"Amazon Security Lake custom log sources to write events to. Required to enable the Post Events operation."}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Security Lake provider."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Security Lake provider."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"workgroup_name":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The name of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-manage.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Athena workgroup"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for querying Amazon Security Lake events. Must already be configured with an S3 query-result output location."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Workgroup Name","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The name of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-manage.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Athena workgroup"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for querying Amazon Security Lake events. Must already be configured with an S3 query-result output location."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","region","workgroup_name"]}},"components/schemas/SIEM_Crowdstrike":{"id":"components/schemas/SIEM_Crowdstrike","kind":"json-schema","title":"siem | CrowdStrike Next-Gen SIEM","data":{"title":"siem | CrowdStrike Next-Gen SIEM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for CrowdStrike Falcon® Next-Gen SIEM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/crowdstrike-siem-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdStrikeCredential","description":"The credential to use for the CrowdStrike Falcon NextGen SIEM tenant."},{"title":"Credential","description":"The credential to use for the CrowdStrike Falcon NextGen SIEM tenant."}]},"hec_credential":{"allOf":[{"$ref":"#/components/schemas/CrowdstrikeHECCredential","nullable":true,"description":"Token credential to use for connecting to the CrowdStrike HEC service. If not provided, sending events to CrowdStrike is disabled."},{"title":"HEC Credential","description":"Token credential to use for connecting to the CrowdStrike HEC service. If not provided, sending events to CrowdStrike is disabled.\n"}]},"hec_url":{"allOf":[{"type":"string","nullable":true,"description":"The generated CrowdStrike HEC URL provided with your token."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://<some-guid>.ingest.us-2.crowdstrike.com/services/collector","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"HEC URL","description":"The generated CrowdStrike HEC URL provided with your token."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the CrowdStrike Falcon® Next-Gen SIEM API."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.crowdstrike.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the CrowdStrike Falcon® Next-Gen SIEM API."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/SIEM_Datadog":{"id":"components/schemas/SIEM_Datadog","kind":"json-schema","title":"siem | Datadog Cloud SIEM","data":{"title":"siem | Datadog Cloud SIEM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Datadog Cloud SIEM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/datadog-siem-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"application_key_credential":{"allOf":[{"$ref":"#/components/schemas/DatadogApplicationKeyCredential","description":"Datadog application key."},{"title":"Application Key","description":"Datadog application key."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/DatadogApiKeyCredential","description":"Datadog API key."},{"title":"API Key","description":"Datadog API key."}]},"site":{"allOf":[{"type":"string","nullable":true,"description":"Datadog site identifier or full URL for custom deployments."},{"default":"datadoghq.com","example":"us3.datadoghq.com"},{"title":"Site","description":"Datadog site identifier or full URL for custom deployments."}]}},"required":["application_key_credential","credential"]}},"components/schemas/SIEM_Elasticsearch":{"id":"components/schemas/SIEM_Elasticsearch","kind":"json-schema","title":"siem | Elastic SIEM","data":{"title":"siem | Elastic SIEM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Elastic SIEM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/elastic-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"auth_options":{"allOf":[{"$ref":"#/components/schemas/ElasticsearchAuthOptions","nullable":true},{"title":"Authentication Options"}]},"create_index":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The index or data stream to use when writing events. Defaults to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"index"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" setting if not set."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Create Index","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The index or data stream to use when writing events. Defaults to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"index"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" setting if not set."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/ElasticsearchCredential"},{"title":"Credential"}]},"index":{"allOf":[{"type":"string","nullable":true,"description":"The index, data stream, or index alias to read events from."},{"default":"_all"},{"title":"Read Index","description":"The index, data stream, or index alias to read events from."}]},"kibana_url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Kibana API."},{"example":"https://tenant.elastic.com"},{"title":"Kibana API base URL","description":"Base URL for the Kibana API.\n"}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the Elasticsearch TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the Elasticsearch TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Elasticsearch API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.elastic.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Elasticsearch API."}]}},"required":["credential","url"]}},"components/schemas/SIEM_GoogleChronicle":{"id":"components/schemas/SIEM_GoogleChronicle","kind":"json-schema","title":"siem | Google Security Operations (Chronicle Compatibility)","data":{"title":"siem | Google Security Operations (Chronicle Compatibility)","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Security Operations (formerly Google Chronicle) as a SIEM Provider connecting via the older Backstory and Malachite APIs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-chronicle-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"customer_id":{"allOf":[{"type":"string","nullable":true,"description":"The customer ID reported when writing events. This field is required if writing events."},{"title":"Customer Id","description":"The customer ID reported when writing events. This field is required if writing events."}]},"ingestion_credential":{"allOf":[{"$ref":"#/components/schemas/GoogleChronicleCredential","nullable":true,"description":"Credentials used for writing events. If not specified then writing events is disabled."},{"title":"Ingestion Credential","description":"Credentials used for writing events. If not specified then writing events is disabled."}]},"ingestion_url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Google SecOps Ingestion API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://malachiteingestion-pa.googleapis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Ingestion API base URL","description":"Base URL for the Google SecOps Ingestion API."}]},"search_credential":{"allOf":[{"$ref":"#/components/schemas/GoogleChronicleCredential","description":"Credentials used for querying and reading events."},{"title":"Search Credential","description":"Credentials used for querying and reading events."}]},"search_url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Google SecOps Search API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://backstory.googleapis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Search API base URL","description":"Base URL for the Google SecOps Search API."}]}},"required":["search_credential"]}},"components/schemas/SIEM_GoogleSecurityOperations":{"id":"components/schemas/SIEM_GoogleSecurityOperations","kind":"json-schema","title":"siem | Google Security Operations","data":{"title":"siem | Google Security Operations","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Security Operations (formerly Google Chronicle) as a SIEM Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-security-operations-siem-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GoogleServiceAccountCredential","description":"Credentials used for accessing the Google SecOps instance."},{"title":"Credential","description":"Credentials used for accessing the Google SecOps instance."}]},"customer_id":{"allOf":[{"type":"string","description":"The customer ID of the Google SecOps instance."},{"title":"Customer Id","description":"The customer ID of the Google SecOps instance."}]},"project_id":{"allOf":[{"type":"string","description":"The project ID of the Google SecOps instance."},{"title":"Project Id","description":"The project ID of the Google SecOps instance."}]},"region":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The region of the Google SecOps instance. Usually "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"us"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"eu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"us"},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The region of the Google SecOps instance. Usually "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"us"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"eu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"The base URL for the Google SecOps API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{region}-chronicle.googleapis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"The base URL for the Google SecOps API."}]}},"required":["credential","customer_id","project_id"]}},"components/schemas/SIEM_Mock":{"id":"components/schemas/SIEM_Mock","kind":"json-schema","title":"siem | Test Provider","data":{"title":"siem | Test Provider","type":"object","description":"Configuration for the Synqly mock in-memory SIEM Provider. This provider is for testing purposes only and does not retain events pushed to it.","properties":{"index":{"allOf":[{"type":"string","nullable":true,"description":"Name of the index where events are stored."},{"title":"Index","description":"Name of the index where events are stored."}]}}}},"components/schemas/SIEM_OpenSearch":{"id":"components/schemas/SIEM_OpenSearch","kind":"json-schema","title":"siem | OpenSearch","data":{"title":"siem | OpenSearch","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for OpenSearch search and analytics engine. Supports both managed and self-hosted OpenSearch deployments"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/opensearch-siem-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"create_index":{"allOf":[{"type":"string","nullable":true,"description":"The index or data stream to use when writing events. Defaults to the 'index' setting if not set."},{"title":"Write Index","description":"The index or data stream to use when writing events. Defaults to the 'index' setting if not set.\n"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/OpenSearchCredential"},{"title":"Credential"}]},"index":{"allOf":[{"type":"string","nullable":true,"description":"The index, data stream, or index alias to read events from."},{"default":"_all"},{"title":"Read Index","description":"The index, data stream, or index alias to read events from.\n"}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the OpenSearch TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the OpenSearch TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the OpenSearch API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.elastic.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the OpenSearch API.\n"}]}},"required":["credential","url"]}},"components/schemas/SIEM_Panther":{"id":"components/schemas/SIEM_Panther","kind":"json-schema","title":"siem | Panther SIEM","data":{"title":"siem | Panther SIEM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Panther SIEM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/panther-siem-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"api_config":{"allOf":[{"$ref":"#/components/schemas/ApiConfig","description":"Configuration required to connect to Panther SIEM APIs."},{"title":"API Configuration","description":"Configuration required to connect to Panther SIEM APIs."}]},"http_ingest":{"allOf":[{"$ref":"#/components/schemas/HttpIngest","nullable":true,"description":"Configuration for event ingestion. Only necessary when writing events to Panther."},{"title":"HTTP Ingest","description":"Configuration for event ingestion. Only necessary when writing events to Panther."}]}},"required":["api_config"]}},"components/schemas/SIEM_QRadar":{"id":"components/schemas/SIEM_QRadar","kind":"json-schema","title":"siem | IBM QRadar SIEM","data":{"title":"siem | IBM QRadar SIEM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for IBM QRadar SIEM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/qradar-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"collection_port":{"allOf":[{"type":"integer","description":"Port used by QRadar to accept incoming HTTP Receiver events."},{"title":"Collection Port","description":"Port used by QRadar to accept incoming HTTP Receiver events."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/QRadarCredential"},{"title":"Credential"}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the QRadar TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the QRadar TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the QRadar API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://qradar.westus2.cloudapp.azure.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the QRadar API."}]}},"required":["collection_port","credential","url"]}},"components/schemas/SIEM_Rapid7InsightIDR":{"id":"components/schemas/SIEM_Rapid7InsightIDR","kind":"json-schema","title":"siem | Rapid7 InsightIDR","data":{"title":"siem | Rapid7 InsightIDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Rapid7 InsightIDR."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/rapid7-idr-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/Rapid7InsightCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Rapid7 API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://us2.api.insight.rapid7.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Rapid7 API."}]}},"required":["credential","url"]}},"components/schemas/SIEM_Sentinel":{"id":"components/schemas/SIEM_Sentinel","kind":"json-schema","title":"siem | Microsoft Sentinel","data":{"title":"siem | Microsoft Sentinel","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Microsoft Sentinel SIEM Product."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/microsoft-sentinel-siem-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"azure_cloud":{"allOf":[{"$ref":"#/components/schemas/AzureCloud","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Which Microsoft cloud the workspace is in: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"public"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for Azure Government with a GCC High tenant, or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for Azure Government with a DoD tenant."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"public"},{"title":"Azure Cloud","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Which Microsoft cloud the workspace is in: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"public"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for Azure Government with a GCC High tenant, or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for Azure Government with a DoD tenant."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"credential":{"allOf":[{"$ref":"#/components/schemas/SentinelCredential"},{"title":"Credential"}]},"default_tables":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The default tables to use for queries. Supply this value if you would like to a subset of the default tables or non-ASIM data tables with Sentinel/Log Analytics queries."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If more than one table is specified, a union operator will join them to query all of the tables at once. Supply a single value with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"*"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if you would like to query all tables without the normalizing ASIM transformations."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that a single "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"*"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entry will map to a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"union *"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" query. Relying heavily on these queries is generally discouraged by Sentinel because they are slower and more resource intensive."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":["_Im_AgentEvent","_Im_AlertEvent","_Im_AssetEntity","_Im_AuditEvent","_Im_Authentication","_Im_DhcpEvent","_Im_Dns","_Im_FileEvent","_Im_NetworkSession","_Im_ProcessEvent","_Im_RegistryEvent","_Im_UserManagement","_Im_WebSession"]},{"title":"Default Tables","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The default tables to use for queries. Supply this value if you would like to a subset of the default tables or non-ASIM data tables with Sentinel/Log Analytics queries."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If more than one table is specified, a union operator will join them to query all of the tables at once. Supply a single value with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"*"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if you would like to query all tables without the normalizing ASIM transformations."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that a single "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"*"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entry will map to a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"union *"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" query. Relying heavily on these queries is generally discouraged by Sentinel because they are slower and more resource intensive."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"ingest_url":{"allOf":[{"type":"string","nullable":true,"description":"Either the logs ingestion API url for you Data Collection Rule or your Data Collection Endpoint URL. This value must be supplied to ingest data into Microsoft Sentinel. This should look something like https://mydcr-xxx-westus2.logs.z1.ingest.monitor.azure.com"},{"title":"Ingest URL","description":"Either the logs ingestion API url for you Data Collection Rule or your Data Collection Endpoint URL. This value must be supplied to ingest data into Microsoft Sentinel. This should look something like https://mydcr-xxx-westus2.logs.z1.ingest.monitor.azure.com"}]},"logs_url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for the Microsoft Azure Monitor Logs API, for custom or proxied environments. Must be in the same Microsoft cloud as Azure Cloud."},{"title":"Base Logs URL","description":"Base URL override for the Microsoft Azure Monitor Logs API, for custom or proxied environments. Must be in the same Microsoft cloud as Azure Cloud."}]},"management_url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL override for the Microsoft Azure Management API, for custom or proxied environments. Must be in the same Microsoft cloud as Azure Cloud."},{"title":"Base Management URL","description":"Base URL override for the Microsoft Azure Management API, for custom or proxied environments. Must be in the same Microsoft cloud as Azure Cloud."}]},"resource_group":{"allOf":[{"type":"string","description":"Azure resource group name that contains the Microsoft Sentinel workspace."},{"title":"Resource Group","description":"Azure resource group name that contains the Microsoft Sentinel workspace."}]},"rule_id":{"allOf":[{"type":"string","nullable":true,"description":"Immutable ID of the Data Collection Rule. This value must be supplied to ingest data into Microsoft Sentinel."},{"title":"Data Collection Rule ID","description":"Immutable ID of the Data Collection Rule. This value must be supplied to ingest data into Microsoft Sentinel."}]},"stream_name":{"allOf":[{"type":"string","nullable":true,"description":"Name of the Data Collection Rule stream. This value must be supplied to ingest data into Microsoft Sentinel."},{"title":"Data Collection Rule stream","description":"Name of the Data Collection Rule stream. This value must be supplied to ingest data into Microsoft Sentinel."}]},"subscription_id":{"allOf":[{"type":"string","description":"Azure subscription ID that contains the Microsoft Sentinel workspace."},{"title":"Subscription ID","description":"Azure subscription ID that contains the Microsoft Sentinel workspace."}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure Active Directory tenant ID that contains the Microsoft Sentinel workspace."},{"title":"Tenant ID","description":"Azure Active Directory tenant ID that contains the Microsoft Sentinel workspace."}]},"workspace_id":{"allOf":[{"type":"string","description":"ID of the Microsoft Sentinel Log Analytics workspace."},{"title":"Workspace ID","description":"ID of the Microsoft Sentinel Log Analytics workspace."}]},"workspace_name":{"allOf":[{"type":"string","description":"Name of the Microsoft Sentinel Log Analytics workspace."},{"title":"Workspace Name","description":"Name of the Microsoft Sentinel Log Analytics workspace."}]}},"required":["credential","resource_group","subscription_id","tenant_id","workspace_id","workspace_name"]}},"components/schemas/SIEM_Splunk":{"id":"components/schemas/SIEM_Splunk","kind":"json-schema","title":"siem | Splunk Enterprise Security","data":{"title":"siem | Splunk Enterprise Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Splunk Enterprise Security."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/splunk-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"hec_credential":{"allOf":[{"$ref":"#/components/schemas/SplunkHECToken","nullable":true,"description":"Credential to use when connecting to the Splunk HEC service. If not provided, sending events to Splunk is disabled."},{"title":"HEC Token","description":"Credential to use when connecting to the Splunk HEC service. If not provided, sending events to Splunk is disabled."}]},"hec_url":{"allOf":[{"type":"string","nullable":true,"description":"URL for the Splunk HEC endpoint. Must include the full path to the HEC endpoint."},{"example":"https://tenant.cloud.splunk.com:8088/services_collector_event"},{"title":"HEC URL","description":"URL for the Splunk HEC endpoint. Must include the full path to the HEC endpoint."}]},"index":{"allOf":[{"type":"string","nullable":true,"description":"Splunk index to send events to. If not provided, will use the default index for the Splunk collector."},{"title":"Index","description":"Splunk index to send events to. If not provided, will use the default index for the Splunk collector."}]},"search_service_credential":{"allOf":[{"$ref":"#/components/schemas/SplunkSearchCredential","description":"Credential used when authenticating with the Splunk Search Service."},{"title":"Search Service Token","description":"Credential used when authenticating with the Splunk Search Service."}]},"search_service_url":{"allOf":[{"type":"string","description":"URL used when connecting to the Splunk Search Service."},{"example":"https://splunk-service.com/services/collector/event"},{"title":"Search Service URL","description":"URL used when connecting to the Splunk Search Service."}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the Splunk TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the Splunk TLS certificate."}]},"source":{"allOf":[{"type":"string","nullable":true,"description":"Splunk source to send events to. If not provided the default source for the Splunk collector is used."},{"title":"Source","description":"Splunk source to send events to. If not provided the default source for the Splunk collector is used."}]},"source_type":{"allOf":[{"type":"string","nullable":true,"description":"Splunk source type to send events to. If not provided the default source type for the Splunk collector is used."},{"title":"Source Type","description":"Splunk source type to send events to. If not provided the default source type for the Splunk collector is used."}]}},"required":["search_service_credential","search_service_url"]}},"components/schemas/SIEM_SumoLogic":{"id":"components/schemas/SIEM_SumoLogic","kind":"json-schema","title":"siem | Sumo Logic Cloud SIEM","data":{"title":"siem | Sumo Logic Cloud SIEM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Sumo Logic Cloud SIEM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/sumo-logic-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"auto_parse_logs":{"allOf":[{"type":"boolean","nullable":true,"description":"Automatically parse logs as JSON when running log queries."},{"default":true},{"title":"Auto Parse Logs","description":"Automatically parse logs as JSON when running log queries."}]},"collection_url":{"allOf":[{"$ref":"#/components/schemas/SumoLogicCollectionUrl","nullable":true,"description":"Secure Sumo Logic Collection URL for writing events. If not provided, sending events to Sumo Logic is disabled."},{"title":"Collection URL","description":"Secure Sumo Logic Collection URL for writing events. If not provided, sending events to Sumo Logic is disabled."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/SumoLogicCredential"},{"title":"Credential"}]},"siem_logs_only":{"allOf":[{"type":"boolean","nullable":true,"description":"Only query for logs that have been processed into the Sumo Logic Cloud SIEM app."},{"default":false},{"title":"SIEM Logs Only","description":"Only query for logs that have been processed into the Sumo Logic Cloud SIEM app."}]},"url":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the Sumo Logic API."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://help.sumologic.com/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sumo Logic endpoints by deployment and firewall security"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the Sumo Logic API."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://help.sumologic.com/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sumo Logic endpoints by deployment and firewall security"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","url"]}},"components/schemas/SSF_Okta":{"id":"components/schemas/SSF_Okta","kind":"json-schema","title":"ssf | Okta Shared Signals","data":{"title":"ssf | Okta Shared Signals","type":"object","description":"Configuration for Okta as a Shared Signals provider.","properties":{"url":{"allOf":[{"type":"string","description":"URL of the Okta org that receives the security events."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{tenant}.okta.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"URL of the Okta org that receives the security events."}]}},"required":["url"]}},"components/schemas/SecureframeCredential":{"id":"components/schemas/SecureframeCredential","kind":"json-schema","title":"Secureframe Credential","data":{"title":"Secureframe Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"Secret Key"},"username":{"title":"Access Key"}},"description":"Secureframe API access key and secret."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"SecureframeCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"SecureframeCredential"}}]}},"components/schemas/SecureframeRegion":{"id":"components/schemas/SecureframeRegion","kind":"json-schema","title":"SecureframeRegion","data":{"title":"SecureframeRegion","type":"string","enum":["US","UK"]}},"components/schemas/SecurityAwareness_KnowBe4":{"id":"components/schemas/SecurityAwareness_KnowBe4","kind":"json-schema","title":"securityawareness | KnowBe4 Security Awareness Training (KSAT)","data":{"title":"securityawareness | KnowBe4 Security Awareness Training (KSAT)","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for KnowBe4 Security Awareness Training (KSAT) as a security awareness provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/knowbe4-securityawareness-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/KnowBe4Credential","description":"Credentials for the KnowBe4 Security Awareness Training (KSAT) API."},{"title":"Credential","description":"Credentials for the KnowBe4 Security Awareness Training (KSAT) API."}]},"region":{"allOf":[{"$ref":"#/components/schemas/KnowBe4Region","description":"Region for the KnowBe4 Security Awareness Training (KSAT) API."},{"title":"Region","description":"Region for the KnowBe4 Security Awareness Training (KSAT) API."}]}},"required":["credential","region"]}},"components/schemas/SentinelCredential":{"id":"components/schemas/SentinelCredential","kind":"json-schema","title":"Sentinel Credential","data":{"title":"Sentinel Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Client credentials for authenticating with Microsoft Sentinel."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The application registration must have appropriate permissions to read"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and write to Microsoft Sentinel. Required permissions:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Microsoft.OperationalInsights/workspaces/read"},"children":[],"type":"code"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Microsoft.OperationalInsights/workspaces/write"},"children":[],"type":"code"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Microsoft.SecurityInsights/dataConnectors/*"},"children":[],"type":"code"}],"type":"item"}],"type":"list"}]}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"SentinelCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"SentinelCredential"}}]}},"components/schemas/SentinelOneCredential":{"id":"components/schemas/SentinelOneCredential","kind":"json-schema","title":"Sentinel One Credential","data":{"title":"Sentinel One Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Token."}],"required":["type"],"title":"New API Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SentinelOneCredential"}},{"description":"Reference to existing API Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SentinelOneCredential"}}]}},"components/schemas/SentinelOneEdrEventsCredential":{"id":"components/schemas/SentinelOneEdrEventsCredential","kind":"json-schema","title":"Sentinel One Edr Events Credential","data":{"title":"Sentinel One Edr Events Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SentinelOneEdrEventsCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SentinelOneEdrEventsCredential"}}]}},"components/schemas/ServiceNowCredential":{"id":"components/schemas/ServiceNowCredential","kind":"json-schema","title":"Service Now Credential","data":{"title":"Service Now Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Username and secret used to authenticate with ServiceNow. The password can be a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.servicenow.com/bundle/vancouver-platform-administration/page/administer/users-and-groups/task/t_CreateAUser.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"generated token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"ServiceNowCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"ServiceNowCredential"}},{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"extra":{"title":"Extra","properties":{"scopes":{"description":"Scopes to request when authenticating with OAuth 2.0 client credentials. Only set this when a specific Auth Scope is required.","items":{"type":"string"},"title":"Scopes","type":"array"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional connection-specific configuration. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"scopes"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to specify which OAuth scopes to request during authentication."},"children":[],"type":"text"}],"type":"paragraph"}],"nullable":true}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth client credentials used to authenticate with ServiceNow. Requires ServiceNow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Washington D.C."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or later."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"ServiceNowCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"ServiceNowCredential"}},{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Token used to authenticate with ServiceNow. Requires ServiceNow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Washington D.C."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or later."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"ServiceNowCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"ServiceNowCredential"}}]}},"components/schemas/SevcoCredential":{"id":"components/schemas/SevcoCredential","kind":"json-schema","title":"Sevco Credential","data":{"title":"Sevco Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This credential must be an API Secret Key. Generate this key in the UI console. For more details, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.sev.co/docs/using-the-api#creating-an-api-key"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creating an API Key"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Sevco API Secret Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SevcoCredential"}},{"description":"Reference to existing Sevco API Secret Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Sevco API Secret Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SevcoCredential"}}]}},"components/schemas/Sink_AmazonSecurityLake":{"id":"components/schemas/Sink_AmazonSecurityLake","kind":"json-schema","title":"sink | Amazon Security Lake","data":{"title":"sink | Amazon Security Lake","type":"object","description":"Configuration for Amazon Security Lake as a Sink provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Security Lake"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Credential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Security Lake"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"custom_log_sources":{"allOf":[{"$ref":"#/components/schemas/amazon_security_lake_custom_log_sources_config","description":"Amazon Security Lake custom log sources to write events to."},{"title":"Custom Log Sources","description":"Amazon Security Lake custom log sources to write events to."}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Security Lake provider."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use for the Amazon Security Lake provider."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","custom_log_sources","region"]}},"components/schemas/Sink_AwsS3":{"id":"components/schemas/Sink_AwsS3","kind":"json-schema","title":"sink | Amazon S3","data":{"title":"sink | Amazon S3","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Amazon S3 as a Sink provider. Events are written directly to an AWS S3 bucket in compressed JSON format."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-s3-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the Amazon S3 bucket"},{"title":"Bucket","description":"Name of the Amazon S3 bucket"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":"AWS credentials with write access to the configured S3 bucket."},{"title":"Credential","description":"AWS credentials with write access to the configured S3 bucket."}]},"endpoint":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional custom S3 endpoint URL. If not provided, the default AWS S3"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"endpoint will be used. This is useful for testing with Minio or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"other S3-compatible services. Not supported in combination with"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Endpoint","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional custom S3 endpoint URL. If not provided, the default AWS S3"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"endpoint will be used. This is useful for testing with Minio or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"other S3-compatible services. Not supported in combination with"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"aws_role"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"path":{"allOf":[{"type":"string","description":"Files will be written under this path."},{"title":"Path","description":"Files will be written under this path."}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":"AWS Region where the S3 bucket is located."},{"title":"AWS Region","description":"AWS Region where the S3 bucket is located."}]}},"required":["bucket","credential","path","region"]}},"components/schemas/Sink_AwsSQS":{"id":"components/schemas/Sink_AwsSQS","kind":"json-schema","title":"sink | Amazon SQS","data":{"title":"sink | Amazon SQS","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Amazon Simple Queue Service (SQS)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-sqs-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":"AWS credentials with write access to the configured SQS queue."},{"title":"Credential","description":"AWS credentials with write access to the configured SQS queue."}]},"events_per_message":{"allOf":[{"$ref":"#/components/schemas/SinkAwsSqsEventsPerMessage","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How events are packed into SQS messages. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"page_of_events"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Events Per Message","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How events are packed into SQS messages. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"page_of_events"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"region":{"allOf":[{"type":"string","nullable":true,"description":"Overrides the default AWS region. If not present, the region will be inferred from the URL."},{"title":"Region","description":"Overrides the default AWS region. If not present, the region will be inferred from the URL."}]},"url":{"allOf":[{"type":"string","description":"HTTP(S) URL of the queue; must be a valid SQS queue URL (validated when connecting)."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Queue URL","description":"HTTP(S) URL of the queue; must be a valid SQS queue URL (validated when connecting)."}]}},"required":["credential","url"]}},"components/schemas/Sink_AwsSecurityLake":{"id":"components/schemas/Sink_AwsSecurityLake","kind":"json-schema","title":"sink | Amazon Security Lake","data":{"title":"sink | Amazon Security Lake","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Amazon Security Lake as a Sink provider. Events are written directly to an AWS S3 bucket in Apache Parquet format."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/amazon-security-lake-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":"AWS credentials with write access to the configured S3 bucket."},{"title":"Credential","description":"AWS credentials with write access to the configured S3 bucket."}]},"region":{"allOf":[{"type":"string","nullable":true,"description":"Override the default AWS region for this integration. If not present, the region will be inferred from the URL."},{"title":"Region","description":"Override the default AWS region for this integration. If not present, the region will be inferred from the URL."}]},"url":{"allOf":[{"type":"string","description":"URL of the S3 bucket where the Amazon Security Lake events are stored."},{"format":"uri"},{"title":"URL","description":"URL of the S3 bucket where the Amazon Security Lake events are stored."}]}},"required":["credential","url"]}},"components/schemas/Sink_AzureBlob":{"id":"components/schemas/Sink_AzureBlob","kind":"json-schema","title":"sink | Microsoft Azure Blob Storage","data":{"title":"sink | Microsoft Azure Blob Storage","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Azure Blob Storage as a Sink provider. Events are written directly to an Azure Blob Storage container in compressed JSON format."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/azure-blob-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the Azure Blob Storage container"},{"title":"Container","description":"Name of the Azure Blob Storage container"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/AzureBlobCredential","description":"Azure token with write access to the configured blob container."},{"title":"Credential","description":"Azure token with write access to the configured blob container."}]},"path":{"allOf":[{"type":"string","description":"Files will be written under this path."},{"title":"Path","description":"Files will be written under this path."}]}},"required":["bucket","credential","path"]}},"components/schemas/Sink_AzureMonitorLogs":{"id":"components/schemas/Sink_AzureMonitorLogs","kind":"json-schema","title":"sink | Microsoft Azure Monitor Logs","data":{"title":"sink | Microsoft Azure Monitor Logs","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Azure Monitor Logs as a Sink Provider. Azure Monitor Logs is a feature of Azure Monitor that collects and organizes log and performance data from monitored resources."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/azure-monitor-logs"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"azure_cloud":{"allOf":[{"$ref":"#/components/schemas/AzureCloud","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Which Microsoft cloud the data collection endpoint is in: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"public"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for Azure Government. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" behaves the same as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"public"},{"title":"Azure Cloud","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Which Microsoft cloud the data collection endpoint is in: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"public"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for Azure Government. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"dod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" behaves the same as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"government"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"client_id":{"allOf":[{"type":"string","description":"Azure Client (Application) ID."},{"title":"Client ID","description":"Azure Client (Application) ID."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/AzureMonitorLogsCredential","description":"Credential with access to the configured data collection endpoint."},{"title":"Credential","description":"Credential with access to the configured data collection endpoint."}]},"rule_id":{"allOf":[{"type":"string","description":"Data collection rule immutable ID."},{"title":"Rule ID","description":"Data collection rule immutable ID."}]},"stream_name":{"allOf":[{"type":"string","description":"Name of the data collection rule stream."},{"title":"Stream Name","description":"Name of the data collection rule stream."}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure Directory (tenant) ID."},{"title":"Tenant ID","description":"Azure Directory (tenant) ID."}]},"url":{"allOf":[{"type":"string","description":"URL of the Azure data collection endpoint."},{"title":"Collection URL","description":"URL of the Azure data collection endpoint."}]}},"required":["client_id","credential","rule_id","stream_name","tenant_id","url"]}},"components/schemas/Sink_CrowdstrikeHEC":{"id":"components/schemas/Sink_CrowdstrikeHEC","kind":"json-schema","title":"sink | CrowdStrike Next-Gen SIEM (HEC)","data":{"title":"sink | CrowdStrike Next-Gen SIEM (HEC)","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for CrowdStrike Falcon® Next-Gen SIEM (HEC)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/crowdstrike-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdstrikeHECCredential"},{"title":"API Key"}]},"url":{"allOf":[{"type":"string","description":"HTTPS URL for the CrowdStrike HTTP Event Collector (HEC) API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://<some-guid>.ingest.us-2.crowdstrike.com/services/collector","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"HEC URL","description":"HTTPS URL for the CrowdStrike HTTP Event Collector (HEC) API."}]}},"required":["credential","url"]}},"components/schemas/Sink_Datadog":{"id":"components/schemas/Sink_Datadog","kind":"json-schema","title":"sink | Datadog Logs","data":{"title":"sink | Datadog Logs","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Datadog Logs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/datadog-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DatadogApiKeyCredential","description":"Datadog API key."},{"title":"API Key","description":"Datadog API key."}]},"site":{"allOf":[{"type":"string","nullable":true,"description":"Datadog site identifier or full URL for custom deployments."},{"default":"datadoghq.com","example":"us3.datadoghq.com"},{"title":"Site","description":"Datadog site identifier or full URL for custom deployments."}]}},"required":["credential"]}},"components/schemas/Sink_Elasticsearch":{"id":"components/schemas/Sink_Elasticsearch","kind":"json-schema","title":"sink | Elasticsearch","data":{"title":"sink | Elasticsearch","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Elasticsearch."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/elastic-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"auth_options":{"allOf":[{"$ref":"#/components/schemas/ElasticsearchAuthOptions","nullable":true},{"title":"Authentication Options"}]},"create_index":{"allOf":[{"type":"string","description":"The index or data stream to use when writing events."},{"title":"Create Index","description":"The index or data stream to use when writing events."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/ElasticsearchCredential"},{"title":"Credential"}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the Elasticsearch TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the Elasticsearch TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Elasticsearch API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.elastic.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Elasticsearch API."}]}},"required":["create_index","credential","url"]}},"components/schemas/Sink_Gcs":{"id":"components/schemas/Sink_Gcs","kind":"json-schema","title":"sink | Google Cloud Storage","data":{"title":"sink | Google Cloud Storage","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Cloud Storage as a Sink provider. Events are written directly to a GCS bucket in compressed JSON format."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/gcs-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the GCS bucket"},{"title":"Bucket","description":"Name of the GCS bucket"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/GCSJsonCredential","description":"Google Cloud Service Account JSON key with write access to the configured GCS bucket"},{"title":"Credential","description":"Google Cloud Service Account JSON key with write access to the configured GCS bucket"}]},"path":{"allOf":[{"type":"string","description":"Files will be written under this path."},{"title":"Path","description":"Files will be written under this path."}]}},"required":["bucket","credential","path"]}},"components/schemas/Sink_GoogleSecOps":{"id":"components/schemas/Sink_GoogleSecOps","kind":"json-schema","title":"sink | Google Security Operations","data":{"title":"sink | Google Security Operations","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Security Operations (formerly Google Chronicle) as a Sink Provider connecting via the older Malachite API."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-chronicle-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GoogleChronicleCredential","description":"Credentials used when writing events."},{"title":"Credential","description":"Credentials used when writing events."}]},"customer_id":{"allOf":[{"type":"string","description":"The customer ID reported when writing events."},{"title":"Customer Id","description":"The customer ID reported when writing events."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Google SecOps Ingestion API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://malachiteingestion-pa.googleapis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Ingestion API base URL","description":"Base URL for the Google SecOps Ingestion API."}]}},"required":["credential","customer_id"]}},"components/schemas/Sink_GoogleSecurityOperations":{"id":"components/schemas/Sink_GoogleSecurityOperations","kind":"json-schema","title":"sink | Google Security Operations","data":{"title":"sink | Google Security Operations","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Security Operations (formerly Google Chronicle) as a Sink Provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-security-operations-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GoogleServiceAccountCredential","description":"Credentials used for accessing the Google SecOps instance."},{"title":"Credential","description":"Credentials used for accessing the Google SecOps instance."}]},"customer_id":{"allOf":[{"type":"string","description":"The customer ID of the Google SecOps instance"},{"title":"Customer Id","description":"The customer ID of the Google SecOps instance"}]},"project_id":{"allOf":[{"type":"string","description":"The project ID of the Google SecOps instance."},{"title":"Project Id","description":"The project ID of the Google SecOps instance."}]},"region":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The region of the Google SecOps instance. Usually "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"us"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"eu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":"us"},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The region of the Google SecOps instance. Usually "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"us"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"eu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"The base URL for the Google SecOps API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{region}-chronicle.googleapis.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"The base URL for the Google SecOps API."}]}},"required":["credential","customer_id","project_id"]}},"components/schemas/Sink_Http":{"id":"components/schemas/Sink_Http","kind":"json-schema","title":"sink | Generic HTTP Receiver","data":{"title":"sink | Generic HTTP Receiver","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generic Sink provider for sending events to any HTTP endpoint. Ideal for integrating with log aggregators, SIEM platforms, custom webhooks, data lakes, and any HTTP-based event ingestion system."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/http-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"accepted_response_codes":{"allOf":[{"type":"array","items":{"type":"integer"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HTTP status codes that indicate successful event delivery. Defaults to standard success codes. Configure if receiving endpoint uses different response codes (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"207 Multi-Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":[200,201,202,204]},{"title":"Accepted Response Codes","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HTTP status codes that indicate successful event delivery. Defaults to standard success codes. Configure if receiving endpoint uses different response codes (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"207 Multi-Status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"authorization":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverAuthConfig","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for authorizing requests with the receiving endpoint. Must be specified if the endpoint requires it. Can be combined with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Signing"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for defense-in-depth security."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for authorizing requests with the receiving endpoint. Must be specified if the endpoint requires it. Can be combined with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Signing"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for defense-in-depth security."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"http_method":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverMethod","nullable":true,"description":"HTTP method to use for sending events."},{"default":"POST"},{"title":"HTTP Method","description":"HTTP method to use for sending events."}]},"request_body_format":{"allOf":[{"$ref":"#/components/schemas/HttpRequestBodyFormat","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Format for serializing events in the HTTP request body. Choose based on receiving endpoint requirements and performance needs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"jsonl"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - JSON Lines (newline-delimited JSON) where each event is a separate JSON object on its own line. Memory efficient for large batches, supports streaming."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"json_array"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Standard JSON array format - events wrapped in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[{...}, {...}]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Simpler structure, easier debugging and testing."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},{"default":"jsonl"},{"title":"Request Body Format","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Format for serializing events in the HTTP request body. Choose based on receiving endpoint requirements and performance needs."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"jsonl"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - JSON Lines (newline-delimited JSON) where each event is a separate JSON object on its own line. Memory efficient for large batches, supports streaming."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"json_array"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Standard JSON array format - events wrapped in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[{...}, {...}]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Simpler structure, easier debugging and testing."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}]},"signing_credential":{"allOf":[{"$ref":"#/components/schemas/HttpReceiverSigningCredential","nullable":true,"description":"Enables payload signing, allowing the receiving endpoint to verify payload integrity and authenticity."},{"title":"Payload Signing","description":"Enables payload signing, allowing the receiving endpoint to verify payload integrity and authenticity."}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Disables TLS certification verification."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Warning:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" this disables security checks and makes connections vulnerable to man-in-the-middle attacks."},"children":[],"type":"text"}],"type":"paragraph"}]},{"default":false},{"title":"Skip TLS Verification","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Disables TLS certification verification."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Warning:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" this disables security checks and makes connections vulnerable to man-in-the-middle attacks."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"static_headers":{"allOf":[{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Additional HTTP headers to include on every request. Use for non-sensitive metadata like source system identifiers, API versioning, or custom routing headers that don't change per request."},{"title":"Static Headers","description":"Additional HTTP headers to include on every request. Use for non-sensitive metadata like source system identifiers, API versioning, or custom routing headers that don't change per request."}]},"timeout_seconds":{"allOf":[{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum timeout in seconds to wait for the receiving endpoint to respond. A value of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"0"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default) means no explicit timeout is set."},"children":[],"type":"text"}],"type":"paragraph"}]},{"maximum":295,"default":0},{"title":"Request Timeout","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum timeout in seconds to wait for the receiving endpoint to respond. A value of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"0"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (default) means no explicit timeout is set."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","description":"Receiving endpoint where events will be sent."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://logs.example.com/api/v1/events","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Target URL","description":"Receiving endpoint where events will be sent."}]}},"required":["url"]}},"components/schemas/Sink_Mock":{"id":"components/schemas/Sink_Mock","kind":"json-schema","title":"sink | Test Provider","data":{"title":"sink | Test Provider","type":"object","description":"Configuration for the Synqly mock in-memory Sink Provider. This provider is for testing purposes only and does not retain events pushed to it.","properties":{"destination":{"allOf":[{"type":"string","nullable":true,"description":"Name of the destination where events are stored. This field is unused and only used to demonstrate Provider configuration."},{"title":"Destination","description":"Name of the destination where events are stored. This field is unused and only used to demonstrate Provider configuration."}]}}}},"components/schemas/Sink_OpenSearch":{"id":"components/schemas/Sink_OpenSearch","kind":"json-schema","title":"sink | OpenSearch","data":{"title":"sink | OpenSearch","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for OpenSearch search and analytics engine. Supports both managed and self-hosted OpenSearch deployments"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/opensearch-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"create_index":{"allOf":[{"type":"string","description":"The index or data stream to use when writing events."},{"title":"Write Index","description":"The index or data stream to use when writing events.\n"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/OpenSearchCredential"},{"title":"Credential"}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the OpenSearch TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the OpenSearch TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the OpenSearch API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.elastic.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the OpenSearch API.\n"}]}},"required":["create_index","credential","url"]}},"components/schemas/Sink_Panther":{"id":"components/schemas/Sink_Panther","kind":"json-schema","title":"sink | Panther Sink","data":{"title":"sink | Panther Sink","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Panther Sink."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/panther-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PantherIngestionCredential","description":"Authenticates calls to your HTTP Ingest log source."},{"title":"Credential","description":"Authenticates calls to your HTTP Ingest log source."}]},"url":{"allOf":[{"type":"string","description":"The URL for your HTTP Log Source."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://logs.instance-id.runpanther.net/http/log-source-id","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Ingest URL","description":"The URL for your HTTP Log Source."}]}},"required":["credential","url"]}},"components/schemas/Sink_QRadar":{"id":"components/schemas/Sink_QRadar","kind":"json-schema","title":"sink | IBM QRadar Sink","data":{"title":"sink | IBM QRadar Sink","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for IBM QRadar Sink."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/qradar-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"collection_port":{"allOf":[{"type":"integer","description":"Port used by QRadar to accept incoming HTTP Receiver events."},{"title":"Collection Port","description":"Port used by QRadar to accept incoming HTTP Receiver events."}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the QRadar TLS certificate. This should only be used for testing purposes and is not recommended in production environments."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the QRadar TLS certificate. This should only be used for testing purposes and is not recommended in production environments."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the QRadar API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://qradar.westus2.cloudapp.azure.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the QRadar API."}]}},"required":["collection_port","url"]}},"components/schemas/Sink_Splunk":{"id":"components/schemas/Sink_Splunk","kind":"json-schema","title":"sink | Splunk Enterprise Security","data":{"title":"sink | Splunk Enterprise Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Splunk as a Sink provider. Allows sending data to Splunk using an HTTP Event Collector (HEC)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/splunk-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"hec_credential":{"allOf":[{"$ref":"#/components/schemas/SplunkHECToken","description":"Credential to use when connecting to the Splunk HEC service. If not provided, sending events to Splunk is disabled."},{"title":"HEC Token","description":"Credential to use when connecting to the Splunk HEC service. If not provided, sending events to Splunk is disabled."}]},"hec_url":{"allOf":[{"type":"string","description":"URL for the Splunk HEC endpoint. Must include the full path to the HEC endpoint."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.cloud.splunk.com:8088/services_collector_event","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"HEC URL","description":"URL for the Splunk HEC endpoint. Must include the full path to the HEC endpoint."}]},"index":{"allOf":[{"type":"string","nullable":true,"description":"Splunk index to send events to. If not provided, will use the default index for the Splunk collector."},{"title":"Index","description":"Splunk index to send events to. If not provided, will use the default index for the Splunk collector."}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the Splunk TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the Splunk TLS certificate."}]},"source":{"allOf":[{"type":"string","nullable":true,"description":"Splunk source to send events to. If not provided the default source for the Splunk collector is used."},{"title":"Source","description":"Splunk source to send events to. If not provided the default source for the Splunk collector is used."}]},"source_type":{"allOf":[{"type":"string","nullable":true,"description":"Splunk source type to send events to. If not provided the default source type for the Splunk collector is used."},{"title":"Source Type","description":"Splunk source type to send events to. If not provided the default source type for the Splunk collector is used."}]}},"required":["hec_credential","hec_url"]}},"components/schemas/Sink_SumoLogic":{"id":"components/schemas/Sink_SumoLogic","kind":"json-schema","title":"sink | Sumo Logic Sink","data":{"title":"sink | Sumo Logic Sink","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Sumo Logic as a Sink provider. Allows sending data to Sumo Logic using a collection URL."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/sumo-logic-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"collection_url":{"allOf":[{"$ref":"#/components/schemas/SumoLogicCollectionUrl","description":"Sumo Logic Collection URL for writing events."},{"title":"Collection URL","description":"Sumo Logic Collection URL for writing events."}]}},"required":["collection_url"]}},"components/schemas/Sink_Swimlane":{"id":"components/schemas/Sink_Swimlane","kind":"json-schema","title":"sink | Swimlane Turbine Sink","data":{"title":"sink | Swimlane Turbine Sink","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Swimlane Turbine Sink."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/swimlane-turbine-sink-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SwimlaneCredential","description":"Authenticates calls to your Swimlane Turbine webhook."},{"title":"Credential","description":"Authenticates calls to your Swimlane Turbine webhook."}]},"url":{"allOf":[{"type":"string","description":"The full Swimlane Turbine webhook URL."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Webhook URL","description":"The full Swimlane Turbine webhook URL."}]}},"required":["credential","url"]}},"components/schemas/Sink_Trimedx":{"id":"components/schemas/Sink_Trimedx","kind":"json-schema","title":"sink | Trimedx","data":{"title":"sink | Trimedx","type":"object","description":"Configuration for Trimedx Sink.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TrimedxCredential"},{"title":"Credential"}]},"customer_id":{"allOf":[{"type":"string","description":"The customer ID for the Trimedx instance."},{"title":"Customer ID","description":"The customer ID for the Trimedx instance."}]},"subscription_key":{"allOf":[{"type":"string","description":"The subscription key for the Trimedx instance."},{"title":"Subscription Key","description":"The subscription key for the Trimedx instance."}]},"username":{"allOf":[{"type":"string"},{"title":"Username"}]}},"required":["credential","customer_id","subscription_key","username"]}},"components/schemas/SinkAwsSqsEventsPerMessage":{"id":"components/schemas/SinkAwsSqsEventsPerMessage","kind":"json-schema","title":"SinkAwsSqsEventsPerMessage","data":{"title":"SinkAwsSqsEventsPerMessage","type":"string","enum":["single_event","page_of_events"]}},"components/schemas/SlackCredential":{"id":"components/schemas/SlackCredential","kind":"json-schema","title":"Slack Credential","data":{"title":"Slack Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"Token","pattern":"^xoxb-.+$","x-validation-message":{"patternMismatch":"Bot token must start with `xoxb-`."}}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Follow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://api.slack.com/concepts/token-types#bot"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this guide to generate a bot token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The token must have the OAuth scopes required by the operations the integration performs; see the provider configuration guide for details."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Bot Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SlackCredential"}},{"description":"Reference to existing Bot Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Bot Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SlackCredential"}}]}},"components/schemas/SlackWebhookCredential":{"id":"components/schemas/SlackWebhookCredential","kind":"json-schema","title":"Slack Webhook Credential","data":{"title":"Slack Webhook Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{"secret":{"title":"Secret","pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Slack Incoming Webhook URL. Use a Slack app with Incoming Webhooks enabled to generate the URL. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://api.slack.com/messaging/webhooks"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"configuration guide on Incoming Webhooks"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more detail."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Incoming Webhook URL","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"SlackWebhookCredential"}},{"description":"Reference to existing Incoming Webhook URL.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Incoming Webhook URL","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"SlackWebhookCredential"}}]}},"components/schemas/SnykCredential":{"id":"components/schemas/SnykCredential","kind":"json-schema","title":"Snyk Credential","data":{"title":"Snyk Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"SnykCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"SnykCredential"}},{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Key Credentials."}],"required":["type"],"title":"New API Key Credentials","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SnykCredential"}},{"description":"Reference to existing API Key Credentials.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key Credentials","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SnykCredential"}}]}},"components/schemas/SnykRegion":{"id":"components/schemas/SnykRegion","kind":"json-schema","title":"SnykRegion","data":{"title":"SnykRegion","type":"string","enum":["SNYK-US-01","SNYK-US-02","SNYK-EU-01","SNYK-AU-01"]}},"components/schemas/SonarQubeCredential":{"id":"components/schemas/SonarQubeCredential","kind":"json-schema","title":"Sonar Qube Credential","data":{"title":"Sonar Qube Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SonarQubeCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SonarQubeCredential"}}]}},"components/schemas/SophosCredential":{"id":"components/schemas/SophosCredential","kind":"json-schema","title":"Sophos Credential","data":{"title":"Sophos Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"SophosCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"SophosCredential"}}]}},"components/schemas/SplunkHECToken":{"id":"components/schemas/SplunkHECToken","kind":"json-schema","title":"HEC Token","data":{"title":"HEC Token","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Token used when connecting to the Splunk HEC Service."}],"required":["type"],"title":"New HEC Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SplunkHECToken"}},{"description":"Reference to existing HEC Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing HEC Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SplunkHECToken"}}]}},"components/schemas/SplunkSearchCredential":{"id":"components/schemas/SplunkSearchCredential","kind":"json-schema","title":"Search Service Token","data":{"title":"Search Service Token","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Token used when connecting to the Splunk Search Service."}],"required":["type"],"title":"New Search Service Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SplunkSearchCredential"}},{"description":"Reference to existing Search Service Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Search Service Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SplunkSearchCredential"}}]}},"components/schemas/Storage_AwsS3":{"id":"components/schemas/Storage_AwsS3","kind":"json-schema","title":"storage | Amazon S3","data":{"title":"storage | Amazon S3","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Amazon S3."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/aws-s3-storage-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the Amazon S3 bucket where files are stored."},{"title":"Bucket","description":"Name of the Amazon S3 bucket where files are stored."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":"AWS credentials with write access to the configured S3 bucket."},{"title":"Credential","description":"AWS credentials with write access to the configured S3 bucket."}]},"endpoint":{"allOf":[{"type":"string","nullable":true,"description":"Endpoint used for connecting to Amazon S3 the external service. If not provided, the default Amazon S3 endpoint will be used."},{"title":"Endpoint","description":"Endpoint used for connecting to Amazon S3 the external service. If not provided, the default Amazon S3 endpoint will be used."}]},"region":{"allOf":[{"type":"string","description":"AWS region where the Amazon S3 bucket is located."},{"title":"Region","description":"AWS region where the Amazon S3 bucket is located."}]}},"required":["bucket","credential","region"]}},"components/schemas/Storage_AzureBlob":{"id":"components/schemas/Storage_AzureBlob","kind":"json-schema","title":"storage | Azure Blob Storage","data":{"title":"storage | Azure Blob Storage","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Azure Blob Storage as a Storage Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/azure-blob-storage-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the blob container where files are stored."},{"title":"Bucket","description":"Name of the blob container where files are stored."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/AzureBlobCredential"},{"title":"Credential"}]}},"required":["bucket","credential"]}},"components/schemas/Storage_GCS":{"id":"components/schemas/Storage_GCS","kind":"json-schema","title":"storage | Google Cloud Storage","data":{"title":"storage | Google Cloud Storage","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Google Cloud Storage for storing unstructured data"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/google-gcs-storage-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the bucket where files are stored."},{"title":"Bucket","description":"Name of the bucket where files are stored."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/GCSCredential"},{"title":"Credential"}]},"region":{"allOf":[{"type":"string","description":"Google Cloud region where the bucket is located."},{"title":"Region","description":"Google Cloud region where the bucket is located."}]}},"required":["bucket","credential","region"]}},"components/schemas/Storage_Mock":{"id":"components/schemas/Storage_Mock","kind":"json-schema","title":"storage | Test Provider","data":{"title":"storage | Test Provider","type":"object","description":"Configuration for the Synqly mock in-memory storage Provider. This provider is for testing purposes only and does not retain files pushed to it.","properties":{"bucket":{"allOf":[{"type":"string","description":"Name of the bucket where files are stored."},{"title":"Bucket","description":"Name of the bucket where files are stored."}]}},"required":["bucket"]}},"components/schemas/SumoLogicCollectionUrl":{"id":"components/schemas/SumoLogicCollectionUrl","kind":"json-schema","title":"Sumo Logic Collection Url","data":{"title":"Sumo Logic Collection Url","oneOf":[{"allOf":[{"properties":{"type":{"enum":["secret"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{"secret":{"title":"Collection URL","pattern":"^(https?:.+|synqly:.+)$","format":"uri","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}}},"description":"Sumo Logic HTTP collection URL used to write events."}],"required":["type"],"title":"New Secret","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"SumoLogicCollectionUrl"}},{"description":"Reference to existing Secret.","properties":{"type":{"enum":["secret_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Secret","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"SumoLogicCollectionUrl"}}]}},"components/schemas/SumoLogicCredential":{"id":"components/schemas/SumoLogicCredential","kind":"json-schema","title":"Sumo Logic Credential","data":{"title":"Sumo Logic Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{"secret":{"title":"Access Key","description":"Access key secret."},"username":{"title":"Access ID","description":"Access key identifier."}},"description":"Access ID and Access Key used to authenticate with Sumo Logic."}],"required":["type"],"title":"New Access Keys","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"SumoLogicCredential"}},{"description":"Reference to existing Access Keys.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Access Keys","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"SumoLogicCredential"}}]}},"components/schemas/SwimlaneCredential":{"id":"components/schemas/SwimlaneCredential","kind":"json-schema","title":"Swimlane Webhook Credential","data":{"title":"Swimlane Webhook Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"Bearer Token","description":"The Bearer token for your Swimlane webhook endpoint."}},"description":"Configuration when creating new Token."}],"required":["type"],"title":"New Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"SwimlaneCredential"}},{"description":"Reference to existing Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"SwimlaneCredential"}}]}},"components/schemas/TaniumCloudCredential":{"id":"components/schemas/TaniumCloudCredential","kind":"json-schema","title":"Tanium Cloud Credential","data":{"title":"Tanium Cloud Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Configuration when creating new API Token."}],"required":["type"],"title":"New API Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TaniumCloudCredential"}},{"description":"Reference to existing API Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TaniumCloudCredential"}}]}},"components/schemas/TeamsCredential":{"id":"components/schemas/TeamsCredential","kind":"json-schema","title":"Teams Credential","data":{"title":"Teams Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"OAuth 2.0 Client Credentials for an Azure App Registration. The application must be configured with permissions to access Microsoft Power Automate with user delegation."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"TeamsCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"TeamsCredential"}},{"allOf":[{"properties":{"type":{"enum":["webhook_url"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SecretCredential"},{"type":"object","properties":{},"description":"Public Webhook URL used to authenticate with Teams."}],"required":["type"],"title":"New Webhook URL","type":"object","x-synqly-credential":{"extends":"SecretCredential","type":"TeamsCredential"}},{"description":"Reference to existing Webhook URL.","properties":{"type":{"enum":["webhook_url_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/SecretCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"webhook_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"webhook_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Webhook URL","type":"object","x-synqly-credential":{"extends":"SecretCredentialId","reference":true,"type":"TeamsCredential"}}]}},"components/schemas/TeamsGraphChatCredential":{"id":"components/schemas/TeamsGraphChatCredential","kind":"json-schema","title":"Teams Graph Chat Credential","data":{"title":"Teams Graph Chat Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Azure Client ID and Client Secret for a service principal."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"TeamsGraphChatCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"TeamsGraphChatCredential"}}]}},"components/schemas/TenableAsmCredential":{"id":"components/schemas/TenableAsmCredential","kind":"json-schema","title":"Tenable Asm Credential","data":{"title":"Tenable Asm Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"Tenable Attack Surface Management API key."}},"description":"Configuration when creating new API Key."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TenableAsmCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TenableAsmCredential"}}]}},"components/schemas/TenableCloudCredential":{"id":"components/schemas/TenableCloudCredential","kind":"json-schema","title":"Tenable Cloud Credential","data":{"title":"Tenable Cloud Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Keys","pattern":"^accessKey=.+?;secretKey=.+?;?$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"API Keys in the format "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessKey=<key>;secretKey=<secret>;"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"x-validation-message":{"patternMismatch":"Input must match the pattern: `accessKey=<key>;secretKey=<secret>;`"}}},"description":"Configuration when creating new API Keys."}],"required":["type"],"title":"New API Keys","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TenableCloudCredential"}},{"description":"Reference to existing API Keys.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Keys","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TenableCloudCredential"}}]}},"components/schemas/TenableCloudSecurityCredential":{"id":"components/schemas/TenableCloudSecurityCredential","kind":"json-schema","title":"Tenable Cloud Security Credential","data":{"title":"Tenable Cloud Security Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"Secret","description":"Secret of a Tenable Cloud Security service account whose role can view findings and inventory."}},"description":"Configuration when creating new Service Account Secret."}],"required":["type"],"title":"New Service Account Secret","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TenableCloudSecurityCredential"}},{"description":"Reference to existing Service Account Secret.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Service Account Secret","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TenableCloudSecurityCredential"}}]}},"components/schemas/TenableCloudSecurityRegion":{"id":"components/schemas/TenableCloudSecurityRegion","kind":"json-schema","title":"TenableCloudSecurityRegion","data":{"title":"TenableCloudSecurityRegion","type":"string","enum":["global","us_gov"]}},"components/schemas/TenableScCredential":{"id":"components/schemas/TenableScCredential","kind":"json-schema","title":"Tenable Sc Credential","data":{"title":"Tenable Sc Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Keys","pattern":"^accessKey=.+?;secretKey=.+?;?$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"API Keys in the format "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessKey=<key>;secretKey=<secret>;"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"x-validation-message":{"patternMismatch":"Input must match the pattern: `accessKey=<key>;secretKey=<secret>;`"}}},"description":"Configuration when creating new API Keys."}],"required":["type"],"title":"New API Keys","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TenableScCredential"}},{"description":"Reference to existing API Keys.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Keys","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TenableScCredential"}}]}},"components/schemas/ThreatFoxCredential":{"id":"components/schemas/ThreatFoxCredential","kind":"json-schema","title":"ThreatFox Credential","data":{"title":"ThreatFox Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"Auth-Key","description":"Secret value of the abuse.ch Auth-Key."}},"description":"The abuse.ch Auth-Key to authenticate lookups with."}],"required":["type"],"title":"New Auth-Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"ThreatFoxCredential"}},{"description":"Reference to existing Auth-Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Auth-Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"ThreatFoxCredential"}}]}},"components/schemas/ThreatIntel_AbuseIPDB":{"id":"components/schemas/ThreatIntel_AbuseIPDB","kind":"json-schema","title":"threatintel | AbuseIPDB","data":{"title":"threatintel | AbuseIPDB","type":"object","description":"Configuration for AbuseIPDB as a Threat Intelligence Provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AbuseIPDBCredential","description":"The AbuseIPDB API key to authenticate with the provider."},{"title":"Credential","description":"The AbuseIPDB API key to authenticate with the provider."}]}},"required":["credential"]}},"components/schemas/ThreatIntel_ThreatFox":{"id":"components/schemas/ThreatIntel_ThreatFox","kind":"json-schema","title":"threatintel | ThreatFox","data":{"title":"threatintel | ThreatFox","type":"object","description":"Configuration for ThreatFox as a Threat Intelligence Provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ThreatFoxCredential","description":"An abuse.ch Auth-Key to authenticate with the provider."},{"title":"Credential","description":"An abuse.ch Auth-Key to authenticate with the provider."}]}},"required":["credential"]}},"components/schemas/ThreatIntel_VirusTotal":{"id":"components/schemas/ThreatIntel_VirusTotal","kind":"json-schema","title":"threatintel | VirusTotal","data":{"title":"threatintel | VirusTotal","type":"object","description":"Configuration for VirusTotal as a Threat Intelligence Provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/VirusTotalCredential","description":"A VirusTotal API key to authenticate with the provider."},{"title":"Credential","description":"A VirusTotal API key to authenticate with the provider."}]}},"required":["credential"]}},"components/schemas/Ticketing_Autotask":{"id":"components/schemas/Ticketing_Autotask","kind":"json-schema","title":"ticketing | Autotask Operations Cloud","data":{"title":"ticketing | Autotask Operations Cloud","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Autotask Operations Cloud."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/autotask-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"api_integration_code_credential":{"allOf":[{"$ref":"#/components/schemas/AutotaskApiIntegrationCodeCredential"},{"title":"API Tracking ID"}]},"default_issue_type":{"allOf":[{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type (Ticket Category) for the integration. If provided, the issue_type field becomes optional in ticket creation requests. In Autotask, this corresponds to the Ticket Category ID."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Default Issue Type","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type (Ticket Category) for the integration. If provided, the issue_type field becomes optional in ticket creation requests. In Autotask, this corresponds to the Ticket Category ID."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"default_project":{"allOf":[{"type":"integer","nullable":true,"description":"Default Project (Company ID) for the integration. If provided, the project field becomes optional in ticket creation requests. In Autotask, this corresponds to the Company ID associated with tickets."},{"title":"Default Project","description":"Default Project (Company ID) for the integration. If provided, the project field becomes optional in ticket creation requests. In Autotask, this corresponds to the Company ID associated with tickets."}]},"secret_credential":{"allOf":[{"$ref":"#/components/schemas/AutotaskSecretCredential"},{"title":"Credential"}]},"user_name":{"allOf":[{"type":"string","description":"User name of the API User created to authenticate with the Autotask API."},{"title":"User Name","description":"User name of the API User created to authenticate with the Autotask API."}]},"zone_path":{"allOf":[{"type":"string","description":"Zone for the Autotask API."},{"title":"API Zone","description":"Zone for the Autotask API."}]}},"required":["api_integration_code_credential","secret_credential","user_name","zone_path"]}},"components/schemas/Ticketing_AzureDevOps":{"id":"components/schemas/Ticketing_AzureDevOps","kind":"json-schema","title":"ticketing | Azure DevOps Boards","data":{"title":"ticketing | Azure DevOps Boards","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Azure DevOps Boards."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/azuredevops-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AzureDevOpsTicketingCredential"},{"title":"Credential"}]},"default_issue_type":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default work item type for ticket creation (e.g., \"Issue\", \"Task\", \"Bug\"). If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Default Issue Type","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default work item type for ticket creation (e.g., \"Issue\", \"Task\", \"Bug\"). If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"organization":{"allOf":[{"type":"string","description":"Azure DevOps organization name."},{"title":"Organization","description":"Azure DevOps organization name."}]},"project":{"allOf":[{"type":"string","description":"Azure DevOps project name. Used as the default project scope for work item queries."},{"title":"Project","description":"Azure DevOps project name. Used as the default project scope for work item queries."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Azure DevOps API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://dev.azure.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Azure DevOps API."}]}},"required":["credential","organization","project","url"]}},"components/schemas/Ticketing_Bmchelix":{"id":"components/schemas/Ticketing_Bmchelix","kind":"json-schema","title":"ticketing | BMC Helix ITSM","data":{"title":"ticketing | BMC Helix ITSM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the BMC Helix ITSM Ticketing Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/bmchelix-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/BMCHelixCredential"},{"title":"Credential"}]},"insecure_skip_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the BMC Helix TLS certificate. Enable this when connecting to instances that use self-signed certificates."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the BMC Helix TLS certificate. Enable this when connecting to instances that use self-signed certificates."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the BMC Helix AR REST API. This should be the root URL of your BMC Helix ITSM instance without any path components."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://your-instance.bmc.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the BMC Helix AR REST API. This should be the root URL of your BMC Helix ITSM instance without any path components."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_Freshdesk":{"id":"components/schemas/Ticketing_Freshdesk","kind":"json-schema","title":"ticketing | Freshdesk","data":{"title":"ticketing | Freshdesk","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Freshdesk."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/freshdesk-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/FreshdeskCredential"},{"title":"Credential"}]},"default_contact":{"allOf":[{"type":"string","nullable":true,"description":"Default contact email for ticket creation. If provided, the contact field becomes optional in ticket creation requests. If not provided, the contact field is required."},{"title":"Default Contact Email","description":"Default contact email for ticket creation. If provided, the contact field becomes optional in ticket creation requests. If not provided, the contact field is required."}]},"default_type":{"allOf":[{"type":"string","nullable":true,"description":"Default issue type for ticket creation (e.g., \"Incident\", \"Problem\", \"Question\"). If provided, the type field becomes optional. If not provided, the type field is required."},{"title":"Default Issue Type","description":"Default issue type for ticket creation (e.g., \"Incident\", \"Problem\", \"Question\"). If provided, the type field becomes optional. If not provided, the type field is required."}]},"url":{"allOf":[{"type":"string","description":"Base URL to your Freshdesk tenant."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.freshdesk.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL to your Freshdesk tenant."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_GitHub":{"id":"components/schemas/Ticketing_GitHub","kind":"json-schema","title":"ticketing | GitHub Issues","data":{"title":"ticketing | GitHub Issues","type":"object","description":"Configuration for GitHub Issues as a ticketing provider.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GitHubCredential","description":"Fine-grained Personal Access Token with Issues Read and Write permission."},{"title":"Credential","description":"Fine-grained Personal Access Token with Issues Read and Write permission."}]},"repository":{"allOf":[{"type":"string","description":"Target repository in owner/repo format. All issue operations are scoped to this repository."},{"example":"my-org/my-repo"},{"title":"Repository","description":"Target repository in owner/repo format. All issue operations are scoped to this repository."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the GitHub environment. Only necessary with GitHub Enterprise Server deployments."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://github.com","example":"https://your-github-instance.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the GitHub environment. Only necessary with GitHub Enterprise Server deployments."}]}},"required":["credential","repository"]}},"components/schemas/Ticketing_Ivanti":{"id":"components/schemas/Ticketing_Ivanti","kind":"json-schema","title":"ticketing | Ivanti Neurons Ticketing","data":{"title":"ticketing | Ivanti Neurons Ticketing","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Ivanti Neurons Ticketing Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/ivanti-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IvantiCredentialTicketing"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Ivanti ITSM API. This should be the base URL for your Ivanti instance,  without any path components."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://your-instance.ivanticloud.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Ivanti ITSM API. This should be the base URL for your Ivanti instance,  without any path components."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_Ivanti_Mock":{"id":"components/schemas/Ticketing_Ivanti_Mock","kind":"json-schema","title":"ticketing | [MOCK] Ivanti Neurons Ticketing","data":{"title":"ticketing | [MOCK] Ivanti Neurons Ticketing","type":"object","description":"Configuration for a mocked Ivanti Neurons Ticketing Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/TicketingIvantiDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Ticketing_Jira":{"id":"components/schemas/Ticketing_Jira","kind":"json-schema","title":"ticketing | Atlassian Jira","data":{"title":"ticketing | Atlassian Jira","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Atlassian Jira."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/jira-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/JiraCredential"},{"title":"Credential"}]},"custom_field_mappings":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMapping"},"nullable":true,"description":"Custom field mappings for this provider."},{"title":"Custom Field Mappings","description":"Custom field mappings for this provider."}]},"default_issue_type":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Default Issue Type","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"default_project":{"allOf":[{"type":"string","nullable":true,"description":"Default Project for the integration."},{"title":"Default Project","description":"Default Project for the integration."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Jira tenant."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://tenant.atlassian.net","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Jira tenant."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_JiraServiceManagement":{"id":"components/schemas/Ticketing_JiraServiceManagement","kind":"json-schema","title":"ticketing | Jira Service Management Configuration","data":{"title":"ticketing | Jira Service Management Configuration","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Jira Service Management."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/jira-service-management-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/JiraCredential"},{"title":"Credential"}]},"custom_field_mappings":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMapping"},"nullable":true,"description":"Custom field mappings for this provider."},{"title":"Custom Field Mappings","description":"Custom field mappings for this provider."}]},"default_issue_type":{"allOf":[{"type":"string","nullable":true,"description":"Default issue type when creating tickets."},{"title":"Default Issue Type","description":"Default issue type when creating tickets."}]},"default_project":{"allOf":[{"type":"string","nullable":true,"description":"Default project when listing, creating, or editing tickets."},{"title":"Default Project","description":"Default project when listing, creating, or editing tickets."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Jira tenant."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.atlassian.net","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Jira tenant."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_Linear":{"id":"components/schemas/Ticketing_Linear","kind":"json-schema","title":"ticketing | Linear","data":{"title":"ticketing | Linear","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Linear."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/linear-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/LinearCredential"},{"title":"Credential"}]},"default_team_id":{"allOf":[{"type":"string","nullable":true,"description":"Default Linear team ID for issue creation. If not provided, a team must be specified in each create request."},{"title":"Default Team ID","description":"Default Linear team ID for issue creation. If not provided, a team must be specified in each create request."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Linear API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.linear.app","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Linear API."}]}},"required":["credential"]}},"components/schemas/Ticketing_Mock":{"id":"components/schemas/Ticketing_Mock","kind":"json-schema","title":"ticketing | Test Provider","data":{"title":"ticketing | Test Provider","type":"object","description":"Configuration for the Synqly mock in-memory ticketing Provider. This provider is for testing purposes only. It retains tickets for a limited time and does not persist them for long-term usage.","properties":{"custom_field_mappings":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMapping"},"nullable":true,"description":"Custom field mappings for this provider."},{"title":"Custom Field Mappings","description":"Custom field mappings for this provider."}]},"name":{"allOf":[{"type":"string","nullable":true,"description":"Optional name of the mock provider. This value is unused."},{"title":"Name","description":"Optional name of the mock provider. This value is unused."}]}}}},"components/schemas/Ticketing_PagerDuty":{"id":"components/schemas/Ticketing_PagerDuty","kind":"json-schema","title":"ticketing | PagerDuty Operations Cloud","data":{"title":"ticketing | PagerDuty Operations Cloud","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for PagerDuty Operations Cloud."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/pagerduty-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PagerDutyCredential"},{"title":"Credential"}]},"default_creator":{"allOf":[{"type":"string","nullable":true,"description":"Default email address for the creator field. If provided, the creator field becomes optional for ticket and comment creation. If not provided, the creator field is required."},{"format":"email"},{"title":"Default Creator Email","description":"Default email address for the creator field. If provided, the creator field becomes optional for ticket and comment creation. If not provided, the creator field is required."}]},"default_project":{"allOf":[{"type":"string","nullable":true,"description":"Default PagerDuty service ID for ticket creation. If provided, the project field becomes optional in ticket creation requests. If not provided, the project field is required."},{"title":"Default Service/Project ID","description":"Default PagerDuty service ID for ticket creation. If provided, the project field becomes optional in ticket creation requests. If not provided, the project field is required."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the PagerDuty API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.pagerduty.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the PagerDuty API."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_PagerDutyMock":{"id":"components/schemas/Ticketing_PagerDutyMock","kind":"json-schema","title":"ticketing | [MOCK] PagerDuty Operations Cloud","data":{"title":"ticketing | [MOCK] PagerDuty Operations Cloud","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] PagerDuty Operations Cloud."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/pagerduty-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/TicketingPagerdutyDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Ticketing_ServiceNow":{"id":"components/schemas/Ticketing_ServiceNow","kind":"json-schema","title":"ticketing | ServiceNow ITSM","data":{"title":"ticketing | ServiceNow ITSM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for ServiceNow IT Service Management (ITSM)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/servicenow-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ServiceNowCredential"},{"title":"Credential"}]},"custom_field_mappings":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMapping"},"nullable":true,"description":"Custom field mappings for this provider."},{"title":"Custom Field Mappings","description":"Custom field mappings for this provider."}]},"default_issue_type":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Default Issue Type","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"default_project":{"allOf":[{"type":"string","nullable":true,"description":"Default Project for the integration. This maps to the custom table for tickets. This table should be derived from Incident table. Defaults to the incident table if not specified."},{"title":"Default Project","description":"Default Project for the integration. This maps to the custom table for tickets. This table should be derived from Incident table. Defaults to the incident table if not specified."}]},"oauth_scopes":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sn_incident"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"OAuth Scopes","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sn_incident"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","description":"Base URL for the ServiceNow API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.service-now.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the ServiceNow API."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_ServiceNowSIR":{"id":"components/schemas/Ticketing_ServiceNowSIR","kind":"json-schema","title":"ticketing | ServiceNow SIR","data":{"title":"ticketing | ServiceNow SIR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for ServiceNow Security Incident Response (SIR)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/servicenow-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ServiceNowCredential"},{"title":"Credential"}]},"custom_field_mappings":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMapping"},"nullable":true,"description":"Custom field mappings for this provider."},{"title":"Custom Field Mappings","description":"Custom field mappings for this provider."}]},"default_creator":{"allOf":[{"type":"string","nullable":true,"description":"Default Creator (email) for the integration. If provided, the creator field becomes optional in ticket creation requests."},{"title":"Default Creator","description":"Default Creator (email) for the integration. If provided, the creator field becomes optional in ticket creation requests."}]},"default_issue_type":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Default Issue Type","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"default_project":{"allOf":[{"type":"string","nullable":true,"description":"Default Project for the integration. This maps to the custom table for tickets. This table should be derived from Security Incident table. Defaults to the security incident table if not specified."},{"title":"Default Project","description":"Default Project for the integration. This maps to the custom table for tickets. This table should be derived from Security Incident table. Defaults to the security incident table if not specified."}]},"oauth_scopes":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sn_si"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"OAuth Scopes","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sn_si"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","description":"Base URL for the ServiceNow API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.service-now.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the ServiceNow API."}]}},"required":["credential","url"]}},"components/schemas/Ticketing_Torq":{"id":"components/schemas/Ticketing_Torq","kind":"json-schema","title":"ticketing | Torq","data":{"title":"ticketing | Torq","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Torq."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/torq-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TorqCredential"},{"title":"Credential"}]},"custom_field_mappings":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMapping"},"nullable":true,"description":"Custom field mappings for this provider."},{"title":"Custom Field Mappings","description":"Custom field mappings for this provider."}]},"default_creator":{"allOf":[{"type":"string","nullable":true,"description":"Default Creator (email) for the integration. If provided, the creator field becomes optional in ticket creation requests."},{"title":"Default Creator","description":"Default Creator (email) for the integration. If provided, the creator field becomes optional in ticket creation requests."}]},"default_issue_type":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Default Issue Type","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default Issue Type for the integration. If provided, the issue_type field becomes optional in ticket creation requests."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/Ticketing_Xurrent":{"id":"components/schemas/Ticketing_Xurrent","kind":"json-schema","title":"ticketing | Xurrent","data":{"title":"ticketing | Xurrent","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Xurrent."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/xurrent-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"account":{"allOf":[{"type":"string","description":"Xurrent account identifier."},{"title":"Account ID","description":"Xurrent account identifier."}]},"credential":{"allOf":[{"$ref":"#/components/schemas/XurrentCredential"},{"title":"Credential"}]},"region":{"allOf":[{"$ref":"#/components/schemas/XurrentRegion","description":"The Xurrent environment and region to connect to."},{"title":"Region","description":"The Xurrent environment and region to connect to."}]},"service_instance_id":{"allOf":[{"type":"string","nullable":true,"description":"Default Xurrent service instance ID for ticket creation. Required by most Xurrent accounts."},{"title":"Service Instance ID","description":"Default Xurrent service instance ID for ticket creation. Required by most Xurrent accounts."}]}},"required":["account","credential","region"]}},"components/schemas/Ticketing_Zendesk":{"id":"components/schemas/Ticketing_Zendesk","kind":"json-schema","title":"ticketing | Zendesk","data":{"title":"ticketing | Zendesk","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Zendesk as a Ticketing Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/zendesk-ticketing-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ZendeskCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for your Zendesk tenant."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.zendesk.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for your Zendesk tenant."}]}},"required":["credential","url"]}},"components/schemas/TicketingIvantiDataset":{"id":"components/schemas/TicketingIvantiDataset","kind":"json-schema","title":"TicketingIvantiDataset","data":{"title":"TicketingIvantiDataset","type":"string","enum":["basic_v0"]}},"components/schemas/TicketingPagerdutyDataset":{"id":"components/schemas/TicketingPagerdutyDataset","kind":"json-schema","title":"TicketingPagerdutyDataset","data":{"title":"TicketingPagerdutyDataset","type":"string","enum":["basic_v0"]}},"components/schemas/TorqCredential":{"id":"components/schemas/TorqCredential","kind":"json-schema","title":"Torq Credential","data":{"title":"Torq Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"TorqCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"TorqCredential"}}]}},"components/schemas/TrellixApiKeyCredential":{"id":"components/schemas/TrellixApiKeyCredential","kind":"json-schema","title":"Trellix Api Key Credential","data":{"title":"Trellix Api Key Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Tenant-scoped Trellix API key used for ePO API requests."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TrellixApiKeyCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TrellixApiKeyCredential"}}]}},"components/schemas/TrellixCredential":{"id":"components/schemas/TrellixCredential","kind":"json-schema","title":"Trellix Credential","data":{"title":"Trellix Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"client_id":{"title":"Client ID","description":"Client ID from the Trellix IAM Credential Manager."},"client_secret":{"title":"Client Secret","description":"Client secret from the Trellix IAM Credential Manager."}},"description":"Trellix IAM client credentials."}],"required":["type"],"title":"New OAuth Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"TrellixCredential"}},{"description":"Reference to existing OAuth Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing OAuth Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"TrellixCredential"}}]}},"components/schemas/TrellixEnsApiKeyCredential":{"id":"components/schemas/TrellixEnsApiKeyCredential","kind":"json-schema","title":"Trellix Ens Api Key Credential","data":{"title":"Trellix Ens Api Key Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{},"description":"Tenant-scoped Trellix API key used for ePO API requests."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"TrellixEnsApiKeyCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"TrellixEnsApiKeyCredential"}}]}},"components/schemas/TrellixEnsCredential":{"id":"components/schemas/TrellixEnsCredential","kind":"json-schema","title":"Trellix Ens Credential","data":{"title":"Trellix Ens Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"client_id":{"title":"Client ID","description":"Client ID from the Trellix IAM Credential Manager."},"client_secret":{"title":"Client Secret","description":"Client secret from the Trellix IAM Credential Manager."}},"description":"Trellix IAM client credentials."}],"required":["type"],"title":"New OAuth Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"TrellixEnsCredential"}},{"description":"Reference to existing OAuth Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing OAuth Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"TrellixEnsCredential"}}]}},"components/schemas/TrimedxCredential":{"id":"components/schemas/TrimedxCredential","kind":"json-schema","title":"Trimedx Credential","data":{"title":"Trimedx Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"token_url":{"title":"Token URL","description":"This field is ignored and should not be set.","readOnly":true}},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"TrimedxCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"TrimedxCredential"}}]}},"components/schemas/UpwindCredential":{"id":"components/schemas/UpwindCredential","kind":"json-schema","title":"Upwind Credential","data":{"title":"Upwind Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Client ID and Client Secret for Upwind OAuth 2.0."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"UpwindCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"UpwindCredential"}}]}},"components/schemas/UpwindRegion":{"id":"components/schemas/UpwindRegion","kind":"json-schema","title":"UpwindRegion","data":{"title":"UpwindRegion","type":"string","enum":["US","EU","ME"]}},"components/schemas/VeracodeCredential":{"id":"components/schemas/VeracodeCredential","kind":"json-schema","title":"Veracode Credential","data":{"title":"Veracode Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{},"description":"Configuration when creating new Client Credentials."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"VeracodeCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"VeracodeCredential"}}]}},"components/schemas/VeracodeRegion":{"id":"components/schemas/VeracodeRegion","kind":"json-schema","title":"VeracodeRegion","data":{"title":"VeracodeRegion","type":"string","enum":["us","eu"]}},"components/schemas/VirusTotalCredential":{"id":"components/schemas/VirusTotalCredential","kind":"json-schema","title":"VirusTotal Credential","data":{"title":"VirusTotal Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Key","description":"Secret value of the VirusTotal API key."}},"description":"The VirusTotal API key to authenticate lookups with."}],"required":["type"],"title":"New API Key","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"VirusTotalCredential"}},{"description":"Reference to existing API Key.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Key","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"VirusTotalCredential"}}]}},"components/schemas/Vulnerabilities_AmazonInspector":{"id":"components/schemas/Vulnerabilities_AmazonInspector","kind":"json-schema","title":"vulnerabilities | Amazon Inspector","data":{"title":"vulnerabilities | Amazon Inspector","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Amazon Inspector as a vulnerabilities provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/amazon-inspector-vulnerabilities-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AwsProviderCredential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Inspector"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Credential","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS credentials with access to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amazon Inspector"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"region":{"allOf":[{"$ref":"#/components/schemas/AwsRegion","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use when connecting to Amazon Inspector."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AWS region"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to use when connecting to Amazon Inspector."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","region"]}},"components/schemas/Vulnerabilities_Axonius":{"id":"components/schemas/Vulnerabilities_Axonius","kind":"json-schema","title":"vulnerabilities | Axonius","data":{"title":"vulnerabilities | Axonius","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for the Axonius Vulnerabilities Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/axonius-asset-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/AxoniusCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Axonius API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.on.axonius.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Axonius API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_Axonius_Mock":{"id":"components/schemas/Vulnerabilities_Axonius_Mock","kind":"json-schema","title":"vulnerabilities | [MOCK] Axonius","data":{"title":"vulnerabilities | [MOCK] Axonius","type":"object","description":"Configuration for a mocked Axonius as a Vulnerabilities Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/VulnerabilitiesAxoniusDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Vulnerabilities_CrowdStrike":{"id":"components/schemas/Vulnerabilities_CrowdStrike","kind":"json-schema","title":"vulnerabilities | CrowdStrike Falcon® Spotlight","data":{"title":"vulnerabilities | CrowdStrike Falcon® Spotlight","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for CrowdStrike Falcon® Spotlight."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/crowdstrike-vulns-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/CrowdStrikeCredential","description":"The credential to use for the CrowdStrike Falcon tenant."},{"title":"Credential","description":"The credential to use for the CrowdStrike Falcon tenant."}]},"url":{"allOf":[{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the CrowdStrike Falcon® Spotlight API."},"children":[],"type":"text"}],"type":"paragraph"}]},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://api.crowdstrike.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the CrowdStrike Falcon® Spotlight API."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential"]}},"components/schemas/Vulnerabilities_CrowdStrike_Mock":{"id":"components/schemas/Vulnerabilities_CrowdStrike_Mock","kind":"json-schema","title":"vulnerabilities | [Mock] CrowdStrike Falcon® Spotlight","data":{"title":"vulnerabilities | [Mock] CrowdStrike Falcon® Spotlight","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] CrowdStrike Falcon® Spotlight."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/VulnerabilitiesCrowdStrikeDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Vulnerabilities_Defender":{"id":"components/schemas/Vulnerabilities_Defender","kind":"json-schema","title":"vulnerabilities | Microsoft Defender for Endpoint","data":{"title":"vulnerabilities | Microsoft Defender for Endpoint","type":"object","description":"Configuration for Microsoft Defender for Endpoint.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DefenderCredential"},{"title":"Credential"}]},"tenant_id":{"allOf":[{"type":"string","description":"Tenant ID for the Microsoft Defender Management Console."},{"title":"Tenant ID","description":"Tenant ID for the Microsoft Defender Management Console."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Microsoft Defender API."},{"title":"Base URL","description":"Base URL for the Microsoft Defender API."}]}},"required":["credential","tenant_id","url"]}},"components/schemas/Vulnerabilities_DefenderEasm":{"id":"components/schemas/Vulnerabilities_DefenderEasm","kind":"json-schema","title":"vulnerabilities | Microsoft Defender External Attack Surface Management","data":{"title":"vulnerabilities | Microsoft Defender External Attack Surface Management","type":"object","description":"Configuration for Microsoft Defender External Attack Surface Management.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/DefenderEasmCredential"},{"title":"Credential"}]},"region":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Azure region for the EASM workspace (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"eastus"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"westus2"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). This is the region prefix in the EASM API hostname."},"children":[],"type":"text"}],"type":"paragraph"}]},{"example":"eastus"},{"title":"Region","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Azure region for the EASM workspace (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"eastus"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"westus2"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). This is the region prefix in the EASM API hostname."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"resource_group":{"allOf":[{"type":"string","description":"Azure resource group name that contains the EASM workspace."},{"title":"Resource Group","description":"Azure resource group name that contains the EASM workspace."}]},"subscription_id":{"allOf":[{"type":"string","description":"Azure subscription ID that contains the EASM workspace."},{"title":"Subscription ID","description":"Azure subscription ID that contains the EASM workspace."}]},"tenant_id":{"allOf":[{"type":"string","description":"Azure AD tenant ID for the Microsoft Defender EASM service principal."},{"title":"Tenant ID","description":"Azure AD tenant ID for the Microsoft Defender EASM service principal."}]},"workspace_name":{"allOf":[{"type":"string","description":"Name of the Microsoft Defender EASM workspace."},{"title":"Workspace Name","description":"Name of the Microsoft Defender EASM workspace."}]}},"required":["credential","region","resource_group","subscription_id","tenant_id","workspace_name"]}},"components/schemas/Vulnerabilities_Horizon3":{"id":"components/schemas/Vulnerabilities_Horizon3","kind":"json-schema","title":"vulnerabilities | Horizon3 NodeZero","data":{"title":"vulnerabilities | Horizon3 NodeZero","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Horizon3 NodeZero as a Vulnerabilities Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/horizon3-nodezero-vulnerabilities-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/Horizon3Credential","description":"Credentials for the Horizon3 NodeZero GraphQL API."},{"title":"Credential","description":"Credentials for the Horizon3 NodeZero GraphQL API."}]},"region":{"allOf":[{"$ref":"#/components/schemas/Horizon3Region","description":"Region of the Horizon3 Portal."},{"title":"Region","description":"Region of the Horizon3 Portal."}]}},"required":["credential","region"]}},"components/schemas/Vulnerabilities_Iru":{"id":"components/schemas/Vulnerabilities_Iru","kind":"json-schema","title":"vulnerabilities | Iru","data":{"title":"vulnerabilities | Iru","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Iru as a Vulnerabilities Provider"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/iru-vulnerabilities-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/IruCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Iru API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{tenant}.api.kandji.io","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Iru API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_Nucleus":{"id":"components/schemas/Vulnerabilities_Nucleus","kind":"json-schema","title":"vulnerabilities | Nucleus VM","data":{"title":"vulnerabilities | Nucleus VM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Nucleus Vulnerability Management."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/nucleus-vulns-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/NucleusCredential"},{"title":"Credential"}]},"project_id":{"allOf":[{"type":"string","description":"Numeric identifier for a Nucleus project."},{"pattern":"^\\d+$","x-validation-message":{"patternMismatch":"Must be a numeric project identifier."}},{"title":"Project ID","description":"Numeric identifier for a Nucleus project."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Nucleus API."},{"example":"https://{sandbox}.nucleussec.com"},{"title":"Base URL","description":"Base URL for the Nucleus API."}]}},"required":["credential","project_id","url"]}},"components/schemas/Vulnerabilities_Pentera":{"id":"components/schemas/Vulnerabilities_Pentera","kind":"json-schema","title":"vulnerabilities | Pentera","data":{"title":"vulnerabilities | Pentera","type":"object","description":"Configuration for Pentera as a Vulnerabilities Provider","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/PenteraCredential","description":"Credentials for the Pentera API."},{"title":"Credential","description":"Credentials for the Pentera API."}]},"skip_tls_verify":{"allOf":[{"type":"boolean","nullable":true,"description":"When true, skips verification of the Pentera TLS certificate."},{"default":false},{"title":"Skip TLS Verification","description":"When true, skips verification of the Pentera TLS certificate."}]},"url":{"allOf":[{"type":"string","description":"Base URL of the Pentera appliance."},{"example":"https://example.com:8181"},{"title":"Base URL","description":"Base URL of the Pentera appliance."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_QualysCloud":{"id":"components/schemas/Vulnerabilities_QualysCloud","kind":"json-schema","title":"vulnerabilities | Qualys VMDR","data":{"title":"vulnerabilities | Qualys VMDR","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Qualys Vulnerability Management, Detection & Response (VMDR)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/qualys-vulns-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/QualysCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Qualys Cloud API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://qualysguard.qg4.apps.qualys.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Qualys Cloud API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_QualysCloud_Mock":{"id":"components/schemas/Vulnerabilities_QualysCloud_Mock","kind":"json-schema","title":"vulnerabilities | [MOCK] Qualys VMDR","data":{"title":"vulnerabilities | [MOCK] Qualys VMDR","type":"object","description":"Configuration for a mocked Qualys Cloud Platform as a Vulnerabilities Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/VulnerabilitiesQualysCloudDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Vulnerabilities_Rapid7InsightCloud":{"id":"components/schemas/Vulnerabilities_Rapid7InsightCloud","kind":"json-schema","title":"vulnerabilities | Rapid7 InsightVM","data":{"title":"vulnerabilities | Rapid7 InsightVM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Rapid7 InsightVM."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/rapid7-vulns-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/Rapid7InsightCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Rapid7 InsightVM API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://us2.api.insight.rapid7.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Rapid7 InsightVM API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_Rapid7InsightCloud_Mock":{"id":"components/schemas/Vulnerabilities_Rapid7InsightCloud_Mock","kind":"json-schema","title":"vulnerabilities | [MOCK] Rapid7 InsightVM Cloud","data":{"title":"vulnerabilities | [MOCK] Rapid7 InsightVM Cloud","type":"object","description":"Configuration for a mocked Rapid7 Insight Cloud as a Vulnerabilities Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/VulnerabilitiesRapid7InsightCloudDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Vulnerabilities_ServiceNow":{"id":"components/schemas/Vulnerabilities_ServiceNow","kind":"json-schema","title":"vulnerabilities | ServiceNow Vulnerability Response","data":{"title":"vulnerabilities | ServiceNow Vulnerability Response","type":"object","description":"Configuration for ServiceNow Vulnerability Response.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ServiceNowCredential"},{"title":"Credential"}]},"oauth_scopes":{"allOf":[{"type":"array","items":{"type":"string"},"nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sn_vul"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"OAuth Scopes","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional scopes to request when authenticating with OAuth 2.0 client credentials. Leave empty when the ServiceNow Application Registry is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Broadly scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (recommended), which grants access based on the Application User's roles. Only set this when the registry is configured as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Securely scoped"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and a specific Auth Scope (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sn_vul"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is required."},"children":[],"type":"text"}],"type":"paragraph"}]}]},"url":{"allOf":[{"type":"string","description":"Base URL for the ServiceNow API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.service-now.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the ServiceNow API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_ServiceNow_Usem":{"id":"components/schemas/Vulnerabilities_ServiceNow_Usem","kind":"json-schema","title":"vulnerabilities | ServiceNow USEM","data":{"title":"vulnerabilities | ServiceNow USEM","type":"object","description":"Configuration for ServiceNow USEM.","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/ServiceNowCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the ServiceNow API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenant.service-now.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the ServiceNow API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_TaniumCloud":{"id":"components/schemas/Vulnerabilities_TaniumCloud","kind":"json-schema","title":"vulnerabilities | Tanium VM","data":{"title":"vulnerabilities | Tanium VM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tanium Vulnerability Management."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tanium-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TaniumCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Tanium Cloud API"},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://{customername}-api.cloud.tanium.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tanium Cloud API"}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_TaniumCloud_Mock":{"id":"components/schemas/Vulnerabilities_TaniumCloud_Mock","kind":"json-schema","title":"vulnerabilities | [MOCK] Tanium Vulnerability Management","data":{"title":"vulnerabilities | [MOCK] Tanium Vulnerability Management","type":"object","description":"Configuration for a mock Tanium Cloud as a Vulnerabilities Provider","properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/VulnerabilitiesTaniumCloudDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/Vulnerabilities_TenableAsm":{"id":"components/schemas/Vulnerabilities_TenableAsm","kind":"json-schema","title":"vulnerabilities | Tenable ASM","data":{"title":"vulnerabilities | Tenable ASM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tenable Attack Surface Management."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tenableasm-vulnerabilities-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TenableAsmCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Tenable Attack Surface Management API. Leave blank to use the standard Tenable ASM endpoint."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://asm.cloud.tenable.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tenable Attack Surface Management API. Leave blank to use the standard Tenable ASM endpoint."}]}},"required":["credential"]}},"components/schemas/Vulnerabilities_TenableCloud":{"id":"components/schemas/Vulnerabilities_TenableCloud","kind":"json-schema","title":"vulnerabilities | Tenable VM","data":{"title":"vulnerabilities | Tenable VM","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tenable Vulnerability Management."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tenable-vulns-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TenableCloudCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","nullable":true,"description":"Base URL for the Tenable Cloud API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://cloud.tenable.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tenable Cloud API."}]}},"required":["credential"]}},"components/schemas/Vulnerabilities_TenableSc":{"id":"components/schemas/Vulnerabilities_TenableSc","kind":"json-schema","title":"vulnerabilities | Tenable SC","data":{"title":"vulnerabilities | Tenable SC","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for Tenable Security Center."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/tenable-sc-vulns-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/TenableScCredential"},{"title":"Credential"}]},"url":{"allOf":[{"type":"string","description":"Base URL for the Tenable Security Center API."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://tenablesc.example.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the Tenable Security Center API."}]}},"required":["credential","url"]}},"components/schemas/Vulnerabilities_Wiz":{"id":"components/schemas/Vulnerabilities_Wiz","kind":"json-schema","title":"vulnerabilities | Wiz Vulnerabilities","data":{"title":"vulnerabilities | Wiz Vulnerabilities","type":"object","description":"Configuration for the Wiz Vulnerabilities Provider","properties":{"api_endpoint_url":{"allOf":[{"type":"string","description":"Wiz GraphQL API endpoint URL."},{"pattern":"^(https:.+|synqly:.+)$","format":"uri","example":"https://api.us17.app.wiz.io/graphql","x-validation-message":{"patternMismatch":"Must be a valid HTTPS URL."}},{"title":"API Endpoint URL","description":"Wiz GraphQL API endpoint URL.\n"}]},"credential":{"allOf":[{"$ref":"#/components/schemas/WizCredential"},{"title":"Credential"}]}},"required":["api_endpoint_url","credential"]}},"components/schemas/VulnerabilitiesAxoniusDataset":{"id":"components/schemas/VulnerabilitiesAxoniusDataset","kind":"json-schema","title":"VulnerabilitiesAxoniusDataset","data":{"title":"VulnerabilitiesAxoniusDataset","type":"string","enum":["basic_v0"]}},"components/schemas/VulnerabilitiesCrowdStrikeDataset":{"id":"components/schemas/VulnerabilitiesCrowdStrikeDataset","kind":"json-schema","title":"VulnerabilitiesCrowdStrikeDataset","data":{"title":"VulnerabilitiesCrowdStrikeDataset","type":"string","enum":["basic_v0"]}},"components/schemas/VulnerabilitiesQualysCloudDataset":{"id":"components/schemas/VulnerabilitiesQualysCloudDataset","kind":"json-schema","title":"VulnerabilitiesQualysCloudDataset","data":{"title":"VulnerabilitiesQualysCloudDataset","type":"string","enum":["basic_v0"]}},"components/schemas/VulnerabilitiesRapid7InsightCloudDataset":{"id":"components/schemas/VulnerabilitiesRapid7InsightCloudDataset","kind":"json-schema","title":"VulnerabilitiesRapid7InsightCloudDataset","data":{"title":"VulnerabilitiesRapid7InsightCloudDataset","type":"string","enum":["basic_v0","basic_v0_1"]}},"components/schemas/VulnerabilitiesTaniumCloudDataset":{"id":"components/schemas/VulnerabilitiesTaniumCloudDataset","kind":"json-schema","title":"VulnerabilitiesTaniumCloudDataset","data":{"title":"VulnerabilitiesTaniumCloudDataset","type":"string","enum":["basic_v0"]}},"components/schemas/WizCredential":{"id":"components/schemas/WizCredential","kind":"json-schema","title":"Wiz Credential","data":{"title":"Wiz Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"type":"object","properties":{"token_url":{"title":"Token URL","description":"This field is ignored and should not be set.","readOnly":true}},"description":"OAuth 2.0 Client ID and Client Secret for Wiz API access."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"WizCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"WizCredential"}}]}},"components/schemas/WorkdayCredential":{"id":"components/schemas/WorkdayCredential","kind":"json-schema","title":"Workday Credential","data":{"title":"Workday Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["o_auth_client"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/OAuthClientCredential"},{"required":["extra","token_url"],"type":"object","properties":{"extra":{"title":"Extra","required":["refresh_token"],"properties":{"refresh_token":{"title":"Refresh Token","type":"string"}},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Connection specific JSON map, must include the field "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refresh_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"token_url":{"title":"Token URL","pattern":"^(https?:.+|synqly:.+)$","description":"Workday token OAuth token URL.","format":"uri","example":"https://impl-services1.wd12.myworkday.com/ccx/oauth2/acmecorp_dpt1/token","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}}},"description":"OAuth 2.0 Client ID, Client Secret, Refresh Token, and Token URL for Workday API access."}],"required":["type"],"title":"New Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredential","type":"WorkdayCredential"}},{"description":"Reference to existing Client Credentials.","properties":{"type":{"enum":["o_auth_client_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OAuthClientCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"o_auth_client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Client Credentials","type":"object","x-synqly-credential":{"extends":"OAuthClientCredentialId","reference":true,"type":"WorkdayCredential"}}]}},"components/schemas/XurrentCredential":{"id":"components/schemas/XurrentCredential","kind":"json-schema","title":"Xurrent API Credential","data":{"title":"Xurrent API Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["token"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TokenCredential"},{"type":"object","properties":{"secret":{"title":"API Token","description":"The bearer token for authenticating with the Xurrent API."}},"description":"Personal access token or application token for the Xurrent REST API."}],"required":["type"],"title":"New API Token","type":"object","x-synqly-credential":{"extends":"TokenCredential","type":"XurrentCredential"}},{"description":"Reference to existing API Token.","properties":{"type":{"enum":["token_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/TokenCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing API Token","type":"object","x-synqly-credential":{"extends":"TokenCredentialId","reference":true,"type":"XurrentCredential"}}]}},"components/schemas/XurrentRegion":{"id":"components/schemas/XurrentRegion","kind":"json-schema","title":"XurrentRegion","data":{"title":"XurrentRegion","type":"string","enum":["demo","global","us","uk","au","ch","qa"]}},"components/schemas/ZendeskCredential":{"id":"components/schemas/ZendeskCredential","kind":"json-schema","title":"Zendesk Credential","data":{"title":"Zendesk Credential","oneOf":[{"allOf":[{"properties":{"type":{"enum":["basic"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BasicCredential"},{"type":"object","properties":{},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"E-mail address and API Token for use with the Zendesk API. Use the e-mail address for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"username"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field and API Token for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"secret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://developer.zendesk.com/api-reference/introduction/security-and-auth/#api-token"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Zendesk API token generation documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more detail."},"children":[],"type":"text"}],"type":"paragraph"}]}],"required":["type"],"title":"New Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredential","type":"ZendeskCredential"}},{"description":"Reference to existing Basic Credentials.","properties":{"type":{"enum":["basic_id"],"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/BasicCredentialId"},{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique identifier of an existing Credential of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"basic"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", referencing by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not allowed."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["type"],"title":"Existing Basic Credentials","type":"object","x-synqly-credential":{"extends":"BasicCredentialId","reference":true,"type":"ZendeskCredential"}}]}},"components/schemas/amazon_security_lake_custom_log_sources_config":{"id":"components/schemas/amazon_security_lake_custom_log_sources_config","kind":"json-schema","title":"Amazon Security Lake Custom Log Sources Configuration","data":{"title":"Amazon Security Lake Custom Log Sources Configuration","type":"object","description":"Configuration for Amazon Security Lake Custom Log Sources","properties":{"account_id":{"allOf":[{"type":"string","description":"AWS account ID that the custom log sources record as the source of the events."},{"title":"Account ID","description":"AWS account ID that the custom log sources record as the source of the events."}]},"mappings":{"allOf":[{"type":"object","additionalProperties":{"$ref":"#/components/schemas/amazon_security_lake_ocsf_event_classes"},"description":"The OCSF event class each Amazon Security Lake custom log source accepts, keyed by the custom log source name."},{"title":"Mappings","description":"The OCSF event class each Amazon Security Lake custom log source accepts, keyed by the custom log source name."}]}},"required":["account_id","mappings"]}},"components/schemas/amazon_security_lake_ocsf_event_classes":{"id":"components/schemas/amazon_security_lake_ocsf_event_classes","kind":"json-schema","title":"amazon_security_lake_ocsf_event_classes","data":{"title":"amazon_security_lake_ocsf_event_classes","type":"string","enum":["ACCOUNT_CHANGE","ADMIN_GROUP_QUERY","API_ACTIVITY","APPLICATION_LIFECYCLE","AUTHENTICATION","AUTHORIZE_SESSION","COMPLIANCE_FINDING","DATASTORE_ACTIVITY","DATA_SECURITY_FINDING","DETECTION_FINDING","DEVICE_CONFIG_STATE","DEVICE_CONFIG_STATE_CHANGE","DEVICE_INVENTORY_INFO","DHCP_ACTIVITY","DNS_ACTIVITY","EMAIL_ACTIVITY","EMAIL_FILE_ACTIVITY","EMAIL_URL_ACTIVITY","ENTITY_MANAGEMENT","EVENT_LOG_ACTIVITY","FILE_HOSTING_ACTIVITY","FILE_QUERY","FILE_REMEDIATION_ACTIVITY","FILE_SYSTEM_ACTIVITY","FOLDER_QUERY","FTP_ACTIVITY","GROUP_MANAGEMENT","HTTP_ACTIVITY","INCIDENT_FINDING","JOB_QUERY","KERNEL_ACTIVITY","KERNEL_EXTENSION","KERNEL_OBJECT_QUERY","MEMORY_ACTIVITY","MODULE_ACTIVITY","MODULE_QUERY","NETWORKS_QUERY","NETWORK_ACTIVITY","NETWORK_CONNECTION_QUERY","NETWORK_FILE_ACTIVITY","NETWORK_REMEDIATION_ACTIVITY","NTP_ACTIVITY","PATCH_STATE","PERIPHERAL_DEVICE_QUERY","PREFETCH_QUERY","PROCESS_ACTIVITY","PROCESS_QUERY","PROCESS_REMEDIATION_ACTIVITY","RDP_ACTIVITY","REGISTRY_KEY_ACTIVITY","REGISTRY_KEY_QUERY","REGISTRY_VALUE_ACTIVITY","REGISTRY_VALUE_QUERY","REMEDIATION_ACTIVITY","SCAN_ACTIVITY","SCHEDULED_JOB_ACTIVITY","SECURITY_FINDING","SERVICE_QUERY","SMB_ACTIVITY","SOFTWARE_INVENTORY_INFO","SSH_ACTIVITY","TUNNEL_ACTIVITY","USER_ACCESS","USER_INVENTORY","USER_QUERY","USER_SESSION_QUERY","VULNERABILITY_FINDING","WEB_RESOURCES_ACTIVITY","WEB_RESOURCE_ACCESS_ACTIVITY","WINDOWS_RESOURCE_ACTIVITY","WINDOWS_SERVICE_ACTIVITY"]}},"components/schemas/appsec_GitHub":{"id":"components/schemas/appsec_GitHub","kind":"json-schema","title":"appsec | GitHub","data":{"title":"appsec | GitHub","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for GitHub as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/github-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GitHubCredential","description":"Credentials used for accessing the GitHub API."},{"title":"Credential","description":"Credentials used for accessing the GitHub API."}]},"organization_slug":{"allOf":[{"type":"string","description":"GitHub organization slug. This value can be found in the URL of the organization's GitHub page or by converting the organization display name to a slug. For example, if the organization display name is \"My GitHub Organization\" and the URL is \"https://github.com/organizations/my-github-organization\", the slug would be \"my-github-organization\"."},{"title":"Organization Slug","description":"GitHub organization slug. This value can be found in the URL of the organization's GitHub page or by converting the organization display name to a slug. For example, if the organization display name is \"My GitHub Organization\" and the URL is \"https://github.com/organizations/my-github-organization\", the slug would be \"my-github-organization\"."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the GitHub environment. Only necessary with GitHub Enterprise Server deployments."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://github.com","example":"https://your-github-instance.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the GitHub environment. Only necessary with GitHub Enterprise Server deployments."}]}},"required":["credential","organization_slug","url"]}},"components/schemas/appsec_GitLab":{"id":"components/schemas/appsec_GitLab","kind":"json-schema","title":"appsec | GitLab","data":{"title":"appsec | GitLab","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for GitLab as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/gitlab-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/GitLabCredential","description":"Credentials used for accessing the GitLab API."},{"title":"Credential","description":"Credentials used for accessing the GitLab API."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the GitLab API. This URL should be the same as the URL used to access your GitLab instance."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","default":"https://gitlab.com","example":"https://your-gitlab-instance.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the GitLab API. This URL should be the same as the URL used to access your GitLab instance."}]}},"required":["credential","url"]}},"components/schemas/appsec_HCLAppScanOnCloud":{"id":"components/schemas/appsec_HCLAppScanOnCloud","kind":"json-schema","title":"appsec | HCL AppScan on Cloud","data":{"title":"appsec | HCL AppScan on Cloud","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for HCL AppScan on Cloud as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/hcl-appscan-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/HCLAppScanOnCloudCredential","description":"Credentials used for accessing the HCL AppScan on Cloud API."},{"title":"Credential","description":"Credentials used for accessing the HCL AppScan on Cloud API."}]},"url":{"allOf":[{"$ref":"#/components/schemas/HCLAppScanOnCloudUrl","description":"Base URL for the HCL AppScan on Cloud API. This URL should be the same as the URL used to access the HCL AppScan on Cloud web interface."},{"title":"Base URL","description":"Base URL for the HCL AppScan on Cloud API. This URL should be the same as the URL used to access the HCL AppScan on Cloud web interface."}]}},"required":["credential","url"]}},"components/schemas/appsec_OpenTextApplicationSecurity":{"id":"components/schemas/appsec_OpenTextApplicationSecurity","kind":"json-schema","title":"appsec | OpenText Application Security (On-Premise)","data":{"title":"appsec | OpenText Application Security (On-Premise)","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for OpenText Application Security (formerly Fortify Software Security Center) as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This provider is for on-premise installations of OpenText Application Security. For the SaaS product, please use the OpenText Core Application Security provider."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As this provider is for an on-premise only product, either a Synqly Bridge Agent must be used or the OpenText Application Security installation must be accessible from a public URL."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/opentext-applicationsecurity-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/OpenTextApplicationSecurityCredential","description":"Credentials used for accessing the OpenText Application Security API."},{"title":"Credential","description":"Credentials used for accessing the OpenText Application Security API."}]},"url":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the OpenText Application Security API. This URL should"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"be the same as the URL used to access the OpenText Application"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Security web interface."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If a Synqly Bridge Agent is not used, this URL must be a publically accessible"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more information on using a Synqly Bridge Agent, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/bridge/agent-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Bridge Agent documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"title":"Base URL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL for the OpenText Application Security API. This URL should"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"be the same as the URL used to access the OpenText Application"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Security web interface."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If a Synqly Bridge Agent is not used, this URL must be a publically accessible"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more information on using a Synqly Bridge Agent, see the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/bridge/agent-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synqly Bridge Agent documentation"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}},"required":["credential","url"]}},"components/schemas/appsec_OpenTextCoreApplicationSecurity":{"id":"components/schemas/appsec_OpenTextCoreApplicationSecurity","kind":"json-schema","title":"appsec | OpenText Core Application Security","data":{"title":"appsec | OpenText Core Application Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for OpenText Core Application Security (formerly Fortify On Demand) as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/opentext-core-applicationsecurity-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/OpenTextCoreApplicationSecurityCredential","description":"Credentials used for accessing the OpenText Core Application Security API."},{"title":"Credential","description":"Credentials used for accessing the OpenText Core Application Security API."}]},"url":{"allOf":[{"$ref":"#/components/schemas/OpenTextCoreApplicationSecurityUrl","description":"Base URL for the OpenText Core Application Security API. This URL should be the same as the URL used to access the OpenText Core Application Security web interface."},{"title":"Base URL","description":"Base URL for the OpenText Core Application Security API. This URL should be the same as the URL used to access the OpenText Core Application Security web interface."}]}},"required":["credential","url"]}},"components/schemas/appsec_OpenTextCoreApplicationSecurityMock":{"id":"components/schemas/appsec_OpenTextCoreApplicationSecurityMock","kind":"json-schema","title":"appsec | [MOCK] OpenText Core Application Security","data":{"title":"appsec | [MOCK] OpenText Core Application Security","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for [MOCK] OpenText Core Application Security."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/opentext-core-applicationsecurity-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AppsecOpentextCoreApplicationSecurityDataset"},{"title":"Dataset"}]}},"required":["dataset"]}},"components/schemas/appsec_SonarQubeServer":{"id":"components/schemas/appsec_SonarQubeServer","kind":"json-schema","title":"appsec | SonarQube Server","data":{"title":"appsec | SonarQube Server","type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration for SonarQube Server as an application security provider."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.synqly.com/guides/provider-configuration/sonarqube-appsec-setup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuration guide"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/SonarQubeCredential","description":"Credentials used for accessing the SonarQube API."},{"title":"Credential","description":"Credentials used for accessing the SonarQube API."}]},"url":{"allOf":[{"type":"string","description":"Base URL for the SonarQube Server instance."},{"pattern":"^(https?:.+|synqly:.+)$","format":"uri","example":"https://sonarqube.example.com","x-validation-message":{"patternMismatch":"Must be a valid HTTP(S) URL."}},{"title":"Base URL","description":"Base URL for the SonarQube Server instance."}]}},"required":["credential","url"]}},"components/schemas/RoleId":{"id":"components/schemas/RoleId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/RoleName":{"id":"components/schemas/RoleName","kind":"json-schema","title":"RoleName","data":{"title":"RoleName","type":"string","description":"Unique identifier for this Role"}},"components/schemas/AdhocRole":{"id":"components/schemas/AdhocRole","kind":"json-schema","title":"AdhocRole","data":{"title":"AdhocRole","type":"object","properties":{"resources":{"$ref":"#/components/schemas/Resources"},"permission_set":{"$ref":"#/components/schemas/Permissions"}},"required":["resources","permission_set"]}},"components/schemas/RoleAccounts":{"id":"components/schemas/RoleAccounts","kind":"json-schema","title":"RoleAccounts","data":{"title":"RoleAccounts","type":"object","properties":{"ids":{"type":"array","items":{"$ref":"#/components/schemas/AccountId"},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List of account ids that this role definition grants access to. Use \"*\" to grant access to all account ids."},"children":[],"type":"text"}],"type":"paragraph"}]},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of account labels this role definition grants access to. If both labels and environments are specified both must pass"},"environments":{"type":"array","items":{"$ref":"#/components/schemas/Environment"},"nullable":true,"description":"Account environments this role definition grants access to. If both labels and environments are specified both must pass"}},"required":["ids"]}},"components/schemas/RoleIntegrations":{"id":"components/schemas/RoleIntegrations","kind":"json-schema","title":"RoleIntegrations","data":{"title":"RoleIntegrations","type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryId"},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List of categories ids that this role definition grants access to. Use \"*\" to grant access to all category ids."},"children":[],"type":"text"}],"type":"paragraph"}]}},"required":["categories"]}},"components/schemas/RoleOrganizations":{"id":"components/schemas/RoleOrganizations","kind":"json-schema","title":"RoleOrganizations","data":{"title":"RoleOrganizations","type":"object","properties":{"ids":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationId"},"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List of organization ids that this role definition grants access to. Use \"*\" to grant access to all organization ids."},"children":[],"type":"text"}],"type":"paragraph"}]},"labels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of organization labels this role definition grants access to."}},"required":["ids"]}},"components/schemas/Resources":{"id":"components/schemas/Resources","kind":"json-schema","title":"Resources","data":{"title":"Resources","type":"object","properties":{"organizations":{"$ref":"#/components/schemas/RoleOrganizations","nullable":true},"accounts":{"$ref":"#/components/schemas/RoleAccounts","nullable":true},"integrations":{"$ref":"#/components/schemas/RoleIntegrations","nullable":true}}}},"components/schemas/RoleDefinition":{"id":"components/schemas/RoleDefinition","kind":"json-schema","title":"RoleDefinition","data":{"title":"RoleDefinition","type":"object","properties":{"id":{"$ref":"#/components/schemas/RoleId"},"fullname":{"type":"string","description":"Full name of role"},"description":{"type":"string","nullable":true,"description":"Description of the resources included in the role and permissions granted on those resources. Includes details of when to use this role along with the intended personas."},"resources":{"$ref":"#/components/schemas/Resources","nullable":true,"description":"Selects the resources the permission set applies to."},"permission_set":{"$ref":"#/components/schemas/Permissions","description":"Permission set for this role."}},"required":["id","fullname","permission_set"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/ListRolesResponse":{"id":"components/schemas/ListRolesResponse","kind":"json-schema","title":"ListRolesResponse","data":{"title":"ListRolesResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RoleDefinition"}}},"required":["result"]}},"components/schemas/GetRoleResponse":{"id":"components/schemas/GetRoleResponse","kind":"json-schema","title":"GetRoleResponse","data":{"title":"GetRoleResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RoleDefinition"}},"required":["result"]}},"components/schemas/CreateRoleRequest":{"id":"components/schemas/CreateRoleRequest","kind":"json-schema","title":"CreateRoleRequest","data":{"title":"CreateRoleRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this Role (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to RoleId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Role, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"description":{"type":"string","nullable":true,"description":"Description of the resources included in the role and permissions granted on those resources. Includes details of when to use this role along with the intended personas."},"resources":{"$ref":"#/components/schemas/Resources","nullable":true,"description":"Selects the resources the permission set applies to."},"permission_set":{"$ref":"#/components/schemas/Permissions","description":"Permission set for this role."}},"required":["permission_set"]}},"components/schemas/CreateRoleResponse":{"id":"components/schemas/CreateRoleResponse","kind":"json-schema","title":"CreateRoleResponse","data":{"title":"CreateRoleResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RoleDefinition"}},"required":["result"]}},"components/schemas/UpdateRoleRequest":{"id":"components/schemas/UpdateRoleRequest","kind":"json-schema","title":"RoleDefinition","data":{"title":"RoleDefinition","type":"object","properties":{"id":{"$ref":"#/components/schemas/RoleId"},"fullname":{"type":"string","description":"Full name of role"},"description":{"type":"string","nullable":true,"description":"Description of the resources included in the role and permissions granted on those resources. Includes details of when to use this role along with the intended personas."},"resources":{"$ref":"#/components/schemas/Resources","nullable":true,"description":"Selects the resources the permission set applies to."},"permission_set":{"$ref":"#/components/schemas/Permissions","description":"Permission set for this role."}},"required":["id","fullname","permission_set"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/UpdateRoleResponse":{"id":"components/schemas/UpdateRoleResponse","kind":"json-schema","title":"UpdateRoleResponse","data":{"title":"UpdateRoleResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RoleDefinition"}},"required":["result"]}},"components/schemas/PatchRoleResponse":{"id":"components/schemas/PatchRoleResponse","kind":"json-schema","title":"PatchRoleResponse","data":{"title":"PatchRoleResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RoleDefinition"}},"required":["result"]}},"components/schemas/ListStatusOptions":{"id":"components/schemas/ListStatusOptions","kind":"json-schema","title":"ListStatusOptions","data":{"title":"ListStatusOptions","type":"string","enum":["account","accounts","integration","integrations","all"]}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"title":"Status","type":"object","description":"Status object","properties":{"created_at":{"type":"string","format":"date-time","description":"Time object was originally created"},"updated_at":{"type":"string","format":"date-time","description":"Last time object was updated"},"account_id":{"$ref":"#/components/schemas/AccountId","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Account associated with this status. Use the expand=accounts parameter with the List API to expand the Account to the full object"},"children":[],"type":"text"}],"type":"paragraph"}]},"account":{"$ref":"#/components/schemas/Account","nullable":true,"description":"When using the expand option on the List API, the full account object is included in the response"},"integration_id":{"$ref":"#/components/schemas/IntegrationId","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integration associated with this status. Use the expand=integrations parameter with the List API to expand the Integration to the full object"},"children":[],"type":"text"}],"type":"paragraph"}]},"integration":{"$ref":"#/components/schemas/Integration","nullable":true,"description":"When using the expand option on the List API, the full integration object is included in the response"},"status":{"type":"string","description":"The current status of the notification."},"requests":{"type":"integer","format":"int64","description":"Request count"},"failed":{"type":"integer","format":"int64","description":"Failed count"},"cpu_time":{"type":"integer","format":"int64","description":"Cpu time in microseconds"},"db_ops":{"type":"integer","format":"int64","description":"Database operations count"},"api_ops":{"type":"integer","format":"int64","description":"API operations count"},"in_bytes":{"type":"integer","format":"int64","description":"API input byte count"},"out_bytes":{"type":"integer","format":"int64","description":"API output byte count"}},"required":["created_at","updated_at","account_id","integration_id","status","requests","failed","cpu_time","db_ops","api_ops","in_bytes","out_bytes"]}},"components/schemas/ListStatusResponse":{"id":"components/schemas/ListStatusResponse","kind":"json-schema","title":"ListStatusResponse","data":{"title":"ListStatusResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Status"}}},"required":["result"]}},"components/schemas/GetStatusResponse":{"id":"components/schemas/GetStatusResponse","kind":"json-schema","title":"GetStatusResponse","data":{"title":"GetStatusResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Status"}},"required":["result"]}},"components/schemas/StatusEvent":{"id":"components/schemas/StatusEvent","kind":"json-schema","title":"StatusEvent","data":{"title":"StatusEvent","type":"object","description":"Status event object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId","description":"Account owner"},"integration_id":{"$ref":"#/components/schemas/IntegrationId","description":"Integration object"},"created_at":{"type":"string","format":"date-time","description":"Time created"},"status":{"type":"string","description":"The current status of the notification."},"error":{"type":"string","nullable":true,"description":"Error message"},"request":{"type":"integer","format":"int64","description":"Request number"}},"required":["account_id","integration_id","created_at","status","request"]}},"components/schemas/ListStatusEventsResponse":{"id":"components/schemas/ListStatusEventsResponse","kind":"json-schema","title":"ListStatusEventsResponse","data":{"title":"ListStatusEventsResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/StatusEvent"}}},"required":["result"]}},"components/schemas/TimeseriesResult":{"id":"components/schemas/TimeseriesResult","kind":"json-schema","title":"TimeseriesResult","data":{"title":"TimeseriesResult","type":"object","description":"Status timeseries object","properties":{"created_at":{"type":"string","format":"date-time","description":"Interval time"},"succeeded":{"type":"integer","format":"int64","description":"Succeeded count"},"failed":{"type":"integer","format":"int64","description":"Failed count"},"cpu_time":{"type":"integer","format":"int64","description":"Cpu time in microseconds"},"in_bytes":{"type":"integer","format":"int64","description":"API input byte count"},"out_bytes":{"type":"integer","format":"int64","description":"API output byte count"}},"required":["created_at","succeeded","failed","cpu_time","in_bytes","out_bytes"]}},"components/schemas/GetStatusTimeseriesResult":{"id":"components/schemas/GetStatusTimeseriesResult","kind":"json-schema","title":"GetStatusTimeseriesResult","data":{"title":"GetStatusTimeseriesResult","type":"object","description":"Status timeseries object","properties":{"start_time":{"type":"string","format":"date-time","description":"start time"},"end_time":{"type":"string","format":"date-time","description":"end time"},"interval":{"type":"string","description":"interval duration"},"series":{"type":"array","items":{"$ref":"#/components/schemas/TimeseriesResult"}}},"required":["start_time","end_time","interval","series"]}},"components/schemas/GetStatusTimeseries":{"id":"components/schemas/GetStatusTimeseries","kind":"json-schema","title":"GetStatusTimeseries","data":{"title":"GetStatusTimeseries","type":"object","description":"Get status last hour timeseries","properties":{"result":{"$ref":"#/components/schemas/GetStatusTimeseriesResult"}},"required":["result"]}},"components/schemas/GetIntegrationTimeseriesResult":{"id":"components/schemas/GetIntegrationTimeseriesResult","kind":"json-schema","title":"GetStatusTimeseriesResult","data":{"title":"GetStatusTimeseriesResult","type":"object","description":"Status timeseries object","properties":{"start_time":{"type":"string","format":"date-time","description":"start time"},"end_time":{"type":"string","format":"date-time","description":"end time"},"interval":{"type":"string","description":"interval duration"},"series":{"type":"array","items":{"$ref":"#/components/schemas/TimeseriesResult"}}},"required":["start_time","end_time","interval","series"]}},"components/schemas/GetIntegrationTimeseries":{"id":"components/schemas/GetIntegrationTimeseries","kind":"json-schema","title":"GetIntegrationTimeseries","data":{"title":"GetIntegrationTimeseries","type":"object","description":"Get integration timeseries","properties":{"result":{"$ref":"#/components/schemas/GetIntegrationTimeseriesResult"}},"required":["result"]}},"components/schemas/TokenId":{"id":"components/schemas/TokenId","kind":"json-schema","title":"Id","data":{"title":"Id","type":"string"}},"components/schemas/TokenPair":{"id":"components/schemas/TokenPair","kind":"json-schema","title":"TokenPair","data":{"title":"TokenPair","type":"object","properties":{"access":{"$ref":"#/components/schemas/Token","description":"Access token contains the bearer secret"},"refresh":{"$ref":"#/components/schemas/Token","description":"Refresh token used for RefreshToken API"}},"required":["access","refresh"]}},"components/schemas/Token":{"id":"components/schemas/Token","kind":"json-schema","title":"Token","data":{"title":"Token","type":"object","properties":{"secret":{"type":"string","description":"Secret value for the token; used for authentication when making requests."},"expires":{"type":"string","format":"date-time","description":"Time when this token expires and can no longer be used again."},"permissions":{"$ref":"#/components/schemas/Permission","description":"Permissions granted to this token."},"claims":{"type":"object","additionalProperties":true,"nullable":true,"description":"Additional claims added to the token."}},"required":["secret","expires","permissions"]}},"components/schemas/TokenOwnerType":{"id":"components/schemas/TokenOwnerType","kind":"json-schema","title":"TokenOwnerType","data":{"title":"TokenOwnerType","type":"string","enum":["organization","integration"]}},"components/schemas/TokenType":{"id":"components/schemas/TokenType","kind":"json-schema","title":"TokenType","data":{"title":"TokenType","type":"string","enum":["adhoc","logon","default"]}},"components/schemas/RefreshToken":{"id":"components/schemas/RefreshToken","kind":"json-schema","title":"RefreshToken","data":{"title":"RefreshToken","type":"object","properties":{"id":{"$ref":"#/components/schemas/TokenId"},"fullname":{"type":"string","description":"Human friendly display name for this account."},"member_id":{"$ref":"#/components/schemas/Id","nullable":true,"description":"Member Id"},"owner_id":{"$ref":"#/components/schemas/Id","description":"ID of the entity that owns this token"},"owner_type":{"$ref":"#/components/schemas/TokenOwnerType","description":"Type of the entity that owns this token"},"expires":{"type":"string","format":"date-time","description":"Time when this token expires and can no longer be used again."},"token_ttl":{"type":"string","description":"Token time-to-live"},"token_type":{"$ref":"#/components/schemas/TokenType","description":"Type of token created"},"primary":{"$ref":"#/components/schemas/TokenPair","description":"Primary running access and refresh tokens"},"secondary":{"$ref":"#/components/schemas/TokenPair","nullable":true,"description":"Temporary secondary TokenPair created after a RefreshToken operation"}},"required":["id","fullname","owner_id","owner_type","expires","token_ttl","token_type","primary"],"allOf":[{"$ref":"#/components/schemas/Base"}]}},"components/schemas/CreateTokenRequest":{"id":"components/schemas/CreateTokenRequest","kind":"json-schema","title":"CreateTokenRequest","data":{"title":"CreateTokenRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique short name for this token (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to TokenId if both name and fullname are not specified."},"children":[],"type":"text"}],"type":"paragraph"}]},"fullname":{"type":"string","nullable":true,"description":"Human friendly display name for this Token, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified."},"resources":{"$ref":"#/components/schemas/Resources","description":"Limit access to supplied resources"},"permission_set":{"$ref":"#/components/schemas/Permissions","description":"Limit access to supplied permissions"},"token_ttl":{"type":"string","nullable":true,"description":"Token time-to-live. If not provided, defaults to 24 hours. Use the format \"1h\", \"1m\", \"1s\" for hours, minutes, and seconds respectively, e.g., \"24h\" for 24 hours."}},"required":["resources","permission_set"]}},"components/schemas/CreateTokenResponse":{"id":"components/schemas/CreateTokenResponse","kind":"json-schema","title":"CreateTokenResponse","data":{"title":"CreateTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RefreshToken"}},"required":["result"]}},"components/schemas/CreateIntegrationTokenRequest":{"id":"components/schemas/CreateIntegrationTokenRequest","kind":"json-schema","title":"CreateIntegrationTokenRequest","data":{"title":"CreateIntegrationTokenRequest","type":"object","properties":{"name":{"type":"string","nullable":true,"description":"Unique name token. If not provided, defaults to generated newly created refresh token id."},"token_ttl":{"type":"string","nullable":true,"description":"Token time-to-live. If not provided, defaults to 10 minutes. Use the format \"1h\", \"1m\", \"1s\" for hours, minutes, and seconds respectively, e.g., \"2h\" for 2 hours."}}}},"components/schemas/CreateMCPTokenRequest":{"id":"components/schemas/CreateMCPTokenRequest","kind":"json-schema","title":"CreateMCPTokenRequest","data":{"title":"CreateMCPTokenRequest","type":"object","properties":{"token_ttl":{"type":"string","nullable":true,"description":"Token time-to-live. If not provided, defaults to 1 hour. May be set to a maximum of 24 hours. Use the format \"1h\", \"1m\", \"1s\" for hours, minutes, and seconds respectively, e.g., \"2h\" for 2 hours."},"scope":{"$ref":"#/components/schemas/MCPTokenScope","description":"Controls the tools that are available to the MCP server,\nand the APIs that can be accessed by the MCP server."}},"required":["scope"]}},"components/schemas/MCPTokenScope":{"id":"components/schemas/MCPTokenScope","kind":"json-schema","title":"MCPTokenScope","data":{"title":"MCPTokenScope","oneOf":[{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["management"]}}},{"$ref":"#/components/schemas/MCPManagementScopeOptions"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["integration-usage"]}}},{"$ref":"#/components/schemas/MCPIntegrationUsageScopeOptions"}],"required":["type"]},{"type":"object","allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["developer"]}}},{"$ref":"#/components/schemas/MCPDeveloperUsageScopeOptions"}],"required":["type"]}]}},"components/schemas/MCPManagementScopeOptions":{"id":"components/schemas/MCPManagementScopeOptions","kind":"json-schema","title":"MCPManagementScopeOptions","data":{"title":"MCPManagementScopeOptions","type":"object","properties":{"environment":{"$ref":"#/components/schemas/Environment","nullable":true,"description":"Optionally restrict access to a specific environment."},"account_id":{"$ref":"#/components/schemas/AccountId","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optionally restrict access to a specific account. This is recommended for production use cases. If provided, this overrides any "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"environment"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" restriction."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/MCPIntegrationUsageScopeOptions":{"id":"components/schemas/MCPIntegrationUsageScopeOptions","kind":"json-schema","title":"MCPIntegrationUsageScopeOptions","data":{"title":"MCPIntegrationUsageScopeOptions","type":"object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Restrict integration usage to this account. By default, the MCP server"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"will have access to all integrations within this account; this may be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"restricted to a specific set of tools using the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"restrict_to_connector_operations"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" property."},"children":[],"type":"text"}],"type":"paragraph"}]},"restrict_to_connector_operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationId"},"nullable":true,"description":"Optionally restrict access to the tools associated with the specified\nconnector operations. If not specified, the MCP server will advertise\nall tools for this scope."}},"required":["account_id"]}},"components/schemas/MCPDeveloperUsageScopeOptions":{"id":"components/schemas/MCPDeveloperUsageScopeOptions","kind":"json-schema","title":"MCPDeveloperUsageScopeOptions","data":{"title":"MCPDeveloperUsageScopeOptions","type":"object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId","description":"Restrict integration creation and usage to this account. The MCP\nwill be given account-owner permissions for this account."}},"required":["account_id"]}},"components/schemas/CreateMCPTokenResponse":{"id":"components/schemas/CreateMCPTokenResponse","kind":"json-schema","title":"CreateMCPTokenResponse","data":{"title":"CreateMCPTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Token"}},"required":["result"]}},"components/schemas/CreateIntegrationTokenResponse":{"id":"components/schemas/CreateIntegrationTokenResponse","kind":"json-schema","title":"CreateIntegrationTokenResponse","data":{"title":"CreateIntegrationTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/Token"}},"required":["result"]}},"components/schemas/CreateSynqlyIntegrationsTokenRequest":{"id":"components/schemas/CreateSynqlyIntegrationsTokenRequest","kind":"json-schema","title":"CreateSynqlyIntegrationsTokenRequest","data":{"title":"CreateSynqlyIntegrationsTokenRequest","type":"object","properties":{"token_ttl":{"type":"string","nullable":true,"description":"Token time-to-live. If not provided, defaults to 24 hours. Use the format \"1h\", \"1m\", \"1s\" for hours, minutes, and seconds respectively, e.g., \"24h\" for 24 hours."}}}},"components/schemas/CreateSynqlyIntegrationsTokenResponse":{"id":"components/schemas/CreateSynqlyIntegrationsTokenResponse","kind":"json-schema","title":"CreateSynqlyIntegrationsTokenResponse","data":{"title":"CreateSynqlyIntegrationsTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/SynqlyIntegrationsTokenResponse"}},"required":["result"]}},"components/schemas/SynqlyIntegrationsTokenResponse":{"id":"components/schemas/SynqlyIntegrationsTokenResponse","kind":"json-schema","title":"SynqlyIntegrationsTokenResponse","data":{"title":"SynqlyIntegrationsTokenResponse","type":"object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId"},"token":{"$ref":"#/components/schemas/RefreshToken"}},"required":["account_id","token"]}},"components/schemas/ListTokensResponse":{"id":"components/schemas/ListTokensResponse","kind":"json-schema","title":"ListTokensResponse","data":{"title":"ListTokensResponse","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RefreshToken"}}},"required":["result"]}},"components/schemas/GetTokenResponse":{"id":"components/schemas/GetTokenResponse","kind":"json-schema","title":"GetTokenResponse","data":{"title":"GetTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RefreshToken"}},"required":["result"]}},"components/schemas/ResetTokenResponse":{"id":"components/schemas/ResetTokenResponse","kind":"json-schema","title":"ResetTokenResponse","data":{"title":"ResetTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RefreshToken"}},"required":["result"]}},"components/schemas/RotateTokenResponse":{"id":"components/schemas/RotateTokenResponse","kind":"json-schema","title":"RotateTokenResponse","data":{"title":"RotateTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RefreshToken"}},"required":["result"]}},"components/schemas/RefreshTokenResponse":{"id":"components/schemas/RefreshTokenResponse","kind":"json-schema","title":"RefreshTokenResponse","data":{"title":"RefreshTokenResponse","type":"object","properties":{"result":{"$ref":"#/components/schemas/RefreshToken"}},"required":["result"]}},"schema_0":{"kind":"json-schema","data":{"type":"integer","nullable":true},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","nullable":true},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","nullable":true}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"boolean","nullable":true},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AccountId"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"title":"AccountId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Account"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"title":"UpdateAccountRequest","$ref":"#/components/schemas/Account"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"$ref":"#/components/schemas/OrganizationId"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"title":"OrganizationId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Organization"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuthConfigurationId"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"title":"AuthConfigurationId","$ref":"#/components/schemas/Id","description":"Unique identifier for this authentication configuration"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BridgeGroupId"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"title":"BridgeGroupId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Bridge Group."},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"title":"UpdateBridgeRequest","$ref":"#/components/schemas/BridgeGroup"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ListConnectorCapabilitiesExpandOptions","nullable":true}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ListProviderCapabilitiesExpandOptions","nullable":true}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ProviderConfigId"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GetProviderCapabilitiesExpandOptions","nullable":true}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Id"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CredentialId"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"title":"UpdateCredentialRequest","$ref":"#/components/schemas/Credential"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"$ref":"#/components/schemas/IntegrationPointId"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"title":"IntegrationPointId","$ref":"#/components/schemas/Id","description":"Unique identifier for this IntegrationPoint"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"title":"UpdateIntegrationPointRequest","$ref":"#/components/schemas/IntegrationPoint"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ListIntegrationOptions","nullable":true}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"$ref":"#/components/schemas/IntegrationId"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"title":"IntegrationId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Integration"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"title":"UpdateIntegrationRequest","$ref":"#/components/schemas/Integration"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/MappingId"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"title":"MappingId","$ref":"#/components/schemas/Id","description":"Unique identifier for this organization mapping"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"title":"UpdateMappingRequest","$ref":"#/components/schemas/Mapping"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"$ref":"#/components/schemas/MemberId"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"title":"MemberId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Member"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"title":"UpdateMemberRequest","$ref":"#/components/schemas/Member"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"$ref":"#/components/schemas/OAuthAppId","nullable":true},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WebhookId"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"title":"WebhookId","$ref":"#/components/schemas/Id","description":"Unique identifier for a Webhook"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"title":"UpdateOrganizationWebhookRequest","$ref":"#/components/schemas/OrganizationWebhook"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"title":"UpdateOrganizationRequest","$ref":"#/components/schemas/Organization"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Permissions"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RoleId"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"title":"RoleId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Role"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"title":"UpdateRoleRequest","$ref":"#/components/schemas/RoleDefinition"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ListStatusOptions","nullable":true}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TokenId"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"title":"TokenId","$ref":"#/components/schemas/Id","description":"Unique identifier for this Token"},"id":"schema_46"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer"}},"specVersion":"3.0.1","servers":[{"url":"https://api.synqly.com","description":"Synqly"}],"specType":"openapi"},"options":{"sanitize":true,"sortRequiredPropsFirst":true,"hideDownloadButtons":false,"hideReplay":false,"onlyRequiredInSamples":true,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl"}]},"hideOneOfDescription":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api-reference/management.json?download"},{"url":"/_bundle/api-reference/management.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Management API","description":"The Synqly Management APIs enable you to manage the resources within your Synqly organization, such as setting up Accounts for your customers and creating Integrations to connect your product to the different service Providers supported by Synqly.\n\nFor more information see the [Synqly Overview](/guides/getting-started/overview).\n"}},"baseSlug":"/api-reference/management","routesMapping":{}}