Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Introduction

...

Table of Contents

Introduction

This guide explains how to configure SphereShield app for Webex (Teams) and Webex Meeting.

...

  1. Login to admin webex -  https://admin.webex.com/manage-users/users with a service account. Note: this has to be a separate account from your main admin account, since it is not possible to assign "Compliance officer" role to yourself. It needs to be assigned a different account.
    In the Profile tab click on the admin line:

  2. Set the user to have a  Compliance Officer and Full administrator privileges:

                 

  3. Login to Webex Development: https://developer.webex.com/ with the user created above.

  4. Click on Start Building Apps button:

  5. Click Create an Integration

    Select Integration as a new app type:

  6. Fill in all the required settings.  Integration Name should be simply "SphereShield".  The icon should be the SphereShield logo.  Contact email should be support@agatsoftware.com

  7. The important setting here is the Redirect URL. You should enter your Access Portal URL (provided by AGAT) with the addition of /account/webexauth suffix. 

    Example for Fiji: https://ap.fiji.agat.world/account/webexauth

    Note that the redirect URL is case sensitive.

    Select the following scopes for Webex Teams:

  8. spark:all

  9. spark-admin:call_memberships

    is the Redirect URL. You should enter your Access Portal URL (provided by AGAT) with the addition of /account/webexauth suffix. 

    Example for Fiji: https://ap.fiji.agat.world/account/webexauth

    Note that the redirect URL is case sensitive.

  10. Select the following scopes for Webex Teams:

Expand
titleSphereShield for Webex App
  • spark:all

  • spark-admin:call_memberships_read

  • spark-admin:calls_read

  • spark-admin:licenses_read

  • spark-admin:organizations_read

  • spark-admin:people_read

  • spark-admin:people_write

  • spark-admin:resource_group_memberships_read

  • spark-admin:resource_group_memberships_write

  • spark-admin:resource_groups_read

  • spark-admin:

...

  • roles_read

  • spark-admin

...

  • :call_qualities_read

  • spark-compliance:events_read

  • spark-compliance:memberships_read

  • spark-compliance:memberships_write

  • spark-

...

  • compliance:

...

  • messages_read

  • spark-

...

  • compliance:

...

  • messages_

...

  • write

  • spark-

...

  • compliance:

...

  • rooms_

...

  • read

  • spark-

...

  • compliance:

...

  • team_

...

  • memberships_read

  • spark-

...

  • compliance:

...

  • team_memberships_write

  • spark-

...

  • compliance:

...

  • teams_read

...

spark-admin:roles_read

...

spark-admin:call_qualities_read

...

spark-compliance:events_read

...

spark-compliance:memberships_read

...

spark-compliance:memberships_write

...

spark-compliance:messages_read

...

spark-compliance:messages_write

...

spark-compliance:rooms_read

...

spark-compliance:team_memberships_read

...

spark-compliance:team_memberships_write

...

spark-compliance:teams_read

  • meeting:admin_schedule_read (for eDiscovery purpose to write meeting title)

  • meeting:admin_schedule_write (sending meeting invitee to make SphereShield Co Host in scheduled meeting)

  • meeting:participants_write (scope for being able to expel users from scheduled meeting)

  • meeting:admin_participants_read (scope needed to create “meetingParticipants” webhook)

  • meeting:controls_read (scope needed to be able to request meeting recording state)

  • meeting:controls_write (scope needed to be able to change meeting recording state)

  • meeting:admin_preferences_write(scoped needed to be able to make Compliance officer as CoHost in PMR meeting)

  • spark-admin:calls_write (might require escalation to Webex Support)

If you also want to use Webex Meetings add the scope:

  • meeting:recordings_read , meeting:admin_recordings_read

  1. Click Add Integration button

It is also possible to click all of the required scopes with a custom JavaScript. For this you need to have the Create new integration page open. While you’re on that page open browser developer tools, I’ll use Firefox as an example. It’s very similar in Chrome (Ctrl + Shift + C in Firefox and Chrome):

...

  1. Copy all the text in OAuth Authorization URL field (black box):


    (can be easily done by 3 left clicks on the black box text to select all the URL and Ctrl+C to copy)

  2. Paste it into a new tab of Chrome (recommends to use incognito) in the address line and press Enter:

  3. Accept the required permissions:


    You will be redirected to the Admin Portal Webex App Configuration page ([adminPortalURL]/account/webexauth):

  4. Image RemovedImage Added

    Enter the settings from Webex App: Client ID, Client Secret, Integration ID
    In External Portal Web API URL enter your AP external URL, like https://env29.agatcloud.com

    Note that here it comes without any suffix, just the site base URL.
    After clicking the Save button, the Admin Portal will try to connect to the configured Webex App and if it succeeds you will see the following page: 

...

Now the Webex App is configured and you can review the settings in the Cloud Services Integration settings page:

...