Integrating with Cisco Webex

  • Release version: Yokohama
  • Updated January 30, 2025
  • 9 minutes to read
  • Integrating your Software Asset Management application with Cisco Webex applications enable you to track your software subscriptions and reclaim unused licenses.

    The supported Cisco Webex applications are:
    • Webex Meetings
    • Webex Teams
    • Webex Training
    • Webex Events
    • Webex Support Session
    Important:
    Minimize security risks and protect information by granting access only to the necessary user or API permissions.
    Table 1. Minimal user permissions
    Process Required user role in the Cisco Webex application Authentication scopes
    Download subscriptions Read-only admin
    • spark-admin:licenses_read
    • spark-admin:people_read
    Pull user activity
    • Compliance Officer
    • Full admin
    • spark-compliance:events_read
    • meeting:admin_schedule_read
    Reclaim subscription Full admin
    • spark-admin:people_read
    • spark-admin:people_write

    Create a Webex Meetings OAuth application

    Create an OAuth integration application in Cisco Webex for Developers.

    Before you begin

    Webex Role required: Refer to the Minimal user permissions table.

    Procedure

    1. Login to Webex developer portal by using your Webex credentials.
    2. Select your profile icon and then select My Webex Apps.
    3. Navigate to Create a New App > Select Integration > Create an Integration.
    4. On the form, fill in the fields:
      Table 2. New Integration form
      Field Value
      Will This Integration Use A Mobile SDK? No
      Integration Name Name of your integration as it appears in Webex. For example, ServiceNow integration.
      Contact Email Email address of the administrator.
      Icon Icon to appear on the My Apps page. Either upload your own application icon or select one from the list of default icons.
      Description Description of your integration. For example, functionality of the integration and its benefits.
      Redirect URI The URI that will be redirected to when completing an OAuth grant flow.https://<instance>.service-now.com/oauth_redirect.do, where instance is the name of your ServiceNow instance.
      Scopes To access the integration APIs, you must select the meeting:admin_schedule_read scope.
    5. Select Add Integration.
    6. Copy and save the OAuth Client ID and OAuth Client Secret that appear for later use.

    Create a Webex Teams OAuth application

    Create an OAuth integration application in Cisco Webex for Developers.

    Before you begin

    Webex Role required: Refer to the Minimal user permissions table.

    Procedure

    1. Navigate and log in to Cisco Webex for Developers.
    2. Under the profile icon, select My Webex Apps.
    3. Navigate to Create a New App > Select Integration > Create an Integration.
    4. On the form, fill in the fields:
      Table 3. New Integration form
      Field Value
      Will This Integration Use A Mobile SDK? No
      Integration Name Name of your integration as it appears in Webex. For example, ServiceNow integration.
      Contact Email Email address of the administrator.
      Icon Icon to appear on the My Apps page. Either upload your own application icon or select one from the list of default icons.
      Description Description of your integration. For example, functionality of the integration and its benefits.
      Redirect URI The URI that will be redirected to when completing an OAuth grant flow.https://<instance>.service-now.com/oauth_redirect.do, where instance is the name of your ServiceNow instance.
      Scopes To access the integration APIs, you must select these scopes:
      • spark-admin:licenses_read
      • spark-admin:organizations_read
      • spark-admin:people_read
      • spark-admin:people_write
      • spark-admin:roles_read
      • spark-compliance:events_read
      • meeting:admin_schedule_read
    5. Select Add Integration.
    6. Copy and save the OAuth Client ID and OAuth Client Secret that appear for later use.

    Create a Webex integration profile

    Create an integration profile to track software subscriptions and optimize licensing for the Cisco Webex applications.

    Before you begin

    To create a Webex integration profile, request the Cisco Webex Meetings and Webex Teams spoke apps from the ServiceNow Store.

    ServiceNow Role required: admin or sam_integrator

    Important:
    You must select Cisco Webex Teams Spoke and Cisco Webex Meetings Spoke check boxes for this integration while installing optional features on the Application Manager page. For more information about choosing the required SaaS applications, see Request SaaS License Management.

    About this task

    If you’re using Software Asset Workspace, the option to create the Webex integration profile in Core UI is inactive.

    Procedure

    1. Navigate to the integration profile.
      InterfaceAction
      Core UI
      1. Navigate to All > Software Asset > SaaS License > Direct Integration Profiles.
      2. Select New.
      3. Select Webex Integration Profile.
      Software Asset Workspace
      1. Navigate to License operations > User Subscriptions > Direct integration profiles.
      2. Select New.
      3. Select Webex from the drop-down list.
      4. Select Continue.
    2. On the form, fill in the fields.
      Table 4. Integration profile form
      Field Description
      Display name Name of the profile.

      For example, Webex integration.

      Status Status of the integration profile.
      • If you haven’t published the integration profile, this field is automatically set to  Draft.
      • If you have already published the integration profile, this field is automatically set to  Published.
      Profile type Type of integration profile.

      This field is automatically set to Webex Subscription.

    3. Review the required user roles or API permissions specified in the Vendor configuration field for each process to minimize security risks and optimize SaaS licenses.
      Note:
      For more information, see Minimal user permissions table.
      1. In the Download Subscription Subflow section, verify that the Subflow field is set to Cisco Webex Download Subscriptions.
        Note:
        The Download subscriptions check box is selected by default and you can't clear it.
      2. In the Calculate Activity Subflow section, verify that the Subflow field is set to Cisco Webex Update User Activity.
        Note:
        The Download Activity check box is selected by default. If you clear it, the activity scheduled job SAM - Refresh <displayname> Activity isn't created.
        In the Analyze user activity field, you can also select the date and time starting from when you want to analyze the user activity. By default, you can analyze user activity up to 60 days prior to the current date and view events performed by individual users from the time you create this profile.
        Note:
        Software Asset Management pulls the events from the time that you start analyzing user activity irrespective of the profile creation date.
        You can modify this value in the Last activity threshold field of your software reclamation rules. For more information, see Review a software reclamation rule.
      3. In the Reclaim Subscription Subflow section, verify that the Subflow field is set to Cisco Webex Reclaim Subscription.
        Note:
        The Reclaim subscriptions check box is selected by default. If you don't want to reclaim subscriptions, you can clear this check box. If you clear it, the removal candidates are created but the reclaim subscription subflow isn't triggered or the reclamation process isn't initiated.
    4. Select Save.
      A draft integration profile is created.

      In the Download Subscription Subflow tab, the Connection & Credential field appears and is automatically set to sn_cisco_teams_spk.CiscoWebexTeams. In the Calculate Activity Subflow tab, the Connection & Credential field appears and is automatically set to sn_webex_mtg_spoke.Webex.

      Note:
      The automatically populated value in the Connection & credential field changes based on the selection in the Download activity and Reclaim subscriptions check boxes.
      Table 5. Automatically populated Connection & credential values based on the selection
      Selection Connection & credential value
      Both Download activity and Reclaim subscriptions are selected. sn_cisco_teams_spk.webex_subscription_activity_reclaim
      Only Download activity is selected. sn_cisco_teams_spk.webex_subscription_activity
      Only Reclaim subscriptions is selected. sn_cisco_teams_spk.webex_subscription_reclaim
      Both Download activity and Reclaim subscriptions aren’t selected. sn_cisco_teams_spk.webex_subscription
    5. In the Download Subscription Subflow tab, select the preview icon (Preview icon) next to the Connection & Credential field and then select Open Record in the record preview.
    6. Select the Create New Connection & Credential related link.
    7. On the form, fill in the OAuth Client ID and OAuth Client Secret that you had saved while creating the Webex Teams OAuth application.
      Leave all other fields as is.
    8. Select Create and Get OAuth Token.
      Note:
      Make sure you're logged in to your ServiceNow instance using your local admin credentials. Logging in with SSO user credentials might cause the tokens to be generated automatically.

      For the role required to perform this step, refer to the Minimal user permissions table.

    9. When prompted, log in using your Webex Email address and Password.
    10. After the connection is successfully created, navigate to the Webex integration profile.
    11. In the Calculate Activity Subflow tab, select the preview icon (Preview icon) next to the Connection & Credential field and then select Open Record in the record preview.
    12. Select the Create New Connection & Credential related link.
    13. On the form, fill in the fields.
      Table 6. Create Connection and Credential form
      Connection URL

      Replace <subdomain> with the Webex Meeting site domain configured for the organization.

      Log in to the Webex admin portal and navigate to SERVICES > Meeting > Sites. In the Site name column, <subdomain> is the part of <subdomain>.webex.com in the site name.

      Webex Admin User Name User name or email address to log in to Webex.
    14. Fill in the OAuth Client ID and OAuth Client Secret values that you saved while creating the Webex Meetings OAuth application.
    15. Select Create and Get OAuth Token and follow the steps to get an OAuth token.
      Note:
      For the role required to perform this step, refer to the Minimal user permissions table.
    16. On the integration profile form, select Validate Connection to verify the connection and credential details of this integration.

      Validating the connection verifies the Download Subscriptions and Calculate Activity APIs, but not the Reclaim Subscriptions APIs.

    17. After the connection is verified, select Publish.
    18. In the Publish Confirmation dialog box, select OK.
      Note:
      If you clear the Download Activity check box after the integration profile is published, you must revalidate the connections and then republish the integration profile because the following events occur:
      • The Status field on the integration profile form changes to Draft.
      • The Validate connection button shows up on the form.
      • The current SAM - Refresh <displayname> Activity job gets deleted.

    What to do next

    After the integration connects, your ServiceNow instance automatically creates software models, reclamation rules, and software subscriptions that are refreshed daily.

    After creating an integration profile, view information about the profile in the Software Asset Workspace by navigating to License operations > User subscription > Direct integration profiles. You can select an integration profile to view the following related lists. If the following related lists aren't visible for an integration profile in the default view, you can select the custom integration view from the Details tab:
    • Software Models
    • Unrecognized Subscription Identifiers
    • Scheduled Jobs
    • Scheduled Job Results
    • Software Subscriptions
    • Subscription Identifier Exclusion Rule
    • Subscription User Exclusion Rule

    If you want to set up multiple integration profiles with unique connections, create child aliases to manage different configurations and settings for each integration profile. For more information, see Create a child alias to set up multiple Cisco Webex integration profiles.

    Review all automatically generated reclamation rules to reclaim user subscriptions. For more information, see Review a software reclamation rule.

    Create software entitlements for the automatically generated software models to track used software against owned software.
    Reconciliation also runs on your subscriptions as a scheduled job or on-demand. You can view your reconciliation results in the License Workbench (Software Asset Management classic application) or the License usage view (Software Asset Workspace). Use these results to determine your license compliance position and to remediate any non-compliance.