Skip to main content

Webex Source

webex-logo

Cisco Webex is a cloud-based video conferencing and collaboration product suite, which comprises software including Webex Meetings, Webex Teams, and Webex Devices. This Webex source collects admin audit events and webhooks (meetings, rooms, messages, and memberships) data and sends it to Sumo Logic.

Data Source

Set up and Configuration

In this configuration, you will create a new Webex Integration App in Webex Develops Portal and generate a Client ID, Client Secret, and OAuth 2.0 authorization code.

Create a New Webex Integration app

A Webex Integration app with specific permissions is required for Sumo Logic to access Admin Audit Events from Webex. Follow the below instructions to create a new Webex Integration app.

  1. Sign in to Webex Developers Portal using your admin account.
  2. Click on your profile in the top right corner, and select My Webex Apps.
    my-webex-apps
  3. Click Create a New App.
    create-a-new-app
  4. Select Create an Integration and add the integration information.
    create-integration
    • Integration name. Name of the integration (example: Sumo-C2C).
    • Icon. Select an icon, either from default images or upload an image of your choice.
    • App Hub Description. Description of the app (example: This App will be used for Sumo Logic Integration to collect Admin Audit Events).
    • Redirect URI(s). Required to use https://localhost.
    • Scopes. Check audit:events_read (only scope required for collecting admin audit events).
  5. Now click Add Integration at the bottom of the page.
    add-integration
  6. Copy and save the Client ID and Client Secret.
  7. Copy and save the OAuth Authorization URL.
    oauth-authorization

OAuth 2.0 Authorization Code

Follow the below instructions to generate OAuth 2.0 Authorization Code.

  1. In a web browser, open a new tab and paste the OAuth Authorization URL that was copied from the earlier steps and click Enter.
  2. It prompted, sign in to your admin Webex account.
  3. Click Accept.
    accept-page
  4. Ignore the error message in the webpage.
    code-url
    Copy and save the code in the URL, as shown in the following example.
    https://localhost/?code={{REDACTED_AUTHORIZATION_CODE}}&state=set_state_here

Organization ID

Follow the below instructions to colllect your Organization ID.

  1. Sign in to Webex Control Hub Portal using your admin account.
  2. In the Management menu, select Account.
  3. Navigate to the Info tab.
  4. Copy and save the Organization ID.
    organization-id

States

Webex Source is a device security platform that discover devices, tracks behavior, detects threats, and takes action to protect your business. When you create an Webex Source, it goes through the following stages:

  1. Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
  2. Started. A collection task is created on the Hosted Collector.
  3. Initialized. The task configuration is complete in Sumo Logic.
  4. Authenticated. The Source successfully authenticated with Webex.
  5. Collecting. The Source is actively collecting data from Webex.

If the Source has any issues during any one of these states, it is placed in an Error state.

When you delete the source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector. On the Collection page, the Health and Status for Sources is displayed. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

Create Webex Source

When you create an Webex source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure an Webex source:

  1. In Sumo Logic, select Manage Data > Collection > Collection
  2. On the Collection page, click Add Source next to a Hosted Collector.
  3. Search for and select Webex.
    webex-icon
  4. Enter a Name for the Source. The description is optional.
    webex-config-main.png
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
    • green check circle.png A green circle with a check mark is shown when the field exists in the Fields table schema.
    • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
  7. Client ID. Enter the Client ID collected from the new Webex Integration app.
  8. Client Secret. Enter the Client Secret collected from the new Webex Integration app.
  9. OAuth 2.0 Authorization Code. Enter the OAuth 2.0 Authorization Code collected from the URL.
  10. Organization ID. Enter the Org ID fcollected from the Webex Control Hub PortalURL.
  11. Select Event Categories for Audit Logs. You have the option to Collect all events or Select events, where you can specify the exact event categories you would like to collect from the admin audit logs. You can also select from the pre-defined list or type in event categories.
  12. Click Save.

Error Types

When Sumo Logic detects an issue, it is tracked by Health Events. The following table shows the three possible error types, the reason for the error, if the source attempts to retry, and the name of the event log in the Health Event Index.

TypeReasonRetriesRetry BehaviorHealth Event Name
ThirdPartyConfigNormally due to an invalid configuration. You'll need to review your Source configuration and make an update.No retries are attempted until the Source is updated.Not applicableThirdPartyConfigError
ThirdPartyGenericNormally due to an error communicating with the third-party service APIs.YesThe Source will retry indefinitely.ThirdPartyGenericError
FirstPartyGenericNormally due to an error communicating with the internal Sumo Logic APIs.YesThe Source will retry indefinitely.FirstPartyGenericError

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

  1. Open the Collection page, and go to Manage Data > Collection > Collection.
  2. Select the source and click the information icon on the right side of the row.
  3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
    restart-source-button
  4. Click Confirm to send the restart request.
    restart-source-confirm
  5. The bottom left of the platform will provide a notification informing you the request was successful.
    restart-source-initiated

API

To restart your source using the Sumo Management API, follow the instructions below:

  • Method: POST
  • Example endpoint:
    https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

JSON Configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

ParameterTypeRequiredDescriptionAccess
configJSON ObjectYesContains the configuration-parameters of the Source.n/a
schemaRefJSON ObjectYesUse {"type":"Webex"} for Webex Source.not modifiable
sourceTypeStringYesUse Universal for Webex Source.not modifiable

Config Parameters

ParameterTypeRequiredDescriptionAccess
nameStringYesType the desired name of the Source and it must be unique per Collector. This value is assigned to the metadata field _sourcemodifiable
descriptionStringNoType the description of the Source.modifiable
categoryStringNoType the category of the source. This value is assigned to the metadata field _sourceCategory.modifiable
fieldsJSON ObjectNoJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.modifiable
clientIdStringYesClient ID of the Webex Integration created for Sumo Logic from the new Webex Integration app.modifiable
clientSecretStringYesClient Secret of the Webex Integration created for Sumo Logic from the new Webex Integration app.modifiable
codeStringYesCode of the Webex Integration created for Sumo Logic.modifiable
orgIdStringYesOrgaization Id of the customers Webex account from where you want to collect the audit event from.modifiable

JSON Example

{
"api.version":"v1",
"source":{
"config":{
"name":"Webex- sandbox",
"authorizationCode":"********",
"clientId":"********",
"collectAll":false,
"orgId":"********",
"eventCategories":["LOGINS","LOGOUT","ORG_SETTINGS"],
"fields":{
"_siemForward":false
},
"clientSecret":"********",
"category":"sandbox/webex/audit"
},
"schemaRef":{
"type":"Webex"
},
"state":{
"state":"Pending"
},
"sourceType":"Universal"
}
}
Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.