Table of Contents

Introduction

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

You can install one or both of them depending on your business requirements.

Most steps are identical. When there is a difference, you will see info in the relevant step.

High level process steps

Verify you have Admin Portal URL in hand (received from AGAT support)
Create an Integration application in the Webex Developer Portal
Register the Webex App in the Admin Portal

Detailed Steps

Create an Integration application in the Webex Developer Portal

...

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:
Image Removed

...

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

...

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

...

Click on Start Building Apps button:

...

Click Create an Integration
Image Removed
Select Integration as a new app type:
Image Removed

...

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
Image Removed

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

...

Select the following scopes for Webex Teams:

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

10. Click Add Integration button

It 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):

...

And paste the following code in this area:

...

Info
Note: as shown in the screenshot above you may need to type in “allow pasting” (without quotes) to be able to paste code into the dev tools console.

Code:

...

language	js

...

Table of Contents

Introduction

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

You can install one or both of them depending on your business requirements.

Most steps are identical. When there is a difference, you will see info in the relevant step.

High level process steps

Verify you have Admin Portal URL in hand (received from AGAT support)
Create an Integration application in the Webex Developer Portal
Register the Webex App in the Admin Portal

Detailed Steps

Create an Integration application in the Webex Developer Portal

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:
Image Added
Set the user to have a Compliance Officer and Full administrator privileges:
Image Added
Login to Webex Development: https://developer.webex.com/ with the user created above.
Click on Start Building Apps button:
Image Added
Click Create an Integration
Image Added
Select Integration as a new app type:
Image Added
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
Image Added
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:

Expand

title	SphereShield 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
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

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):

...

And paste the following code in this area:

...

Info
Note: as shown in the screenshot above you may need to type in “allow pasting” (without quotes) to be able to paste code into the dev tools console.

Code:

Code Block

language	js

try {
    let requiredScopes
} catch (e) {
    console.log("variable already declared")
    console.log(e)
}

if (typeof requiredScopes === 'undefined') {
    console.log("defining scopes")
    requiredScopes = [
        "spark-admin:roles_readall",
        "spark-admin:call_qualitiesmemberships_read",
        "spark-complianceadmin:eventscalls_read",
        "spark-complianceadmin:membershipslicenses_read",
        "spark-complianceadmin:membershipsorganizations_writeread",
        "spark-complianceadmin:messagespeople_read",
        "spark-complianceadmin:messagespeople_write",
        "spark-compliance:roomsadmin:resource_group_memberships_read",
        "spark-complianceadmin:teamresource_group_memberships_readwrite",
        "spark-complianceadmin:teamresource_membershipsgroups_writeread",
        "spark-complianceadmin:teamsroles_read",
        "meetingspark-admin:admincall_schedulequalities_read",
        "meetingspark-compliance:adminevents_schedule_writeread",
        "meetingspark-compliance:participantsmemberships_writeread",
        "meetingspark-compliance:adminmemberships_participants_readwrite",
        "meetingspark-compliance:controlsmessages_read",
        "meetingspark-compliance:controlsmessages_write",
        "meeting:admin_preferences_writespark-compliance:rooms_read",
        "spark-compliance:meetingsteam_memberships_writeread",
        "spark-compliance:meetingsteam_memberships_readwrite",
        "spark-admincompliance:callsteams_writeread",
    ]  }  for (scope of requiredScopes) {
 "meeting:admin_schedule_read",
      let validScope = scope.replace("meeting:admin_schedule_write",
 "\\:")       "meeting:participants_write",
  try {     "meeting:admin_participants_read",
    element  = document.querySelector(`input[id*=${validScope}]`)
 "meeting:controls_read",
       if (!element.checked) { "meeting:controls_write",
        "meeting:admin_preferences_write",
    console.log(`Clicking ${validScope}`)   "spark-compliance:meetings_write",
        "spark-compliance:meetings_read",
 element.click()       "spark-admin:calls_write"
 }   ]

}

catchfor (escope of requiredScopes) {
    let validScope =  consolescope.log(`couldn't find element ${scope}`)replace(":", "\\:")
    
    try {
    console.log(e)    element }
}

Code that also includes Meetings:

Code Block

language	js

try {= document.querySelector(`input[id*=${validScope}]`)
     let requiredScopes } catchif (e!element.checked) {
     console.log("variable already declared")     console.log(e)`Clicking ${validScope}`)
 if (typeof requiredScopes === 'undefined') {        consoleelement.logclick("defining scopes"))
      requiredScopes = [}
    } catch (e) {
"spark:all",         "spark-admin:call_memberships_read",
 console.log(`couldn't find element ${scope}`)
      "spark-admin:calls_read",  console.log(e)
      "spark-admin:licenses_read",
}
}

Code that also includes Meetings:

Code Block

language	js

try {
    let requiredScopes
 "spark-admin:organizations_read",
 } catch (e) {
    console.log("variable already "spark-admin:people_read",declared")
    console.log(e)
}

 "spark-admin:people_write",
   if (typeof requiredScopes === 'undefined') {
    "spark-admin:resource_group_memberships_read",
console.log("defining scopes")
    requiredScopes =  "spark-admin:resource_group_memberships_write",[
         "spark-admin:resource_groups_read:all",
        "spark-admin:rolescall_memberships_read",
        "spark-admin:callcalls_qualities_read",
        "spark-complianceadmin:eventslicenses_read",
        "spark-complianceadmin:membershipsorganizations_read",
        "spark-complianceadmin:membershipspeople_writeread",
        "spark-complianceadmin:messagespeople_readwrite",
        "spark-compliance:messages_writeadmin:resource_group_memberships_read",
        "spark-compliance:rooms_readadmin:resource_group_memberships_write",
        "spark-complianceadmin:teamresource_membershipsgroups_read",
        "spark-complianceadmin:teamroles_memberships_writeread",
        "spark-complianceadmin:teamscall_qualities_read",
        "meeting:admin_schedulespark-compliance:events_read",
        "meetingspark-compliance:adminmemberships_schedule_writeread",
        "meeting:participants"spark-compliance:memberships_write",
        "meeting:admin_participantsspark-compliance:messages_read",
        "meetingspark-compliance:controlsmessages_readwrite",
        "meetingspark-compliance:controlsrooms_writeread",
        "meetingspark-compliance:adminteam_preferencesmemberships_writeread",
        "spark-compliance:meetingsteam_memberships_write",
        "spark-compliance:meetingsteams_read",
        "spark-admin:calls_writemeeting:admin_schedule_read",
        "meeting:recordingsadmin_schedule_readwrite",
        "meeting:adminparticipants_recordings_readwrite",
        "meeting:admin_scheduleparticipants_read",
        "meeting:admincontrols_schedule_writeread",
        "meeting:participantscontrols_write",
        "meeting:admin_participantspreferences_readwrite",
        "meetingspark-compliance:controlsmeetings_readwrite",
        "meetingspark-compliance:controlsmeetings_writeread",
        "meeting:admin_preferencesspark-admin:calls_write",
        "spark-compliancemeeting:meetingsrecordings_writeread",
        "spark-compliance:meetingsmeeting:admin_recordings_read"
        "spark-admin:calls_write"
    ]

}

for (scope of requiredScopes) {
    let validScope = scope.replace(":", "\\:")
    
    try {
        element = document.querySelector(`input[id*=${validScope}]`)
        if (!element.checked) {
            console.log(`Clicking ${validScope}`)
            element.click()
        }
    } catch (e) {
        console.log(`couldn't find element ${scope}`)
        console.log(e)
    }
}

...

Register the Webex App in the Admin Portal

...

Copy all the text in OAuth Authorization URL field (black box):
Image RemovedImage Added

(can be easily done by 3 left clicks on the black box text to select all the URL and Ctrl+C to copy)
Paste it into a new tab of Chrome (recommends to use incognito) in the address line and press Enter:
Accept the required permissions:

You will be redirected to the Admin Portal Webex App Configuration page ([adminPortalURL]/account/webexauth):
Image Removed
Image 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://apenv29.fijiagatcloud.agat.worldcom

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:

Webex Teams alone

...

Webex Meetings alone

...

Both Webex

...

You could do Both Webex, if you already selected all the needed scopes:

Webex integration App for Webex Meeting

...

Reconfiguring Existing Environment

...

Version	Old Version 4	New Version Current
Changes made by	Agat Support	David Elkarat
Saved on	Nov 14, 2022	Jul 26, 2023

Versions Compared

Key

Introduction

High level process steps

Detailed Steps

Create an Integration application in the Webex Developer Portal

Introduction

High level process steps

Detailed Steps

Create an Integration application in the Webex Developer Portal

Register the Webex App in the Admin Portal

Reconfiguring Existing Environment

Page Comparison

Versions Compared

Key

Introduction

High level process steps

Detailed Steps

Create an Integration application in the Webex Developer Portal

Introduction

High level process steps

Detailed Steps

Create an Integration application in the Webex Developer Portal

Register the Webex App in the Admin Portal

Reconfiguring Existing Environment