Integration - Cloud Security API

{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/eace9409ffd11b915a153976d7c4159c4dd78740/ac5e908c-3245-3ba5-9e49-5ab5d54d743e","info":{"title":"Cisco Secure Access Third-Party Integrations API","version":"1.0.0","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 of the integrated third-party application.","properties":{"createdAt":{"description":"The date and time when the system created the integration.","format":"date-time","type":"string","example":"2024-01-15T10:30:00Z","$$ref":"#/components/schemas/integrationCreatedAt"},"createdBy":{"description":"The username of the administrator who created the integration.","type":"string","example":"user@admin.com","$$ref":"#/components/schemas/integrationCreatedBy"},"createdFromIp":{"type":"string","description":"The IP address of the device or network where the integration was created.","example":"192.168.1.100","$$ref":"#/components/schemas/createdFromIp"},"credentials":{"type":"array","description":"The list of credentials associated with the integration.","items":{"type":"object","description":"The properties of the credentials resource.","properties":{"createdAt":{"description":"The date and time when the system created the credentials for the integration.","format":"date-time","type":"string","example":"2024-01-15T10:30:00Z","$$ref":"#/components/schemas/credentialCreatedAt"},"createdBy":{"description":"The username of the administrator who created the credentials for the integration.","type":"string","example":"user@admin.com","$$ref":"#/components/schemas/credentialCreatedBy"},"createdFromIp":{"type":"string","description":"The IP address of the device or network where the integration was created.","example":"192.168.1.100","$$ref":"#/components/schemas/createdFromIp"},"href":{"description":"The URL for the credentials resource.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","$$ref":"#/components/schemas/credentialHref"},"name":{"description":"The name of the credentials.","type":"string","example":"credential one","$$ref":"#/components/schemas/credentialName"},"tags":{"type":"array","description":"The list of tags associated with the credentials.","items":{"type":"string","description":"The tag associated with the credentials."},"example":["credential one"],"$$ref":"#/components/schemas/credentialTags"},"type":{"description":"The authentication method used to obtain the credential.","enum":["google-service-account","basic-auth","piam-token","iroh-token"],"type":"string","example":"piam-token","$$ref":"#/components/schemas/credentialType"},"value":{"type":"object","description":"The properties of the value object in the credentials.","properties":{"href":{"description":"The URL for the credentials resource.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","$$ref":"#/components/schemas/credentialHref"},"password":{"description":"The password for the credential.","type":"string","example":"SecurePassword124!"},"serviceAccountId":{"description":"The ID of the Service Account.","type":"string","example":"service-account-123"},"serviceAccountKey":{"description":"The key for the Service Account.","type":"string","example":"-----BEGIN PRIVATE KEY-----\n MIIEvQ..."},"token":{"description":"The access token for the authentication of the credentials.","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"username":{"description":"The username associated with the credential.","type":"string"}},"example":{"username":"api_user","password":"secure_password123","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"},"$$ref":"#/components/schemas/credentialValue"}},"required":["href","name","type","value","tags","createdBy","createdAt","createdFromIp"],"example":{"createdBy":"admin@company.com","createdAt":"2024-01-15T10:30:00Z","createdFromIp":"10.1.1.50","href":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","name":"Database Credential","type":"basic-auth","tags":["database","production"],"value":{"username":"db_user","password":"encrypted_password"}},"$$ref":"#/components/schemas/Credential"},"$$ref":"#/components/schemas/credentials"},"href":{"description":"The URL for the integration.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123","$$ref":"#/components/schemas/integrationHref"},"intuneConfig":{"type":"object","description":"The configuration settings for the integration of 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"},"moduleInstanceId":{"description":"The unique ID for the Iroh module instance that manages the Intune integration.","type":"string","example":"iroh-jamf-instance","$$ref":"#/components/schemas/moduleInstanceIdIntune"}},"example":{"clientCredentialId":"intune-client-123","clientCredentialSecret":"secret-value","clientCredentialTokenUrl":"https://login.microsoftonline.com/tenant/oauth2/v2.0/token","moduleInstanceId":"iroh-module-456"},"$$ref":"#/components/schemas/IntuneConfig"},"jamfConfig":{"type":"object","description":"The configured settings for 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"},"moduleInstanceId":{"description":"The unique ID for the Iroh module instance that manages the Jamf Pro integration.","type":"string","example":"iroh-jamf-instance","$$ref":"#/components/schemas/moduleInstanceIdJamf"},"urlJamf":{"description":"The base URL of the Jamf Pro server.","type":"string","example":"https://company.jamfcloud.com","$$ref":"#/components/schemas/urlJamf"}},"example":{"clientCredentialId":"jamf-client-789","clientCredentialSecret":"jamf-secret","moduleInstanceId":"iroh-jamf-instance","url":"https://company.jamfcloud.com"},"$$ref":"#/components/schemas/JamfConfig"},"name":{"description":"The name of the integration.","maxLength":250,"minLength":1,"type":"string","example":"integration one","$$ref":"#/components/schemas/integrationName"},"region":{"description":"The region where the system deployed the integration.","type":"string","example":"us-west1","$$ref":"#/components/schemas/integrationRegion"},"securityEventsConfig":{"required":["sources"],"type":"object","description":"The properties of the security events third-party integration.","additionalProperties":false,"properties":{"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.","example":["webhook.v1:abc123","webhook.v1:def456"]}},"example":{"sources":["firewall","ravpn"],"targets":["webhook.v1:b7d60bae-6a69-4dd5-a9b3-be6662fd2930"]},"$$ref":"#/components/schemas/SecurityEventsConfig"},"status":{"description":"The status of the integration.","type":"string","enum":["active","created","inactive"],"example":"active","$$ref":"#/components/schemas/integrationStatus"},"tags":{"type":"array","description":"The list of tags associated with the integration.","items":{"type":"string","description":"The tag associated with the integration."},"example":["integration one"],"$$ref":"#/components/schemas/integrationTags"},"type":{"description":"The type of the integration.","enum":["chrome-enterprise.v1","webhook.v1","jamf.v1","intune.v1","security-events.v1"],"type":"string","example":"jamf.v1","$$ref":"#/components/schemas/integrationType"},"updatedFromIp":{"type":"string","description":"The IP address of the device or network where the integration was last updated.","example":"192.168.1.101","$$ref":"#/components/schemas/updatedFromIp"},"webhookConfig":{"type":"object","description":"The configuration settings for the Webhook integration.","required":["url"],"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","version":"v1"}},"$$ref":"#/components/schemas/WebhookConfig"}},"required":["href","name","type","createdBy","createdAt","createdFromIp","status"],"example":{"createdBy":"admin@company.com","createdAt":"2024-01-15T10:30:00Z","createdFromIp":"192.168.1.101","href":"https://api.sse.cisco.com/admin/v2/integrations/123","name":"Production Webhook","type":"webhook.v1","status":"active","region":"us-west-2","tags":["production","webhook"],"webhookConfig":{"url":"https://api.company.com/webhook","headers":{"Content-Type":"application/json"}}},"$$ref":"#/components/schemas/Integration","title":"Integration"}}