Zoom Capabilities

After this article...

You'll understand the capabilities our Zoom integration provides, and how Lumos interacts with the Zoom API.

View users

The mapping between Zoom user statuses and Lumos user account statuses is below.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/users

View a user's entitlements

Lumos can retrieve the following user entitlements from Zoom.

• Role - Whether the user is a Zoom Workspace Owner, Admin, or Member.

• License - The Zoom products to which the user is licensed (Basic, Pro, Business, Enterprise, Webinar, Events, Large Meetings, Zoom Phone, Zoom IQ, Zoom Whiteboard, Zoom Whiteboard Plus, Zoom Translated Captions, Zoom Customer Managed Key, Zoom Spots).

Zoom API endpoints:

Role: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/users

License: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/userSettings

View a user's last login

In Lumos, the Last Login value represents the last time the user logged into Zoom.

According to Zoom, this field has a three-day buffer period.

For example, if a user first logged in on January 1st and then logged out and logged in on January 2nd, this value will still reflect the login time of January 1st. However, if the user logs in on January 4th, the value of this field will reflect the updated login time, since it exceeds the three-day buffer period.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/users (we use last_login_time)

View a user's last activity

In Lumos, the Last Activity value for Zoom represents the last time the user hosted a meeting over 40 minutes with 2+ unique participants.

This is important, since any meeting over 40 minutes with 2+ participants requires a license and users with licenses who aren't hosting these types of meetings may not need a license.

Notes:

• Zoom only returns this data for the last 6 months, but Lumos caches old values if we don't get new ones. So for example, you can have users where their Last Activity was 9+ months ago in Lumos.

• A blank value here means that the user has not hosted a meeting over 40 minutes at least 6 months prior to you connecting the Zoom integration to Lumos.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/reportMeetings

Downgrade a user

*This action is not supported if you integrate Zoom in a read-only capacity. See📄 Connecting Zoom

In Lumos, downgrading a Zoom user changes their Role to "Basic" during the next Zoom sync.

In Zoom, this action downgrades the user to the "Basic" role.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/userUpdate (we update the user's type to 1)

Suspend a user

*This action is not supported if you integrate Zoom in a read-only capacity. See📄 Connecting Zoom.

In Lumos, suspending a Zoom user marks their Account Status as "Suspended".

In Zoom, this action deactivates the user. This removes all licenses associated with the user and prevents them from logging in.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/userStatus (we pass the deactivate action)

Deprovision a user

*This action is not supported if you integrate Zoom in a read-only capacity. See📄 Connecting Zoom.

In Lumos, deprovisioning a Zoom user marks their Account Status as "Deprovisioned".

In Zoom, this action permanently removes the user and their data from Zoom. The only context in which you can transfer data and recordings today is during Offboarding (📄 Offboarding Employees in Lumos) and Inactivity Workflows (📄 Inactivity Workflows 101), so if you're using this option, important data or recordings should be transferred by an Owner or Admin before deprovisioning.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/userDelete (we do not dissociate, we delete permanently).

Transfer data

* Available only in Inactivity Workflows

ᐩ This action is not supported if you integrate Zoom in a read-only capacity. See📄 Connecting Zoom.

In Lumos, transferring a Zoom user's data to another user has no impact on data in Lumos. This can only be executed when choosing the "Deprovision" option during Offboarding (📄 Offboarding Employees in Lumos) and Inactivity Workflows.

In Zoom, this action transfer's the user's recordings, meetings, and upcoming events to another user.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/userDelete (we set the transfer_email, transfer_meeting, and transfer_recording query-string parameters)

Provision a user

* This action is not supported if you integrate Zoom in a read-only capacity. See📄 Connecting Zoom.

In Lumos, provisioning a Zoom user has no impact on Lumos Zoom user data until the next Zoom user sync runs. Once the sync runs, a user with a "Basic" role will be added to the Zoom users table.

In Zoom, this action creates a user with a "Basic" role using their email, first name, and last name in Lumos.

Zoom API endpoint: https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/userCreate (the type we set is 1).

Useful links

Zoom API documentation