Integrating with Cisco Webex

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 6 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 DevNet.

    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

    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 Value
      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. In the Calculate Activity Subflow form section, choose a value for the Analyze user activity from field.
      You can also select the date and time that you want to analyze user activity from in the Analyze user activity from field. 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.
    4. Select Save.
      A draft integration profile is created. The integration profile uses the Webex Download Subscription, Webex Calculate Activity, and Webex Reclaim Subscription subflows to get user data from the Webex applications.
    5. In the Download Subscription Subflow, select the preview icon (Preview icon) next to the Connection & Credential field and then select Open Record in the record preview.
    6. If you see a text on the record as This record is in the Cisco Webex Teams Spoke application, but ‘xxx’ is the current application. To edit the record click here, select the link.
      1. Set the configuration template record to SAM SaaS Webex Teams.
      2. Save the record.
    7. Select the Create New Connection & Credential related link.
    8. 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.
    9. Select Create and Get OAuth Token.
      Note:
      For the role required to perform this step, refer to the Minimal user permissions table.
    10. When prompted, log in using your Webex Email address and Password.
    11. After the connection is successfully created, navigate to the Webex integration profile.
    12. In the Calculate Activity Subflow, select the preview icon (Preview icon) next to the Connection & Credential field and then select Open Record in the record preview.
    13. Select the Create New Connection & Credential related link.
    14. On the form, fill in the fields.
      Table 5. 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.
    15. Fill in the OAuth Client ID and OAuth Client Secret values that you saved while creating the Webex Meetings OAuth application.
    16. 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.
    17. Return to the integration profile and select Publish.

    What to do next

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

    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 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.