CiscoWebexEventCollector
Cisco Webex Event Collector fetches Events and Admin Audit Events and Security Audit Events.
Analytics & SIEM · Cisco Webex Teams
Details
| ID | CiscoWebexEventCollector |
|---|---|
| Provider | Cisco Systems |
| Category | Analytics & SIEM |
| From Version | 6.12.0 |
| Docker Image | demisto/python3:3.12.13.10116658 |
| Supported Modules | Agentix XSIAM |
README
Cisco Webex Event Collector fetches Events and Admin Audit Events and Security Audit Events.
This integration was integrated and tested with version 1 of CiscoWebex API.
Configure Cisco Webex Event Collector on Cortex XSOAR
- Navigate to Settings > Automation & Feed Integrations.
- Search for Cisco Webex Event Collector.
-
Click Add instance to create and configure a new integration instance.
Parameter Description Required URL True Admin APP Client ID Admin APP Client ID and Secret. True Admin APP Client Secret True Admin APP Redirect URI True Admin Org Id True Compliance Officer Client ID Compliance Officer Client ID and Secret. True Compliance Officer Client Secret True Compliance Officer Redirect URI True Trust any certificate (not secure) False Use system proxy settings False Fetch security audit events To fetch security audit events, the Pro Pack must be installed on the Webex instance, and Allow user authentication data must be enabled. See the note below. False Maximum number of events per fetch False
4.
1. Run the cisco-webex-oauth-start command with the user argument - you will be prompted to sign in to Cisco Webex with your username and password. (make sure you sign in with the same user as you defined in the user argument admin or compliance officer). You will then be redirected to the redirect URI you defined in the application. The URL will contain a query parameter called code. The value of this query parameter will be used in the next command.
2. Run the cisco-webex-oauth-complete command with the user and code arguments The user argument should be set to the same value as in the previous command (admin or compliance officer). The code argument should be set to the value returned in the code query parameter from the previous command.
3. Run the cisco-webex-oauth-test command with the user argument. The user argument should be set to the same value as in the previous command (admin or compliance officer) to ensure connectivity to Cisco Webex.
Note: To fetch security audit events, the Pro Pack must be installed on the Webex instance. Additionally, the Allow user authentication data setting must be enabled:
Go to Management > Organization Settings.
In the User authentication data section, toggle Allow user authentication data ON.
For more details, refer to the [official documentation.](https://help.webex.com/en-us/article/pf66vg/Log-and-analyze-user-sign-ins-and-sign-outs)
Commands
You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
cisco-webex-oauth-start
Use this command to start the authorization process. In order to authorize the instance, first run the command, and complete the process in the URL that is returned. You will then be redirected to the callback URL where you will copy the authorization code found in the query parameter code, and paste that value in the command !cisco-webex-oauth-complete as an argument to finish the process.
Base Command
cisco-webex-oauth-start
Input
| Argument Name | Description | Required |
|---|---|---|
| user | The user to start authorization. Possible values are: admin, compliance_officer. | Required |
Context Output
There is no context output for this command.
cisco-webex-oauth-complete
Use this command to complete the authorization process. After copying the authorization code found in the query parameter code of the callback URL, paste the value in the command as an argument to finish the process.
Base Command
cisco-webex-oauth-complete
Input
| Argument Name | Description | Required |
|---|---|---|
| user | The user to complete authorization. Possible values are: admin, compliance_officer. | Required |
| code | The authorization code retrieved from the callback URL according to the documentation. | Required |
Context Output
There is no context output for this command.
cisco-webex-oauth-test
Use this command to complete the authorization process. After copying the authorization code found in the query parameter code of the callback URL, paste the value in the command as an argument to finish the process.
Base Command
cisco-webex-oauth-test
Input
| Argument Name | Description | Required |
|---|---|---|
| user | The user to complete authorization. Possible values are: admin, compliance_officer. | Required |
Context Output
There is no context output for this command.
cisco-webex-get-admin-audit-events
Gets admin audit events from Cisco Webex.
Base Command
cisco-webex-get-admin-audit-events
Input
| Argument Name | Description | Required |
|---|---|---|
| should_push_events | If true, the command will create events, otherwise it will only display them. Possible values are: true, false. Default is false. | Required |
| limit | Maximum number of events to return. | Optional |
| since_datetime | Date in ISO format (2023-10-01T20:33:22.123Z) to return events from. | Optional |
Human Readable Output
Admin Audit Events
| _time | actorId | actorOrgId | created | data | id | source_log_type |
|---|---|---|---|---|---|---|
| 2023-11-02T09:33:26.408Z | 444444 | 222222 | 2023-11-02T09:33:26.408Z | actorOrgName: panw targetName: panw operationType: CREATE eventDescription: An org setting was created or updated. actorName: admin@example.com actorEmail: admin@example.com settingKey: release_migration settingName: release_migration settingValue: “MIGRATED” trackingId: 111111 previousValue: Null targetType: ORG targetId: 222222 actorUserAgent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/2.2.2.2 Safari/537.36 eventCategory: ORG_SETTINGS actorIp: 1.1.1.1 targetOrgId: 222222 actionText: admin@example.com has modified the value of setting release_migration for ORG “panw”. New value = “MIGRATED”, Previous value = Null. entityType: ORG targetOrgName: panw |
333333 | Admin Audit Events |
Context Output
There is no context output for this command.
cisco-webex-get-security-audit-events
Gets security audit events from Cisco Webex.
Base Command
cisco-webex-get-security-audit-events
Input
| Argument Name | Description | Required |
|---|---|---|
| should_push_events | If true, the command will create events, otherwise it will only display them. Possible values are: true, false. Default is false. | Required |
| limit | Maximum number of events to return. | Optional |
| since_datetime | Date in ISO format (2023-10-01T20:33:22.123Z) to return events from. | Optional |
Human Readable Output
Security Audit Events
| _time | actorId | actorOrgId | created | data | id | source_log_type |
|---|---|---|---|---|---|---|
| 2023-12-19T07:01:26.486Z | 444444 | 222222 | 2023-12-19T07:01:26.486Z | actorOrgName: panw eventDescription: A user attempted logging in actorName: admin@example.com actorEmail: admin@example.com authenticationMethod: Non-Interactive trackingId: 123456 eventStatus: SUCCESS actorOauthClient: 111111 actorUserAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 eventCategory: LOGINS actorIp: 1.1.1.1 actorClientName: Developer Portal actionText: admin@example.com attempted logging into panw using client (Developer Portal) and Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36. Login status: SUCCESS. failedReason: |
333333 | Security Audit Events |
Context Output
There is no context output for this command.
cisco-webex-get-compliance-officer-events
Gets events from Cisco Webex.
Base Command
cisco-webex-get-compliance-officer-events
Input
| Argument Name | Description | Required |
|---|---|---|
| should_push_events | If true, the command will create events, otherwise it will only display them. Possible values are: true, false. Default is false. | Required |
| limit | Maximum number of events to return. | Optional |
| since_datetime | Date in ISO format (2023-10-01T20:33:22.123Z) to return events from. | Optional |
Human Readable Output
Events
| _time | actorId | created | data | id | resource | source_log_type | type |
|---|---|---|---|---|---|---|---|
| 2023-11-05T13:33:46.417Z | 222222 | 2023-11-05T13:33:46.417Z | id: 333333 roomId: 444444 roomType: group personId: 222222 personEmail: jsmith@example.com personDisplayName: Kfir Testman personOrgId: 555555 isModerator: false isMonitor: false isRoomHidden: false created: 2023-11-05T13:33:46.417Z |
111111 | memberships | Events | created |
Context Output
There is no context output for this command.
Configuration parameters
base_url— URL (required)admin_credentials— Admin APP Client ID (required)admin_app_redirect_uri— Admin APP Redirect URI (required)admin_org_id— Admin Org Id (required)compliance_officer_credentials— Compliance Officer Client ID (required)compliance_officer_redirect_uri— Compliance Officer Redirect URI (required)insecure— Trust any certificate (not secure)proxy— Use system proxy settingsfetch_security_audit_events— Fetch security audit eventsmax_fetch— Maximum number of events per fetch
Commands (6)
-
cisco-webex-get-admin-audit-eventsGets admin audit events from Cisco Webex.
-
cisco-webex-get-compliance-officer-eventsGets events from Cisco Webex.
-
cisco-webex-get-security-audit-eventsGets security audit events from Cisco Webex.
-
cisco-webex-oauth-completeUse this command to complete the authorization process. After copying the authorization code found in the query parameter `code` of the callback URL, paste the value in the command as an argument to finish the process.
-
cisco-webex-oauth-startUse this command to start the authorization process. In order to authorize the instance, first run the command, and complete the process in the URL that is returned. You will then be redirected to the callback URL where you will copy the authorization code found in the query parameter `code`, and paste that value in the command `!cisco-webex-oauth-complete` as an argument to finish the process.
-
cisco-webex-oauth-testUse this command to complete the authorization process. After copying the authorization code found in the query parameter `code` of the callback URL, paste the value in the command as an argument to finish the process.
category: Analytics & SIEM provider: Cisco Systems sectionorder: - Connect - Collect commonfields: id: CiscoWebexEventCollector version: -1 configuration: - display: URL name: base_url defaultvalue: 'https://webexapis.com' required: true type: 0 section: Connect - name: admin_credentials display: Admin APP Client ID required: true type: 9 additionalinfo: Admin APP Client ID and Secret. displaypassword: Admin APP Client Secret section: Connect - display: Admin APP Redirect URI name: admin_app_redirect_uri required: true type: 0 section: Connect - display: Admin Org Id name: admin_org_id required: true type: 0 section: Connect - name: compliance_officer_credentials display: Compliance Officer Client ID required: true type: 9 additionalinfo: Compliance Officer Client ID and Secret. displaypassword: Compliance Officer Client Secret section: Connect - display: Compliance Officer Redirect URI name: compliance_officer_redirect_uri required: true type: 0 section: Connect - display: Trust any certificate (not secure) name: insecure required: false type: 8 section: Connect advanced: true - display: Use system proxy settings name: proxy required: false type: 8 section: Connect advanced: true - display: Fetch security audit events additionalinfo: In order to fetch security audit events, pro pack needs to be installed on the Webex instance. name: fetch_security_audit_events required: false type: 8 section: Collect - defaultvalue: 200 display: Maximum number of events per fetch name: max_fetch required: false type: 0 section: Collect advanced: true description: Cisco Webex Event Collector fetches Events and Admin Audit Events and Security Audit Events. display: Cisco Webex Event Collector name: CiscoWebexEventCollector script: commands: - arguments: - auto: PREDEFINED description: The user to start authorization. name: user predefined: - 'admin' - 'compliance_officer' required: true description: Use this command to start the authorization process. In order to authorize the instance, first run the command, and complete the process in the URL that is returned. You will then be redirected to the callback URL where you will copy the authorization code found in the query parameter `code`, and paste that value in the command `!cisco-webex-oauth-complete` as an argument to finish the process. name: cisco-webex-oauth-start - arguments: - auto: PREDEFINED description: The user to complete authorization. name: user predefined: - 'admin' - 'compliance_officer' required: true - description: The authorization code retrieved from the callback URL according to the documentation. name: code required: true description: Use this command to complete the authorization process. After copying the authorization code found in the query parameter `code` of the callback URL, paste the value in the command as an argument to finish the process. name: cisco-webex-oauth-complete - arguments: - auto: PREDEFINED description: The user to complete authorization. name: user predefined: - 'admin' - 'compliance_officer' required: true description: Use this command to complete the authorization process. After copying the authorization code found in the query parameter `code` of the callback URL, paste the value in the command as an argument to finish the process. name: cisco-webex-oauth-test - arguments: - auto: PREDEFINED defaultValue: 'false' description: If true, the command will create events, otherwise it will only display them. name: should_push_events predefined: - 'true' - 'false' required: true - description: Maximum number of events to return. name: limit - description: Date in ISO format (2023-10-01T20:33:22.123Z) to return events from. name: since_datetime description: Gets admin audit events from Cisco Webex. name: cisco-webex-get-admin-audit-events - arguments: - auto: PREDEFINED defaultValue: 'false' description: If true, the command will create events, otherwise it will only display them. name: should_push_events predefined: - 'true' - 'false' required: true - description: Maximum number of events to return. name: limit - description: Date in ISO format (2023-10-01T20:33:22.123Z) to return events from. name: since_datetime description: Gets security audit events from Cisco Webex. name: cisco-webex-get-security-audit-events - arguments: - auto: PREDEFINED defaultValue: 'false' description: If true, the command will create events, otherwise it will only display them. name: should_push_events predefined: - 'true' - 'false' required: true - description: Maximum number of events to return. name: limit - description: Date in ISO format (2023-10-01T20:33:22.123Z) to return events from. name: since_datetime description: Gets events from Cisco Webex. name: cisco-webex-get-compliance-officer-events dockerimage: demisto/python3:3.12.13.10116658 isfetchevents: true runonce: false script: '' subtype: python3 type: python "marketplaces": ["marketplacev2", "platform"] fromversion: 6.12.0 tests: - No tests (auto formatted) supportedModules: - xsiam