Zoom Integration

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:

Zoom uses oAuth2 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 OAuth2.0 app and keep your Client ID and Client Secret to be used later in configuring your credential setup within Oomnitza (Step 8)
  2. Go to Oomnitza "Settings" page and select "Credentials"
  3. Click the '+' icon in the top right corner to add a new credential. A pop-up will appear: mceclip0.png
  4. Type a 'Name' which helps you identify the credential. We recommend including the name of the system and the type of access that credential has, for example ‘Zoom - Read/Write’
  5. Enter the 'Owner' of the credential (optional). This should be the creator of this credential, or the user in Oomnitza who manages access this system.
  6. Click the "Authorization" tab and select "OAuth 2.0" from the ‘Authorization type’ dropdown.mceclip0.png
  7. Select your ‘Saas’, "Zoom" from the SaaS dropdown
  8. Enter the Client ID and Client Secret you created in your OAuth2.0 App (Step 1 above)
  9. Click "Authenticate" button which will prompt you to log into 'Zoom' and authorize the request
  10. Type a useful "Description" which will help you identify the credential (optional). 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")
  11. Click the "Create" button
  12. Finally, you should see the credential you created in the credentials list

Zoom Documentation Links:

  •  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

Within Settings add a new extended User integration for Zoom. 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 

Please work through 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.

 

Prerequisites:

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

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

 

Steps:

1. Navigate to "Software>Workflow>SaaS Users" as per screenshot below.

mceclip0.png

2. From the SaaS Users Workflow page, select the "Add" button in the top right of your screen, above the grid.

mceclip1.png

3. Give your new Workflow a "Workflow name" (mandatory) and a "Workflow description" (optional) before selecting "Add Item" to create it.

4. From the "Tools" section on the left, drag the "SaaS User Role retrieval block" onto the "Sandbox" section.

Note: All workflows must start with the "Begin" block. The configuration for SaaS User Role blocks can be found here: https://oomnitza.zendesk.com/hc/en-us/articles/360053185893

5. To configure the "SaaS User Role retrieval block", you simply select "Edit" on this block.

6. You will be presented with a two step wizard. Search for the SaaS of choice, in this case, 'Zoom'. Select 'Zoom' using the '>' arrow control as high-lighted below to proceed with the configuration.

 

mceclip2.png

7. The "Name", "Description" and "Doculink" are all provided for you. You need to select the 'Credential' you created previously for Zoom, using the OAuth2.0 authentication method. 

 

mceclip3.png

Note: With "Deactivated User" selected, we will automatically reconcile deactivated users from your SaaS system (example, Zoom) back into Oomnitza.

 

8. Finally, select "Save" and your "SaaS User Role retrieval block' configuration is complete.

9. Your new workflow is ready to run, based off the "Actions" selected if the "Begin" block or else you can run it manually from here.

 

Zoom "User Role" and "Last Login" date

Now that your SaaS User Role block has been setup and the workflow has run, you will be able to get the "User Role" and "Last Login" details from your Zoom integration.

Steps:

1. Navigate to "Software>SaaS" and select your software entry for Zoom

2. From the dialog, navigate to "Users"

 

mceclip2.png

 

3. From within "Users", the "Role" and "Last visit" information will be populated directly from your Zoom account (via the SaaS User Role block workflow).

 

mceclip3.png

 

Documentation Links:

 

API block (Presets)

The following Zoom API block Presets are available:

  • Zoom Delete User

Prerequisites:

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

2. Your Zoom SaaS and Contract details with Users are already setup within Oomnitza 

3. 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. Navigate to "Software>Workflow>SaaS Users" as per screenshot below.

 

mceclip0.png

2. With "Workflow: SaaS Users" now selected, you can select the "Add" button in the top right of your screen, above the grid.

 

mceclip1.png

3. Give your new Workflow a "Workflow name" (mandatory) and a "Workflow description" (optional) before selecting "Add Item" to create it.

4. From the "Tools" section, drag the "API block" onto the "Sandbox" section.

5. To configure the "API block", you simply select "Edit".

6. Select "Show Presets" from the API block dialog. 

 

mceclip0.png

7. Search for you Vendor, in this case "Zoom"

8. "Apply" the Preset you wish to use, "Zoom Delete User" in this example.

 

mceclip1.png

9. A confirmation message will appear on screen your and the URL will be populated on the dialog.

10. You can update the current "Name" on the dialog before moving onto the "Authorization" tab

11. Set the "Type" to "OAuth2.0" and select the "Credentials" that you have previously created as part of the OAuth2.0 authentication method.

 

mceclip2.png

12. Finally, select "Save" and your "API block' configuration is complete.

13. Your new workflow is ready to run, based off the configuration of the "Begin" block or else you can run it manually from here.

 

Notes:

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

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk