{"items":[{"type":"link","fsPath":"api-reference/authored/getting-started/intro.md","metadata":{"type":"markdown"},"label":"Overview","link":"/api-reference/overview","routeSlug":"/api-reference/overview"},{"type":"link","fsPath":"api-reference/authored/getting-started/api-meta-functions.md","metadata":{"type":"markdown"},"label":"Meta Functions","link":"/api-reference/meta-functions","routeSlug":"/api-reference/meta-functions"},{"type":"link","fsPath":"api-reference/authored/getting-started/api-customer-defined-mappings.md","metadata":{"type":"markdown"},"label":"Customer Defined Mappings","link":"/api-reference/customer-defined-mappings","routeSlug":"/api-reference/customer-defined-mappings"},{"type":"link","fsPath":"api-reference/authored/getting-started/api-adaptive-mapping.md","metadata":{"type":"markdown"},"label":"Adaptive Mapping","link":"/api-reference/adaptive-mapping","routeSlug":"/api-reference/adaptive-mapping"},{"type":"group","label":"Management API","items":[{"type":"link","label":"Overview","link":"/api-reference/management","routeSlug":"/api-reference/management"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v1/accounts/{accountId}"}]},{"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."}},"httpPath":"/v1/audit/organizations"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v1/auth/meta"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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}."}},"httpPath":"/v1/bridges/{accountId}/{bridgeId}/status"}]},{"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."}},"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."}},"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"}},"httpPath":"/v1/capabilities/providers/{providerId}"}]},{"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}."}},"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."}},"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}."}},"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."}},"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}."}},"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}."}},"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}."}},"httpPath":"/v1/credentials/lookup/{credentialId}"}]},{"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."}},"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."}},"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}."}},"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}."}},"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}."}},"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}."}},"httpPath":"/v1/integration-points/{integrationPointId}"}]},{"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."}},"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}."}},"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."}},"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}."}},"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}."}},"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}."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v1/integrations/{accountId}/{integrationId}/authorize"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/mappings/apply"}]},{"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"}},"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."}},"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"}},"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"}},"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"}},"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."}},"httpPath":"/v1/members/{memberId}"}]},{"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"}},"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"}},"httpPath":"/v1/meta/openapi/engine"}]},{"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."}},"httpPath":"/v1/oauth-apps/installs/{accountId}"}]},{"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."}},"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."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/jobs/history"}]},{"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"}},"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"}},"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}."}},"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."}},"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."}},"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"}},"httpPath":"/v1/organization/webhooks/{webhookId}"}]},{"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"}},"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"}},"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"}},"httpPath":"/v1/organization"}]},{"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."}},"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."}},"httpPath":"/v1/permissionsets/{permissionsetId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v1/roles/{roleId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v1/status/{accountId}/{integrationId}/timeseries"}]},{"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"}},"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."}},"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"}},"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"}},"httpPath":"/v1/suborgs/{organizationId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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}."}},"httpPath":"/v1/tokens/{refreshTokenId}/secondary"}]}]},{"type":"group","label":"Connector API","items":[{"type":"link","label":"Overview","link":"/api-reference/connectors","routeSlug":"/api-reference/connectors"},{"type":"group","label":"Application Security (Pre-Release)","link":"/api-reference/connectors/appsec","routeSlug":"/api-reference/connectors/appsec","items":[{"label":"Query Applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/appsec/appsec_query_applications","routeSlug":"/api-reference/connectors/appsec/appsec_query_applications","metadata":{"seo":{"title":"Query Applications","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/app-sec/applications"},{"label":"Query Application Findings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/appsec/appsec_query_application_findings","routeSlug":"/api-reference/connectors/appsec/appsec_query_application_findings","metadata":{"seo":{"title":"Query Application Findings","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/app-sec/applications/{applicationId}/findings"},{"label":"Query findings across all applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/appsec/appsec_query_findings","routeSlug":"/api-reference/connectors/appsec/appsec_query_findings","metadata":{"seo":{"title":"Query findings across all applications","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/app-sec/findings"},{"label":"Create Findings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/appsec/appsec_create_findings","routeSlug":"/api-reference/connectors/appsec/appsec_create_findings","metadata":{"seo":{"title":"Create Findings","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/app-sec/findings/bulk"},{"label":"Get Application Finding Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/appsec/appsec_get_application_finding_details","routeSlug":"/api-reference/connectors/appsec/appsec_get_application_finding_details","metadata":{"seo":{"title":"Get Application Finding Details","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/app-sec/applications/{applicationId}/findings/{findingId}"},{"label":"Query Application Scans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/appsec/appsec_query_application_scans","routeSlug":"/api-reference/connectors/appsec/appsec_query_application_scans","metadata":{"seo":{"title":"Query Application Scans","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/app-sec/applications/{applicationId}/scans"}]},{"type":"group","label":"Assets","link":"/api-reference/connectors/assets","routeSlug":"/api-reference/connectors/assets","items":[{"label":"Query Devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_query_devices","routeSlug":"/api-reference/connectors/assets/assets_query_devices","metadata":{"seo":{"title":"Query Devices","description":"Query devices from an asset inventory system"}},"httpPath":"/v1/assets/devices"},{"label":"Create Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_create_asset","routeSlug":"/api-reference/connectors/assets/assets_create_asset","metadata":{"seo":{"title":"Create Device","description":"Creates a Device object in the token-linked Integration."}},"httpPath":"/v1/assets/devices"},{"label":"Create Devices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_create_devices","routeSlug":"/api-reference/connectors/assets/assets_create_devices","metadata":{"seo":{"title":"Create Devices","description":"Bulk create devices in an device inventory system"}},"httpPath":"/v1/assets/devices/bulk"},{"label":"Get Labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_get_labels","routeSlug":"/api-reference/connectors/assets/assets_get_labels","metadata":{"seo":{"title":"Get Labels","description":"Get labels from an asset inventory system"}},"httpPath":"/v1/assets/labels"},{"label":"Query Software Inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_query_software","routeSlug":"/api-reference/connectors/assets/assets_query_software","metadata":{"seo":{"title":"Query Software Inventory","description":"Query software inventory records from an asset management system"}},"httpPath":"/v1/assets/software"},{"label":"Create Software Inventory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_create_software","routeSlug":"/api-reference/connectors/assets/assets_create_software","metadata":{"seo":{"title":"Create Software Inventory","description":"Creates a software inventory record in the token-linked Integration."}},"httpPath":"/v1/assets/software"},{"label":"Query Device Software Inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_query_device_software","routeSlug":"/api-reference/connectors/assets/assets_query_device_software","metadata":{"seo":{"title":"Query Device Software Inventory","description":"Query software inventory records for a single device."}},"httpPath":"/v1/assets/devices/{deviceUid}/software"},{"label":"Update Software Inventory","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/assets/assets_update_software","routeSlug":"/api-reference/connectors/assets/assets_update_software","metadata":{"seo":{"title":"Update Software Inventory","description":"Updates a software inventory record on a known device in the token-linked Integration."}},"httpPath":"/v1/assets/software/{deviceUid}"}]},{"type":"group","label":"Chat","link":"/api-reference/connectors/chat","routeSlug":"/api-reference/connectors/chat","items":[{"label":"Query Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_users","routeSlug":"/api-reference/connectors/chat/chat_query_users","metadata":{"seo":{"title":"Query Users","description":"Returns a list of users in the connected workspace or tenant. Used to discover whose conversations can be queried."}},"httpPath":"/v1/chat/users"},{"label":"Query User Conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_user_conversations","routeSlug":"/api-reference/connectors/chat/chat_query_user_conversations","metadata":{"seo":{"title":"Query User Conversations","description":"Returns a list of conversations scoped to a specific user — DMs, group chats, or (for AI providers) synthesised sessions."}},"httpPath":"/v1/chat/users/{userId}/conversations"},{"label":"Query User Conversation Members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_user_conversation_members","routeSlug":"/api-reference/connectors/chat/chat_query_user_conversation_members","metadata":{"seo":{"title":"Query User Conversation Members","description":"Returns the members of a conversation scoped to a specific user. Required for providers where conversations are only addressable via the user (e.g. Teams DMs, Copilot AI sessions)."}},"httpPath":"/v1/chat/users/{userId}/conversations/{conversationId}/members"},{"label":"Query User Conversation Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_user_conversation_messages","routeSlug":"/api-reference/connectors/chat/chat_query_user_conversation_messages","metadata":{"seo":{"title":"Query User Conversation Messages","description":"Returns messages from a conversation scoped to a specific user. Required for providers where conversations are only addressable via the user (e.g. Teams DMs, Copilot AI sessions)."}},"httpPath":"/v1/chat/users/{userId}/conversations/{conversationId}/messages"},{"label":"Query Conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_conversations","routeSlug":"/api-reference/connectors/chat/chat_query_conversations","metadata":{"seo":{"title":"Query Conversations","description":"Returns a list of conversations (channels or workspaces) not scoped to a specific user. Providers that can only enumerate conversations per-user return NotImplemented; use query_user_conversations instead."}},"httpPath":"/v1/chat/conversations"},{"label":"Query Conversation Members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_conversation_members","routeSlug":"/api-reference/connectors/chat/chat_query_conversation_members","metadata":{"seo":{"title":"Query Conversation Members","description":"Returns the members of a specific conversation. Use the user-scoped variant (query_user_conversation_members) for chats that only exist in a user's mailbox (e.g. Teams 1:1 chats). Where the provider supports create_direct_message, the conversation UID it returns is accepted here."}},"httpPath":"/v1/chat/conversations/{conversationId}/members"},{"label":"Query Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_messages","routeSlug":"/api-reference/connectors/chat/chat_query_messages","metadata":{"seo":{"title":"Query Messages","description":"Returns all messages across every conversation in the connected workspace or tenant."}},"httpPath":"/v1/chat/messages"},{"label":"Query Conversation Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_query_conversation_messages","routeSlug":"/api-reference/connectors/chat/chat_query_conversation_messages","metadata":{"seo":{"title":"Query Conversation Messages","description":"Returns messages from a specific conversation. The conversationId must be obtained from query_conversations or query_user_conversations. Use the user-scoped variant (query_user_conversation_messages) for chats that only exist in a user's mailbox. Where the provider supports create_direct_message, the conversation UID it returns is accepted here. Where the provider declares a chat_message.parent_uid filter, filtering on it with the uid of a thread's top-level message returns that thread's replies instead."}},"httpPath":"/v1/chat/conversations/{conversationId}/messages"},{"label":"Create Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_create_message","routeSlug":"/api-reference/connectors/chat/chat_create_message","metadata":{"seo":{"title":"Create Message","description":"Posts a message to a conversation as the integration's bot or app, either as a new top-level message or as a reply in a thread. The response carries the message's uid, which update_message and delete_message accept."}},"httpPath":"/v1/chat/conversations/{conversationId}/messages"},{"label":"Create Direct Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_create_direct_message","routeSlug":"/api-reference/connectors/chat/chat_create_direct_message","metadata":{"seo":{"title":"Create Direct Message","description":"Sends a direct message to one user, opening the direct conversation if it does not exist yet. The response's chat_message.conversation_uid addresses that conversation for later messages and reads."}},"httpPath":"/v1/chat/direct-messages"},{"label":"Update Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_update_message","routeSlug":"/api-reference/connectors/chat/chat_update_message","metadata":{"seo":{"title":"Update Message","description":"Replaces the text of a message the integration sent. Messages sent by anyone else cannot be updated, and a provider's admin policy can forbid edits. The response can lack chat_message.parent_uid; the create_message response for a reply carries it."}},"httpPath":"/v1/chat/conversations/{conversationId}/messages/{messageId}"},{"label":"Delete Message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/chat/chat_delete_message","routeSlug":"/api-reference/connectors/chat/chat_delete_message","metadata":{"seo":{"title":"Delete Message","description":"Deletes a message the integration sent. Messages sent by anyone else cannot be deleted, and a provider's admin policy can forbid deletes."}},"httpPath":"/v1/chat/conversations/{conversationId}/messages/{messageId}"}]},{"type":"group","label":"Cloud Security (In Development)","link":"/api-reference/connectors/cloudsecurity","routeSlug":"/api-reference/connectors/cloudsecurity","items":[{"label":"Query Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_events","routeSlug":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_events","metadata":{"seo":{"title":"Query Events","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/cloudsecurity/events"},{"label":"Query IOMs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_ioms","routeSlug":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_ioms","metadata":{"seo":{"title":"Query IOMs","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/cloudsecurity/ioms"},{"label":"Query Cloud Resource Inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_cloud_resource_inventory","routeSlug":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_cloud_resource_inventory","metadata":{"seo":{"title":"Query Cloud Resource Inventory","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/cloudsecurity/cloudresourcesinventory"},{"label":"Query Compliance Findings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_compliance_findings","routeSlug":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_compliance_findings","metadata":{"seo":{"title":"Query Compliance Findings","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/cloudsecurity/compliancefindings"},{"label":"Query Threats","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_threats","routeSlug":"/api-reference/connectors/cloudsecurity/cloudsecurity_query_threats","metadata":{"seo":{"title":"Query Threats","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/cloudsecurity/threats"}]},{"type":"group","label":"Endpoint Detection & Response (EDR)","link":"/api-reference/connectors/edr","routeSlug":"/api-reference/connectors/edr","items":[{"label":"Query Endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_endpoints","routeSlug":"/api-reference/connectors/edr/edr_query_endpoints","metadata":{"seo":{"title":"Query Endpoints","description":"Returns a list of endpoint assets matching the query from the token-linked EDR source."}},"httpPath":"/v1/edr/endpoints"},{"label":"Get Endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_get_endpoint","routeSlug":"/api-reference/connectors/edr/edr_get_endpoint","metadata":{"seo":{"title":"Get Endpoint","description":"Gets a single endpoint assets matching the UID from the token-linked EDR source."}},"httpPath":"/v1/edr/endpoints/{id}"},{"label":"Execute Command","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_execute_command","routeSlug":"/api-reference/connectors/edr/edr_execute_command","metadata":{"seo":{"title":"Execute Command","description":"Runs a provider-backed command on the endpoint identified by {uid} and returns normalized stdout and stderr without exposing provider session details."}},"httpPath":"/v1/edr/endpoints/{uid}/actions/execute-command"},{"label":"Execute Remote Script","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_execute_remote_script","routeSlug":"/api-reference/connectors/edr/edr_execute_remote_script","metadata":{"seo":{"title":"Execute Remote Script","description":"Runs a script on the endpoint identified by {uid} and returns normalized stdout and stderr without exposing provider session details. Long-running executions return a pending status with a cursor to resume polling."}},"httpPath":"/v1/edr/endpoints/{uid}/actions/execute-remote-script"},{"label":"Retrieve File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_retrieve_file","routeSlug":"/api-reference/connectors/edr/edr_retrieve_file","metadata":{"seo":{"title":"Retrieve File","description":"Retrieves a file from the endpoint identified by {uid} and returns the provider artifact as a binary file response."}},"httpPath":"/v1/edr/endpoints/{uid}/actions/retrieve-file"},{"label":"Query Applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_applications","routeSlug":"/api-reference/connectors/edr/edr_query_applications","metadata":{"seo":{"title":"Query Applications","description":"Returns a list of applications matching the query from the token-linked EDR source."}},"httpPath":"/v1/edr/applications"},{"label":"Quarantine Endpoints","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_network_quarantine","routeSlug":"/api-reference/connectors/edr/edr_network_quarantine","metadata":{"seo":{"title":"Quarantine Endpoints","description":"Connect or disconnect one or more endpoints assets to the network, allowing or disallowing connections."}},"httpPath":"/v1/edr/endpoints/actions/quarantine"},{"label":"Query Threat Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_threatevents","routeSlug":"/api-reference/connectors/edr/edr_query_threatevents","metadata":{"seo":{"title":"Query Threat Events","description":"Returns a list of threats that match the query from the token-linked EDR source."}},"httpPath":"/v1/edr/threats"},{"label":"Query Alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_alerts","routeSlug":"/api-reference/connectors/edr/edr_query_alerts","metadata":{"seo":{"title":"Query Alerts","description":"Returns a list of alerts that match the query from the token-linked EDR source."}},"httpPath":"/v1/edr/alerts"},{"label":"Update Alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_update_alert","routeSlug":"/api-reference/connectors/edr/edr_update_alert","metadata":{"seo":{"title":"Update Alert","description":"Updates the triage state of a single alert in the token-linked EDR source: its lifecycle status, the analyst verdict, a comment and who it is assigned to."}},"httpPath":"/v1/edr/alerts/{alertId}"},{"label":"Query IOCs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_iocs","routeSlug":"/api-reference/connectors/edr/edr_query_iocs","metadata":{"seo":{"title":"Query IOCs","description":"Returns a list of iocs that match the query from the token-linked EDR source."}},"httpPath":"/v1/edr/iocs"},{"label":"Create IOCs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_create_iocs","routeSlug":"/api-reference/connectors/edr/edr_create_iocs","metadata":{"seo":{"title":"Create IOCs","description":"Creates a list of iocs that match the stix input for the EDR source."}},"httpPath":"/v1/edr/iocs"},{"label":"Delete IOCs","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_delete_iocs","routeSlug":"/api-reference/connectors/edr/edr_delete_iocs","metadata":{"seo":{"title":"Delete IOCs","description":"Deletes a list of iocs that match the input of ids in the query param"}},"httpPath":"/v1/edr/iocs"},{"label":"Query IOAs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_ioa","routeSlug":"/api-reference/connectors/edr/edr_query_ioa","metadata":{"seo":{"title":"Query IOAs","description":"Returns a list of IOA rules that match the query from the token-linked EDR source."}},"httpPath":"/v1/edr/ioas"},{"label":"Create IOA","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_create_ioa","routeSlug":"/api-reference/connectors/edr/edr_create_ioa","metadata":{"seo":{"title":"Create IOA","description":"Creates an IOA rule for the token-linked EDR source."}},"httpPath":"/v1/edr/ioas"},{"label":"Delete IOAs","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_delete_ioa","routeSlug":"/api-reference/connectors/edr/edr_delete_ioa","metadata":{"seo":{"title":"Delete IOAs","description":"Deletes the IOA rules identified by the ids in the query params. Some providers scope rule ids to a rule group; for those providers group_id is required."}},"httpPath":"/v1/edr/ioas"},{"label":"Query Exclusions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_exclusions","routeSlug":"/api-reference/connectors/edr/edr_query_exclusions","metadata":{"seo":{"title":"Query Exclusions","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/edr/exclusions"},{"label":"Query Policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_policies","routeSlug":"/api-reference/connectors/edr/edr_query_policies","metadata":{"seo":{"title":"Query Policies","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/edr/policies"},{"label":"Query Posture Score","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_posture_score","routeSlug":"/api-reference/connectors/edr/edr_query_posture_score","metadata":{"seo":{"title":"Query Posture Score","description":"Returns the posture score of the endpoint assets that match the query from the token-linked EDR source."}},"httpPath":"/v1/edr/posture_score"},{"label":"Query EDR Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_query_edr_events","routeSlug":"/api-reference/connectors/edr/edr_query_edr_events","metadata":{"seo":{"title":"Query EDR Events","description":"Returns a list of EDR events that match the query from the token-linked EDR source."}},"httpPath":"/v1/edr/edr_events"},{"label":"Get Threat Notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_get_threat_notes","routeSlug":"/api-reference/connectors/edr/edr_get_threat_notes","metadata":{"seo":{"title":"Get Threat Notes","description":"Returns a list of notes for a threat."}},"httpPath":"/v1/edr/threats/{threatId}/notes"},{"label":"Create Threat Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/edr/edr_create_threat_note","routeSlug":"/api-reference/connectors/edr/edr_create_threat_note","metadata":{"seo":{"title":"Create Threat Note","description":"Creates a note for a threat."}},"httpPath":"/v1/edr/threats/{threatId}/notes"}]},{"type":"group","label":"Email Security","link":"/api-reference/connectors/emailsecurity","routeSlug":"/api-reference/connectors/emailsecurity","items":[{"label":"Query Threats","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/emailsecurity/emailsecurity_query_threats","routeSlug":"/api-reference/connectors/emailsecurity/emailsecurity_query_threats","metadata":{"seo":{"title":"Query Threats","description":"Returns a list of threats matching the query from the token-linked Email Security provider. Defaults to the last 30 days of threats. This can be overridden by using the time filter. Note that some providers may have a maximum time range limit. A threat is an automated detection that was deemed to be a threat by the Email Security provider."}},"httpPath":"/v1/email-security/threats"},{"label":"Get Threat Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/emailsecurity/emailsecurity_get_threat_details","routeSlug":"/api-reference/connectors/emailsecurity/emailsecurity_get_threat_details","metadata":{"seo":{"title":"Get Threat Details","description":"Returns the details of the threat matching {threatId} from the token-linked Email Security provider. If a provider allows for the gathering of more detailed information about a threat, the response will include the additional information. Otherwise, the response will only include the basic information about the threat returned by the query_threats endpoint."}},"httpPath":"/v1/email-security/threats/{threatId}"},{"label":"Query Email Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/emailsecurity/emailsecurity_query_email_events","routeSlug":"/api-reference/connectors/emailsecurity/emailsecurity_query_email_events","metadata":{"seo":{"title":"Query Email Events","description":"Returns a list of email events matching the query from the token-linked Email Security provider. Most providers default to the last 30 days of email events, which the time filter overrides. Others use a different default range or filter on a different time field, so refer to the provider's declared filters. Some providers also limit the maximum time range."}},"httpPath":"/v1/email-security/email-events"}]},{"type":"group","label":"Endpoint Management","link":"/api-reference/connectors/endpointmanagement","routeSlug":"/api-reference/connectors/endpointmanagement","items":[{"label":"Query Devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_query_devices","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_query_devices","metadata":{"seo":{"title":"Query Devices","description":"Returns a list of managed devices matching the query from the token-linked endpoint management source."}},"httpPath":"/v1/endpoint-management/devices"},{"label":"Get Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_get_device","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_get_device","metadata":{"seo":{"title":"Get Device","description":"Gets a single managed device matching the ID from the token-linked endpoint management source."}},"httpPath":"/v1/endpoint-management/devices/{id}"},{"label":"Query Device Compliance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_query_compliance_findings","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_query_compliance_findings","metadata":{"seo":{"title":"Query Device Compliance","description":"Returns a list of device compliance findings matching the query from the token-linked endpoint management source."}},"httpPath":"/v1/endpoint-management/compliance"},{"label":"Remediate Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_remediate_device","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_remediate_device","metadata":{"seo":{"title":"Remediate Device","description":"Performs a remediation action on a managed device from the token-linked endpoint management source."}},"httpPath":"/v1/endpoint-management/devices/actions/remediate"},{"label":"Update Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_update_device","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_update_device","metadata":{"seo":{"title":"Update Device","description":"Triggers the device to check in and enforce all assigned policies, profiles, and pending updates."}},"httpPath":"/v1/endpoint-management/devices/actions/update"},{"label":"Lock Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_lock_device","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_lock_device","metadata":{"seo":{"title":"Lock Device","description":"Remotely locks the device screen."}},"httpPath":"/v1/endpoint-management/devices/actions/lock"},{"label":"Restart Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_restart_device","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_restart_device","metadata":{"seo":{"title":"Restart Device","description":"Remotely reboots the device."}},"httpPath":"/v1/endpoint-management/devices/actions/restart"},{"label":"Wipe Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_wipe_device","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_wipe_device","metadata":{"seo":{"title":"Wipe Device","description":"Factory resets or erases all data from the device."}},"httpPath":"/v1/endpoint-management/devices/actions/wipe"},{"label":"Query Device Applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/endpointmanagement/endpointmanagement_query_device_applications","routeSlug":"/api-reference/connectors/endpointmanagement/endpointmanagement_query_device_applications","metadata":{"seo":{"title":"Query Device Applications","description":"Returns a list of applications installed on a managed device from the token-linked endpoint management source."}},"httpPath":"/v1/endpoint-management/devices/{id}/applications"}]},{"type":"group","label":"Governance, Risk, & Compliance (GRC) (In Development)","link":"/api-reference/connectors/grc","routeSlug":"/api-reference/connectors/grc","items":[{"label":"Query Frameworks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_query_frameworks","routeSlug":"/api-reference/connectors/grc/grc_query_frameworks","metadata":{"seo":{"title":"Query Frameworks","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/frameworks"},{"label":"Query Controls","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_query_controls","routeSlug":"/api-reference/connectors/grc/grc_query_controls","metadata":{"seo":{"title":"Query Controls","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/controls"},{"label":"Get GrcControl","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_get_control","routeSlug":"/api-reference/connectors/grc/grc_get_control","metadata":{"seo":{"title":"Get GrcControl","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/controls/{controlId}"},{"label":"Query Tests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_query_tests","routeSlug":"/api-reference/connectors/grc/grc_query_tests","metadata":{"seo":{"title":"Query Tests","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/tests"},{"label":"Get GrcTest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_get_test","routeSlug":"/api-reference/connectors/grc/grc_get_test","metadata":{"seo":{"title":"Get GrcTest","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/tests/{testId}"},{"label":"Query GrcEvidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_query_evidence","routeSlug":"/api-reference/connectors/grc/grc_query_evidence","metadata":{"seo":{"title":"Query GrcEvidence","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/evidence"},{"label":"Query Devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_query_devices","routeSlug":"/api-reference/connectors/grc/grc_query_devices","metadata":{"seo":{"title":"Query Devices","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/devices"},{"label":"Get Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_get_device","routeSlug":"/api-reference/connectors/grc/grc_get_device","metadata":{"seo":{"title":"Get Device","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/devices/{deviceId}"},{"label":"Query Personnel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_query_personnel","routeSlug":"/api-reference/connectors/grc/grc_query_personnel","metadata":{"seo":{"title":"Query Personnel","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/personnel"},{"label":"Get Personnel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/grc/grc_get_personnel","routeSlug":"/api-reference/connectors/grc/grc_get_personnel","metadata":{"seo":{"title":"Get Personnel","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/grc/personnel/{personnelId}"}]},{"type":"group","label":"Hooks","link":"/api-reference/connectors/hooks","routeSlug":"/api-reference/connectors/hooks","items":[{"label":"Proxy Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/hooks/hooks_proxy","routeSlug":"/api-reference/connectors/hooks/hooks_proxy","metadata":{"seo":{"title":"Proxy Webhook","description":"Proxy webhook messages from webhook providers to webhook recievers. For exact webhook implementations please refer to providers e.g. Ticketing. This is just an API call used in that context, not a standalone implementation."}},"httpPath":"/v1/hooks"}]},{"type":"group","label":"Identity","link":"/api-reference/connectors/identity","routeSlug":"/api-reference/connectors/identity","items":[{"label":"Query Audit Log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_audit_log","routeSlug":"/api-reference/connectors/identity/identity_query_audit_log","metadata":{"seo":{"title":"Query Audit Log","description":"Returns a list of Event objects from the token-linked audit log."}},"httpPath":"/v1/identity/audit"},{"label":"Query Risk Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_risk_events","routeSlug":"/api-reference/connectors/identity/identity_query_risk_events","metadata":{"seo":{"title":"Query Risk Events","description":"Returns identity threat / risk events (for example Microsoft Entra Identity Protection risk detections for users), normalized to OCSF."}},"httpPath":"/v1/identity/risk-events"},{"label":"Query Risky Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_risky_users","routeSlug":"/api-reference/connectors/identity/identity_query_risky_users","metadata":{"seo":{"title":"Query Risky Users","description":"Returns rolled-up risky user records (for example Microsoft Entra Identity Protection riskyUsers), each normalized to an OCSF Entity Management Read event."}},"httpPath":"/v1/identity/risky-users"},{"label":"Query Applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_applications","routeSlug":"/api-reference/connectors/identity/identity_query_applications","metadata":{"seo":{"title":"Query Applications","description":"Returns the applications registered in, or connected to, the identity provider, such as SSO applications, OAuth and OIDC clients, service principals and installed apps, each normalized to an OCSF Application Inventory Info event. A provider that keeps more than one kind of record for an application returns each as its own record, distinguished by application.type."}},"httpPath":"/v1/identity/applications"},{"label":"Query Access Grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_access_grants","routeSlug":"/api-reference/connectors/identity/identity_query_access_grants","metadata":{"seo":{"title":"Query Access Grants","description":"Returns the standing access that principals hold in the identity provider, normalized to OCSF Access Grant Inventory Info events. A grant is a delegated permission (an application acting on behalf of a signed-in user), an application permission (an application acting as itself), or an assignment (a user, group or application assigned to an application or resource)."}},"httpPath":"/v1/identity/access-grants"},{"label":"Query Policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_policies","routeSlug":"/api-reference/connectors/identity/identity_query_policies","metadata":{"seo":{"title":"Query Policies","description":"Returns the authentication, authorization, consent and access policies configured in the token-linked identity provider. Disabled and report-only policies are included."}},"httpPath":"/v1/identity/policies"},{"label":"Query Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_users","routeSlug":"/api-reference/connectors/identity/identity_query_users","metadata":{"seo":{"title":"Query Users","description":"Returns a list of User objects wrapped in the OCSF Entity Management event of type Read from the token-linked identity provider."}},"httpPath":"/v1/identity/users"},{"label":"Get User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_get_user","routeSlug":"/api-reference/connectors/identity/identity_get_user","metadata":{"seo":{"title":"Get User","description":"Returns a User object wrapped in an OCSF Entity Management event of type Read from the token-linked identity provider. Dependingon the providers offerings, this may include additional user information, such as the user's current groups, roles, and Identity Protection risk state (when the provider exposes it and the user has a risk record)."}},"httpPath":"/v1/identity/users/{userId}"},{"label":"Query Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_query_groups","routeSlug":"/api-reference/connectors/identity/identity_query_groups","metadata":{"seo":{"title":"Query Groups","description":"Returns a list of Group objects wrapped in the OCSF Entity Management event of type Read from the token-linked identity provider."}},"httpPath":"/v1/identity/groups"},{"label":"Get Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_get_group","routeSlug":"/api-reference/connectors/identity/identity_get_group","metadata":{"seo":{"title":"Get Group","description":"Returns a Group object wrapped in an OCSF Entity Management event of type Read from the token-linked identity provider. Dependingon the providers offerings, this may include additional group information, such as the roles assigned."}},"httpPath":"/v1/identity/groups/{groupId}"},{"label":"Get Group Members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_get_group_members","routeSlug":"/api-reference/connectors/identity/identity_get_group_members","metadata":{"seo":{"title":"Get Group Members","description":"Returns list of User objects wrapped in an OCSF Entity Management event of type Read from the token-linked identity provider that are members in the group referenced by ID."}},"httpPath":"/v1/identity/groups/{groupId}/members"},{"label":"Enable User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_enable_user","routeSlug":"/api-reference/connectors/identity/identity_enable_user","metadata":{"seo":{"title":"Enable User","description":"Reenables a disabled user in the identity system based on user ID."}},"httpPath":"/v1/identity/users/{userId}/actions/enable"},{"label":"Disable User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_disable_user","routeSlug":"/api-reference/connectors/identity/identity_disable_user","metadata":{"seo":{"title":"Disable User","description":"Disables a user in the identity system based on user ID."}},"httpPath":"/v1/identity/users/{userId}/actions/disable"},{"label":"Force User Password Reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_force_user_password_reset","routeSlug":"/api-reference/connectors/identity/identity_force_user_password_reset","metadata":{"seo":{"title":"Force User Password Reset","description":"Forces a user to reset their password before they can log in again."}},"httpPath":"/v1/identity/users/{userId}/actions/force_reset_password"},{"label":"Expire All User Sessions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_expire_all_user_sessions","routeSlug":"/api-reference/connectors/identity/identity_expire_all_user_sessions","metadata":{"seo":{"title":"Expire All User Sessions","description":"Logs a user out of all current sessions so they must log in again."}},"httpPath":"/v1/identity/users/{userId}/actions/expire_all_sessions"},{"label":"Get User Picture","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/identity/identity_get_user_picture","routeSlug":"/api-reference/connectors/identity/identity_get_user_picture","metadata":{"seo":{"title":"Get User Picture","description":"This operation is available for testing but may be unstable. Breakingchanges are unlikely but may still be necessary.Please contact us before using this operation."}},"badges":[{"name":"Beta","color":"pre-release","position":"before"}],"httpPath":"/v1/identity/users/{userId}/picture"}]},{"type":"group","label":"Incident Response (In Development)","link":"/api-reference/connectors/incidentresponse","routeSlug":"/api-reference/connectors/incidentresponse","items":[{"label":"Query Escalation Policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/incidentresponse/incidentresponse_query_escalation_policies","routeSlug":"/api-reference/connectors/incidentresponse/incidentresponse_query_escalation_policies","metadata":{"seo":{"title":"Query Escalation Policies","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/incident-response/escalation-policies"},{"label":"Query Escalation Policy Users On Call","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/incidentresponse/incidentresponse_query_escalation_policy_users_on_call","routeSlug":"/api-reference/connectors/incidentresponse/incidentresponse_query_escalation_policy_users_on_call","metadata":{"seo":{"title":"Query Escalation Policy Users On Call","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/incident-response/escalation-policies/{escalationPolicyId}/users-on-call"}]},{"type":"group","label":"Integration Webhooks","link":"/api-reference/connectors/integrationwebhooks","routeSlug":"/api-reference/connectors/integrationwebhooks","items":[{"label":"Create Integration WebHook Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/integrationwebhooks/integrationwebhooks_create_webhook","routeSlug":"/api-reference/connectors/integrationwebhooks/integrationwebhooks_create_webhook","metadata":{"seo":{"title":"Create Integration WebHook Configuration","description":"Creates a WebHook for the token-linked Integration."}},"httpPath":"/v1/integration-webhooks"},{"label":"Delete Integration WebHook Configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/integrationwebhooks/integrationwebhooks_delete_webhook","routeSlug":"/api-reference/connectors/integrationwebhooks/integrationwebhooks_delete_webhook","metadata":{"seo":{"title":"Delete Integration WebHook Configuration","description":"Deletes the WebHook matching the token-linked Integration."}},"httpPath":"/v1/integration-webhooks"},{"label":"List Integration WebHook Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/integrationwebhooks/integrationwebhooks_list_webhooks","routeSlug":"/api-reference/connectors/integrationwebhooks/integrationwebhooks_list_webhooks","metadata":{"seo":{"title":"List Integration WebHook Configurations","description":"Lists all WebHooks from the token-linked Integration."}},"httpPath":"/v1/integration-webhooks"}]},{"type":"group","label":"Network Security (In Development)","link":"/api-reference/connectors/networksecurity","routeSlug":"/api-reference/connectors/networksecurity","items":[{"label":"Query Traffic Log Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/networksecurity/networksecurity_query_traffic_log_configurations","routeSlug":"/api-reference/connectors/networksecurity/networksecurity_query_traffic_log_configurations","metadata":{"seo":{"title":"Query Traffic Log Configurations","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/network-security/traffic/log-configurations"},{"label":"Query Traffic Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/networksecurity/networksecurity_query_traffic_events","routeSlug":"/api-reference/connectors/networksecurity/networksecurity_query_traffic_events","metadata":{"seo":{"title":"Query Traffic Events","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/network-security/traffic/log-events"},{"label":"Query DNS Log Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/networksecurity/networksecurity_query_dns_log_configurations","routeSlug":"/api-reference/connectors/networksecurity/networksecurity_query_dns_log_configurations","metadata":{"seo":{"title":"Query DNS Log Configurations","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/network-security/dns/log-configurations"},{"label":"Query DNS Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/networksecurity/networksecurity_query_dns_events","routeSlug":"/api-reference/connectors/networksecurity/networksecurity_query_dns_events","metadata":{"seo":{"title":"Query DNS Events","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/network-security/dns/log-events"},{"label":"Query Firewall Rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/networksecurity/networksecurity_query_firewall_rules","routeSlug":"/api-reference/connectors/networksecurity/networksecurity_query_firewall_rules","metadata":{"seo":{"title":"Query Firewall Rules","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/network-security/firewall-rules"}]},{"type":"group","label":"Notifications","link":"/api-reference/connectors/notifications","routeSlug":"/api-reference/connectors/notifications","items":[{"label":"Get Notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/notifications/notifications_get_message","routeSlug":"/api-reference/connectors/notifications/notifications_get_message","metadata":{"seo":{"title":"Get Notification","description":"Returns the Notification object matching {notificationId} from the token-linked Integration."}},"httpPath":"/v1/notifications/get/{notificationId}"},{"label":"Create Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/notifications/notifications_create_message","routeSlug":"/api-reference/connectors/notifications/notifications_create_message","metadata":{"seo":{"title":"Create Notification","description":"Creates a Notification object in the token-linked Integration."}},"httpPath":"/v1/notifications/create"},{"label":"Clear Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/notifications/notifications_clear_message","routeSlug":"/api-reference/connectors/notifications/notifications_clear_message","metadata":{"seo":{"title":"Clear Notification","description":"Resolves a Notification object in the token-linked Integration."}},"httpPath":"/v1/notifications/clear/{notificationId}"}]},{"type":"group","label":"Operations (In Development)","link":"/api-reference/connectors/operations","routeSlug":"/api-reference/connectors/operations","items":[{"label":"Get Asynchronous Operation state","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/operations/operations_get","routeSlug":"/api-reference/connectors/operations/operations_get","metadata":{"seo":{"title":"Get Asynchronous Operation state","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/operations/{operationId}"},{"label":"Cancel Asynchronous Operation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/operations/operations_cancel","routeSlug":"/api-reference/connectors/operations/operations_cancel","metadata":{"seo":{"title":"Cancel Asynchronous Operation","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/operations/{operationId}"},{"label":"Create Asynchronous Operation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/operations/operations_create","routeSlug":"/api-reference/connectors/operations/operations_create","metadata":{"seo":{"title":"Create Asynchronous Operation","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/operations"}]},{"type":"group","label":"Security Awareness (In Development)","link":"/api-reference/connectors/securityawareness","routeSlug":"/api-reference/connectors/securityawareness","items":[{"label":"Query Training Campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/securityawareness/securityawareness_query_training_campaigns","routeSlug":"/api-reference/connectors/securityawareness/securityawareness_query_training_campaigns","metadata":{"seo":{"title":"Query Training Campaigns","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/security-awareness/training/campaigns"},{"label":"Query Phishing Simulations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/securityawareness/securityawareness_query_phishing_simulations","routeSlug":"/api-reference/connectors/securityawareness/securityawareness_query_phishing_simulations","metadata":{"seo":{"title":"Query Phishing Simulations","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/security-awareness/phishing/simulations"},{"label":"Query Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/securityawareness/securityawareness_query_users","routeSlug":"/api-reference/connectors/securityawareness/securityawareness_query_users","metadata":{"seo":{"title":"Query Users","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/security-awareness/users"},{"label":"Get Training Campaign Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/securityawareness/securityawareness_get_training_campaign_details","routeSlug":"/api-reference/connectors/securityawareness/securityawareness_get_training_campaign_details","metadata":{"seo":{"title":"Get Training Campaign Details","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/security-awareness/training/campaigns/{trainingCampaignId}"},{"label":"Get Phishing Simulation Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/securityawareness/securityawareness_get_phishing_simulation_details","routeSlug":"/api-reference/connectors/securityawareness/securityawareness_get_phishing_simulation_details","metadata":{"seo":{"title":"Get Phishing Simulation Details","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/security-awareness/phishing/simulations/{phishingSimulationId}"},{"label":"Get User Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/securityawareness/securityawareness_get_user_details","routeSlug":"/api-reference/connectors/securityawareness/securityawareness_get_user_details","metadata":{"seo":{"title":"Get User Details","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/security-awareness/users/{userId}"}]},{"type":"group","label":"Security Information & Event Management (SIEM)","link":"/api-reference/connectors/siem","routeSlug":"/api-reference/connectors/siem","items":[{"label":"Query Investigations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_query_investigations","routeSlug":"/api-reference/connectors/siem/siem_query_investigations","metadata":{"seo":{"title":"Query Investigations","description":"Queries investigations"}},"httpPath":"/v1/siem/investigations"},{"label":"Get Investigation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_get_investigation","routeSlug":"/api-reference/connectors/siem/siem_get_investigation","metadata":{"seo":{"title":"Get Investigation","description":"Retrieves an investigation by ID."}},"httpPath":"/v1/siem/investigations/{id}"},{"label":"Patch Investigation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_patch_investigation","routeSlug":"/api-reference/connectors/siem/siem_patch_investigation","metadata":{"seo":{"title":"Patch Investigation","description":"Updates an investigation by ID."}},"httpPath":"/v1/siem/investigations/{id}"},{"label":"Get Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_get_evidence","routeSlug":"/api-reference/connectors/siem/siem_get_evidence","metadata":{"seo":{"title":"Get Evidence","description":"Retrieves the evidence for an investigation."}},"httpPath":"/v1/siem/investigations/{id}/evidence"},{"label":"Query Log Providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_query_log_providers","routeSlug":"/api-reference/connectors/siem/siem_query_log_providers","metadata":{"seo":{"title":"Query Log Providers","description":"Queries available log providers in the source SIEM"}},"httpPath":"/v1/siem/log-providers"},{"label":"Post Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_post_events","routeSlug":"/api-reference/connectors/siem/siem_post_events","metadata":{"seo":{"title":"Post Events","description":"Writes a batch of Event objects to the SIEM configured with the token used for authentication."}},"httpPath":"/v1/siem/events"},{"label":"Query Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_query_events","routeSlug":"/api-reference/connectors/siem/siem_query_events","metadata":{"seo":{"title":"Query Events","description":"Queries events from the SIEM configured with the token used for authentication."}},"httpPath":"/v1/siem/events"},{"label":"Query Alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_query_alerts","routeSlug":"/api-reference/connectors/siem/siem_query_alerts","metadata":{"seo":{"title":"Query Alerts","description":"Queries alerts from the SIEM configured with the token used for authentication."}},"httpPath":"/v1/siem/alerts"},{"label":"Get Alert","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_get_alert","routeSlug":"/api-reference/connectors/siem/siem_get_alert","metadata":{"seo":{"title":"Get Alert","description":"Retrieves an alert by ID."}},"httpPath":"/v1/siem/alerts/{id}"},{"label":"Update Alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/siem/siem_update_alert","routeSlug":"/api-reference/connectors/siem/siem_update_alert","metadata":{"seo":{"title":"Update Alert","description":"Updates the triage state of a single alert in the token-linked SIEM: its lifecycle status, the analyst verdict, a comment and who it is assigned to."}},"httpPath":"/v1/siem/alerts/{id}"}]},{"type":"group","label":"Sink","link":"/api-reference/connectors/sink","routeSlug":"/api-reference/connectors/sink","items":[{"label":"Post Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/sink/sink_post_events","routeSlug":"/api-reference/connectors/sink/sink_post_events","metadata":{"seo":{"title":"Post Events","description":"Writes a batch of Event objects to the Sink configured with the token used for authentication."}},"httpPath":"/v1/sink/events"}]},{"type":"group","label":"Ssf","link":"/api-reference/connectors/ssf","routeSlug":"/api-reference/connectors/ssf","items":[{"label":"Post Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ssf/ssf_post_event","routeSlug":"/api-reference/connectors/ssf/ssf_post_event","metadata":{"seo":{"title":"Post Event","description":"Signs a security signal as a Security Event Token and delivers it to the receiver configured with the token used for authentication. A success response means the receiver accepted the token. It does not mean the receiver acted on it."}},"httpPath":"/v1/ssf/events"},{"label":"Get Transmitter URLs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ssf/ssf_get_transmitter_urls","routeSlug":"/api-reference/connectors/ssf/ssf_get_transmitter_urls","metadata":{"seo":{"title":"Get Transmitter URLs","description":"Returns the URLs to register with the receiver: the Issuer URL and the JWKS URL, and the discovery URL for receivers that take one instead. Synqly composes all three from the deployment's base URL and the integration ID, so they always agree with each other."}},"httpPath":"/v1/ssf/transmitter/urls"}]},{"type":"group","label":"Storage","link":"/api-reference/connectors/storage","routeSlug":"/api-reference/connectors/storage","items":[{"label":"List Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/storage/storage_list_files","routeSlug":"/api-reference/connectors/storage/storage_list_files","metadata":{"seo":{"title":"List Files","description":"Returns a list of contents from the token-linked Integration."}},"httpPath":"/v1/storage/folders/{path}"},{"label":"Upload File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/storage/storage_upload_file","routeSlug":"/api-reference/connectors/storage/storage_upload_file","metadata":{"seo":{"title":"Upload File","description":"Uploads a file from the provided {path} to the token-linked Integration."}},"httpPath":"/v1/storage/files/{path}"},{"label":"Download File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/storage/storage_download_file","routeSlug":"/api-reference/connectors/storage/storage_download_file","metadata":{"seo":{"title":"Download File","description":"Downloads a file from the provided {path} in the token-linked Integration."}},"httpPath":"/v1/storage/files/{path}"},{"label":"Delete File","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/storage/storage_delete_file","routeSlug":"/api-reference/connectors/storage/storage_delete_file","metadata":{"seo":{"title":"Delete File","description":"Deletes a file from the provided {path} in the token-linked Integration."}},"httpPath":"/v1/storage/files/{path}"}]},{"type":"group","label":"Threat Intelligence (In Development)","link":"/api-reference/connectors/threatintel","routeSlug":"/api-reference/connectors/threatintel","items":[{"label":"Lookup Hash","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/threatintel/threatintel_lookup_hash","routeSlug":"/api-reference/connectors/threatintel/threatintel_lookup_hash","metadata":{"seo":{"title":"Lookup Hash","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/threat-intel/lookup/hash"},{"label":"Lookup URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/threatintel/threatintel_lookup_url","routeSlug":"/api-reference/connectors/threatintel/threatintel_lookup_url","metadata":{"seo":{"title":"Lookup URL","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/threat-intel/lookup/url"},{"label":"Lookup Domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/threatintel/threatintel_lookup_domain","routeSlug":"/api-reference/connectors/threatintel/threatintel_lookup_domain","metadata":{"seo":{"title":"Lookup Domain","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/threat-intel/lookup/domain"},{"label":"Lookup IP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/threatintel/threatintel_lookup_ip","routeSlug":"/api-reference/connectors/threatintel/threatintel_lookup_ip","metadata":{"seo":{"title":"Lookup IP","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/threat-intel/lookup/ip"}]},{"type":"group","label":"Ticketing","link":"/api-reference/connectors/ticketing","routeSlug":"/api-reference/connectors/ticketing","items":[{"label":"List Remote Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_remote_fields","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_remote_fields","metadata":{"seo":{"title":"List Remote Fields","description":"List all remote fields for all Projects in a ticketing integration. The response will include a list of fields for each issue type in the ticketing provider."}},"httpPath":"/v1/ticketing/remote-fields"},{"label":"List Issue Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_issue_types","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_issue_types","metadata":{"seo":{"title":"List Issue Types","description":"List issue types for the specified project."}},"httpPath":"/v1/ticketing/issue-types/{projectId}"},{"label":"List Issue Type Remote Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_issue_type_remote_fields","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_issue_type_remote_fields","metadata":{"seo":{"title":"List Issue Type Remote Fields","description":"Lists the remote fields available when creating a ticket in the specified project, using the specified issue type."}},"httpPath":"/v1/ticketing/remote-fields/{projectId}/{issueTypeId}"},{"label":"List Projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_projects","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_projects","metadata":{"seo":{"title":"List Projects","description":"Returns a list of Projects from the token-linked Integration. Tickets must be created and retrieved within the context of a specific Project."}},"httpPath":"/v1/ticketing/projects"},{"label":"Query Tickets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_query_tickets","routeSlug":"/api-reference/connectors/ticketing/ticketing_query_tickets","metadata":{"seo":{"title":"Query Tickets","description":"Returns a list of Ticket objects from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets"},{"label":"Create Ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_create_ticket","routeSlug":"/api-reference/connectors/ticketing/ticketing_create_ticket","metadata":{"seo":{"title":"Create Ticket","description":"Creates a Ticket object in the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets"},{"label":"Get Ticket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_get_ticket","routeSlug":"/api-reference/connectors/ticketing/ticketing_get_ticket","metadata":{"seo":{"title":"Get Ticket","description":"Returns a Ticket object matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}"},{"label":"Patch Ticket","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_patch_ticket","routeSlug":"/api-reference/connectors/ticketing/ticketing_patch_ticket","metadata":{"seo":{"title":"Patch Ticket","description":"Updates the Ticket object matching {ticketId} in the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}"},{"label":"Create Attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_create_attachment","routeSlug":"/api-reference/connectors/ticketing/ticketing_create_attachment","metadata":{"seo":{"title":"Create Attachment","description":"[beta: currently supported by Jira] Creates an Attachment for the ticket with id {ticketId} in the token-linked Integration."}},"httpPath":"/v1/ticketing/attachments/{ticketId}"},{"label":"List Attachments Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_attachments_metadata","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_attachments_metadata","metadata":{"seo":{"title":"List Attachments Metadata","description":"[beta: currently supported by Jira] Returns metadata for all Attachments for a Ticket object matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/attachments/{ticketId}"},{"label":"Download Attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_download_attachment","routeSlug":"/api-reference/connectors/ticketing/ticketing_download_attachment","metadata":{"seo":{"title":"Download Attachment","description":"[beta: currently supported by Jira] Downloads the Attachment object matching {attachmentId} for the Ticket matching {tickedId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/attachments/{ticketId}/{attachmentId}/download"},{"label":"Delete Attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_delete_attachment","routeSlug":"/api-reference/connectors/ticketing/ticketing_delete_attachment","metadata":{"seo":{"title":"Delete Attachment","description":"[beta: currently supported by Jira] Deletes the Attachment object matching {attachmentId} for the Ticket matching {tickedId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/attachments/{ticketId}/{attachmentId}"},{"label":"List Comments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_comments","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_comments","metadata":{"seo":{"title":"List Comments","description":"Lists all comments for the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/comments"},{"label":"Create Comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_create_comment","routeSlug":"/api-reference/connectors/ticketing/ticketing_create_comment","metadata":{"seo":{"title":"Create Comment","description":"Creates a comment on the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/comments"},{"label":"Delete Comment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_delete_comment","routeSlug":"/api-reference/connectors/ticketing/ticketing_delete_comment","metadata":{"seo":{"title":"Delete Comment","description":"Deletes the comment matching {commentId} form the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/comments/{commentId}"},{"label":"Create Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_create_note","routeSlug":"/api-reference/connectors/ticketing/ticketing_create_note","metadata":{"seo":{"title":"Create Note","description":"Creates a note on the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/notes"},{"label":"List Notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_notes","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_notes","metadata":{"seo":{"title":"List Notes","description":"Lists all notes for the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/notes"},{"label":"Delete Note","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_delete_note","routeSlug":"/api-reference/connectors/ticketing/ticketing_delete_note","metadata":{"seo":{"title":"Delete Note","description":"Deletes the note matching {noteId} form the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/notes/{noteId}"},{"label":"Patch Note","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_patch_note","routeSlug":"/api-reference/connectors/ticketing/ticketing_patch_note","metadata":{"seo":{"title":"Patch Note","description":"Update a note matching {noteId} title and/or content on the ticket matching {ticketId} from the token-linked Integration."}},"httpPath":"/v1/ticketing/tickets/{ticketId}/notes/{noteId}"},{"label":"Query Escalation Policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_query_escalation_policies","routeSlug":"/api-reference/connectors/ticketing/ticketing_query_escalation_policies","metadata":{"seo":{"title":"Query Escalation Policies","description":"Returns a list of escalation policies."}},"httpPath":"/v1/ticketing/escalation-policies"},{"label":"List On Call Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/ticketing/ticketing_list_on_call","routeSlug":"/api-reference/connectors/ticketing/ticketing_list_on_call","metadata":{"seo":{"title":"List On Call Agents","description":"Returns a list of all on-call agents for an escalation policy."}},"httpPath":"/v1/ticketing/escalation-policies/{escalationPolicyId}/on-call"}]},{"type":"group","label":"Vulnerabilities","link":"/api-reference/connectors/vulnerabilities","routeSlug":"/api-reference/connectors/vulnerabilities","items":[{"label":"Query Findings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_findings","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_findings","metadata":{"seo":{"title":"Query Findings","description":"Query vulnerability findings"}},"httpPath":"/v1/vulnerabilities/findings"},{"label":"Create Findings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_create_findings","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_create_findings","metadata":{"seo":{"title":"Create Findings","description":"Create findings (bulk) in a vulnerability scanning system"}},"httpPath":"/v1/vulnerabilities/findings/bulk"},{"label":"Update Finding","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_update_finding","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_update_finding","metadata":{"seo":{"title":"Update Finding","description":"update a finding in a vulnerability scanning system"}},"httpPath":"/v1/vulnerabilities/findings/{findingId}"},{"label":"Query Assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_assets","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_assets","metadata":{"seo":{"title":"Query Assets","description":"Query assets in a vulnerability scanning system"}},"httpPath":"/v1/vulnerabilities/assets"},{"label":"Create Asset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_create_asset","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_create_asset","metadata":{"seo":{"title":"Create Asset","description":"Create assets in a vulnerability scanning system"}},"httpPath":"/v1/vulnerabilities/assets"},{"label":"Update Asset","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_update_asset","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_update_asset","metadata":{"seo":{"title":"Update Asset","description":"update an asset in a vulnerability scanning system"}},"httpPath":"/v1/vulnerabilities/assets/{assetId}"},{"label":"Query Scans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_scans","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_scans","metadata":{"seo":{"title":"Query Scans","description":"Query scans in a vulnerability scanning system"}},"httpPath":"/v1/vulnerabilities/scans"},{"label":"Upload Scan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_upload_scan","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_upload_scan","metadata":{"seo":{"title":"Upload Scan","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/vulnerabilities/scans"},{"label":"Get Scan Activity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_scan_activity","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_scan_activity","metadata":{"seo":{"title":"Get Scan Activity","description":"Deprecated: use GET /scans/{scan_id}/activities instead, which returns the full execution history for a scan definition."}},"httpPath":"/v1/vulnerabilities/scans/{scan_id}/activity"},{"label":"Get Scan Activities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_scan_activities","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_scan_activities","metadata":{"seo":{"title":"Get Scan Activities","description":"Get scan execution history for a configured scan. Returns one OCSF Scan Activity per execution (e.g. each Tenable.sc scan result for the given scan definition id)."}},"httpPath":"/v1/vulnerabilities/scans/{scan_id}/activities"},{"label":"Get Scan Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_scan_status","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_scan_status","metadata":{"seo":{"title":"Get Scan Status","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/vulnerabilities/scans/{scan_id}/status"},{"label":"Get Labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_labels","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_get_labels","metadata":{"seo":{"title":"Get Labels","description":"Get labels from an asset inventory system"}},"httpPath":"/v1/vulnerabilities/labels"},{"label":"Query Scan Findings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_scan_findings","routeSlug":"/api-reference/connectors/vulnerabilities/vulnerabilities_query_scan_findings","metadata":{"seo":{"title":"Query Scan Findings","description":"This operation is actively being developed. Breaking changes should beexpected.Please contact us before using this operation."}},"badges":[{"name":"Alpha","color":"in-development","position":"before"}],"httpPath":"/v1/vulnerabilities/scans/{scanId}/findings"}]}]}]}