Creating an extended integration for Zoom users

Integrating Oomnitza with Zoom enables automatic synchronization of users into Oomnitza. This allows you to pull the list of Users from Zoom into Oomnitza to then track these users for license utilization and role usage from within Oomnitza SaaS module as well as to deactivate and adjust these users as part of a user change or user off-boarding workflows.

Available Integrations

• Authentication
• Load List of Users
• SaaS User Role Block
• Zoom Delete User

Authentication

Zoom uses OAuth 2.0 authentication. Additional information about the Credential Vault can be found here: Credentials Table.

The following steps should be used to get an access token which can be used for the various integrations with Zoom.

1. Please follow the documentation to create an OAuth 2.0 app and keep your Client ID and Client Secret to be used later in configuring your credential setup within Oomnitza (Step 5)
2. Go to Oomnitza and click Configuration > Credentials.
3. Click Add new credential (+).
4. On the INFORMATION tab, complete these actions:
   1. Add the name of the credential. We recommend including the name of the system and the type of access that credential has, for example: Zoom - Read/Write.
   2. Optional: Add the name of the owner. This should be the creator of this credential, or the user in Oomnitza who manages access this system.
5. On the AUTHORIZATION tab, complete these actions:
   • As authorization type, select OAuth 2.0.
   • From the SaaS list, select Zoom.
   • Enter the Client ID and Client Secret you created in your OAuth2.0 App (Step 1 above).
   • Click Authenticate which will prompt you to log in to Zoom and authorize the request.
   • Optional: Enter a Description which will help you identify the credential. We recommend that this field reflect the intended usage of the token for example: Retrieval of Zoom User information, and deletion of offboarded Zoom Users.
6. Click CREATE.

Zoom Documentation Links:

• Using Zoom APIs
  • https://marketplace.zoom.us/docs/api-reference/using-zoom-apis

• Create an OAuth App

  • https://marketplace.zoom.us/docs/guides/build/oauth-app

• OAuth with Zoom:

  • https://marketplace.zoom.us/docs/guides/auth/oauth

•  OAuth2.0 App Creation Help:
  • The account used to create the OAuth2.0 app must be an administrator in order to have access to the scopes required. 
  • When asked to provide a Redirect URL and Whitelist URL, you can use the address: https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url
  • Scopes required (for User Role information)
    • View users information and manage users /user:write:admin
    • View all user information /user:read:admin

Load list of users

To add a new extended User integration for Zoom, click Configuration > Integrations, and then click Integrations List View . The main reason to add the Zoom user load is to map the users for the SaaS Module to be able to properly manage your Zoom users from within Oomnitza.

Available mappings

The following fields can be mapped from Zoom using Oomnitza's User Interface. For more information on creating Extended Connector Mappings, please see our article on Mapping Extended Connectors. More details on the Zoom API can be found at https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users   

• User ID - this is the user ID within Zoom
• Connector Sync Time - This is the timestamp on when the connector was run. See more details on how to use this field here.
• Email - the user's email address. For SaaS User Management, we recommend using this as the sync key to uniquely identify a user within Zoom and map it to a pre-existing user in Oomnitza.
• Department
• First Name
• Last Name
• Personal Meeting Id
• Role Id
• Status
• Timezone of the User
• User Type
• User's Last Login Time

SaaS User Role block 

Complete the following steps to configure the SaaS User Role Block for Zoom. Configuration of this SaaS User Role block will allow you to capture the Zoom "User Role" and the "Last Login" date (coming from your Zoom account)  within Oomnitza.

You will find 2 different implementations of the SaaS User Role block. Please select the one that best fits your requirements:

• Zoom User Role - this simply reads the role name from Zoom
• Zoom User License plus Role - this returns the license type plus role name as the role name within Oomnitza

Prerequisites

A Zoom Credential is added using OAuth2.0 Authentication method as described above.

Your Zoom SaaS and Contract details with Users are already available within Oomnitza 

Steps

1. Click Configuration > Workflows > SaaS Users.
2. On the SaaS Users Workflow page, click Add.
3. Enter a meaningful name for the workflow and a description. 
4. Click the Blocks tab, and drag the SaaS User Role retrieval block and drop it on the canvas. All workflows must start with the Begin block. See Creating SaaS User Workflows.
5. To configure the SaaS User Role retrieval block, click Edit .
6. Enter Zoom as the search criteria.
7. Select Zoom User Role and click the right arrow. 
8. Select the credential that you created for Zoom.  With "Deactivated User" selected, we will automatically reconcile deactivated users from your SaaS system, for example Zoom, back into Oomnitza.
9. Click SAVE.

Your new workflow is ready to run, based off the Actions that were selected.

Zoom User Role and Last Login date

Now that your SaaS User Role block was set up and the workflow was run, you cab get the User Role and Last Login details from your Zoom integration.

Steps

1. Click Software and click your Zoom SaaS.
2. Click USERS.

Result

The role and last visit are shown for each SaaS user.

Documentation Links:

• Oomnitza: SaaS User Roles Overview
  • https://oomnitza.zendesk.com/hc/en-us/articles/360053185893
• Zoom: API: User
  • https://marketplace.zoom.us/docs/api-reference/zoom-api/users/user

API block (Presets)

The following Zoom API block Presets are available:

• Zoom Delete User

Prerequisites:

• A Zoom Credential is added using OAuth2.0 Authentication method as described above.
• Your Zoom SaaS and Contract details with Users are already setup within Oomnitza 
• You have run a workflow similar to above which would populate Oomnitza with the actual Zoom User Role and Last Login date from your Zoom SaaS. 

Zoom delete user

Using this setup outlined below, you can create a workflow that would automatically delete a Zoom user account within your Zoom SaaS which was deactivated from within Oomnitza. 

Steps

1. Click Configuration > Workflows > SaaS Users.
2. Click Add.
3. Enter a meaningful name for the workflow and a description.
4. Click the Blocks tab, drag the API block in the Integrations section and drop it onto the canvas.
5. Click Edit .
6. Enter Zoom as the search criteria, select Zoom Delete User, and click the right arrow.
7. Select your credentials.
8. Click SAVE.

Notes

No additional amendments to Parameters, Headers, Body are required for this API Preset to work