{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/ac5e908c-3245-3ba5-9e49-5ab5d54d743e","info":{"title":"Cisco Secure Access Third-Party Integrations API","version":"1.0.1","description":"Create and manage the third-party applications integrated with Secure Access.\nSecure Access integrates with third-party applications, which support either REST APIs or Webhooks.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Integrations","description":"Integration management"},{"name":"Credentials","description":"Credential management"},{"name":"Integration Types","description":"Integration types"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/third-party-integrations-overview.md","uri":"secure-access-api-reference-third-party-integrations-overview"}},"openapi":"3.0.3","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.integrations:write":"Update, delete third-party integrations","admin.integrations:read":"Read third-party integrations"}}}}}},"spec":{"type":"object","description":"The properties used to update the integration.","properties":{"intuneConfig":{"type":"object","description":"The properties used to create or update the Azure AD application.","properties":{"clientCredentialId":{"description":"The Azure AD client ID.","type":"string","example":"credentialid1","$$ref":"#/components/schemas/clientCredentialIdIntune"},"clientCredentialSecret":{"description":"The Azure AD client secret.","type":"string","example":"credentialsecret1","$$ref":"#/components/schemas/clientCredentialSecretIntune"},"clientCredentialTokenUrl":{"description":"The OAuth 2.0 token endpoint URL for the authentication of the Azure AD application.","type":"string","example":"tokenauthurl@abc.com","$$ref":"#/components/schemas/clientCredentialTokenUrlIntune"}},"example":{"clientCredentialId":"intune-client-123","clientCredentialSecret":"secret-value","clientCredentialTokenUrl":"https://login.microsoftonline.com/tenant/oauth2/v2.0/token"},"$$ref":"#/components/schemas/IntuneConfigInput"},"jamfConfig":{"type":"object","description":"The configuration properties used to create or update the Jamf Pro integration.","properties":{"clientCredentialId":{"description":"The Jamf Pro client ID.","type":"string","example":"credentialid1","$$ref":"#/components/schemas/clientCredentialIdJamf"},"clientCredentialSecret":{"description":"The Jamf Pro client secret.","type":"string","example":"credentialsecret1","$$ref":"#/components/schemas/clientCredentialSecretJamf"},"url":{"description":"The base URL of the integration.","type":"string","example":"https://company.jamfcloud.com","$$ref":"#/components/schemas/url"}},"example":{"clientCredentialId":"jamf-client-789","clientCredentialSecret":"jamf-secret","url":"https://company.jamfcloud.com"},"$$ref":"#/components/schemas/JamfConfigInput"},"name":{"description":"The name of the integration.","maxLength":250,"minLength":1,"type":"string","example":"new name for integration"},"securityEventsConfig":{"type":"object","description":"The properties used to modify the configuration of the security events.","additionalProperties":false,"properties":{"connections":{"description":"The list of webhook connections. Each connection defines a webhook and delivery format.","type":"array","nullable":true,"items":{"type":"object","required":["targetId","format"],"properties":{"format":{"description":"The label that describes the format of the outbound security event.","enum":["secureaccess.events.security.splunk-hec.v1","secureaccess.events.security.cloudevents.v1"],"example":"secureaccess.events.security.cloudevents.v1","type":"string","$$ref":"#/components/schemas/format"},"targetId":{"description":"The ID of the Webhook.v1 integration that receives the security events.","example":"webhook.v1:abc123","type":"string","$$ref":"#/components/schemas/targetId"}},"example":{"format":"secureaccess.events.security.cloudevents.v1","targetId":"webhook.v1:abc123"},"$$ref":"#/components/schemas/SecurityEventsConnectionInput"}},"sources":{"type":"array","items":{"type":"string","description":"The label for the event source."},"description":"The list of event sources that the system will monitor. Use `all` to monitor all available event sources.","example":["all"]},"targets":{"type":"array","items":{"type":"string","description":"The unique identifier for the webhook.v1 integration."},"description":"The list of unique identifiers for the webhook.v1 integrations.\nThese webhook.v1 integrations will receive the security events from Secure Access.\nThe `targets` field must contain at least one unique identifier for a webhook.v1 integration.","example":["webhook.v1:abc123","webhook.v1:def456"]}},"$$ref":"#/components/schemas/SecurityEventsConfigPatchInput"},"webhookConfig":{"type":"object","description":"The properties used to create or update the Webhook integration.","properties":{"headers":{"additionalProperties":{"type":"string","description":"The HTTP headers for the Webhook integration."},"type":"object","$$ref":"#/components/schemas/headers"},"queryParams":{"type":"object","description":"The query parameters for the Webhook integration.","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/queryParams"},"url":{"description":"The URL of the Webhook integration for receiving notifications.","type":"string","example":"https://api.company.com/webhook/integration-events","$$ref":"#/components/schemas/urlWebHook"}},"example":{"url":"https://api.company.com/webhook","headers":{"Content-Type":"application/json"},"queryParams":{"source":"integration-service"}},"$$ref":"#/components/schemas/WebhookConfigInput"}},"example":{"name":"Updated Integration Name","webhookConfig":{"url":"https://api.newcompany.com/webhook","headers":{"Content-Type":"application/json"}}},"$$ref":"#/components/schemas/PatchInputBody","title":"PatchInputBody"}}