Zoom Permissions

For each data type fetched by the Zoom adapter, the tables below provide the following information:

  • Relevant Advanced Setting
  • Associated API endpoints
  • Required connection parameters
  • Required Granular OAuth scopes

Note

All endpoints use Zoom REST API v2.

Granular OAuth Scopes

Zoom has retired Classic OAuth scopes, so you can no longer create or configure a Zoom app with them. Use Granular OAuth scopes instead.

Note

Granular scopes work with the current Zoom adapter. No adapter or version update is needed. The adapter does not check scope names. It authenticates with Account ID, OAuth Client ID, and OAuth Client Secret (Server-to-Server OAuth) and uses whichever scopes are granted to your Zoom app. Make sure the app is granted the scopes for each data type you want to fetch.

In the tables below, the Required column shows whether the scopes are required for the adapter connection or optional. Optional scopes are needed only if you use the related Advanced Setting or asset type.

Note

Zoom may change scope names or availability, and some scopes depend on your Zoom plan and account settings. Check the scope names against the Zoom API reference, or with your Zoom administrator, when you configure your app.

Missing scopes

If Zoom refuses a call because a scope is missing, the fetch continues and shows a missing-scopes warning for the affected data type (devices or users). The warning details list the scope names returned by Zoom, so you can add them to the app.

Connection Test and Users

Connection parameters for all the data types in this section: Zoom domain, Account ID, OAuth Client ID, OAuth Client Secret.

DataAdvanced SettingAPI EndpointsGranular ScopesRequired
Users (also used by the connection test)N/Ausersuser:read:list_users:adminRequired
UsersN/Ausers/USERID/settings
users/USERID
users/me
user:read:settings:admin
user:read:user:admin
Required
UsersN/Agroupsgroup:read:list_groups:adminRequired
UsersFetch inactive usersusers?status=inactiveuser:read:list_users:adminOptional
UsersEnrich the user last logon from the last join to a meetingreport/users/USERID/meetingsreport:read:user:adminOptional

Note

If the connection test fails with an invalid response error, verify that the connection parameters are correct and that the Zoom app has the user:read:list_users:admin scope.

Devices

Connection parameters for all the data types in this section: Zoom domain, Account ID, OAuth Client ID, OAuth Client Secret.

To fetch devices, Fetch devices must be enabled. The Fetch asset types advanced setting selects which of the following calls are made. The default asset types are H323 device, Meeting device, and Zoom room device.

Asset TypeAdvanced SettingAPI EndpointsGranular ScopesRequired
H323 deviceFetch asset typesh323/devicesh323_device:read:list_devices:adminOptional
Meeting deviceFetch asset types
Days of meetings data
metrics/meetings
metrics/meetings/{meetingId}/participants
dashboard:read:list_meetings:admin
dashboard:read:list_meeting_participants:admin
Optional
Zoom roomFetch asset typesmetrics/zoomroomsdashboard:read:list_zoomrooms:adminOptional
Zoom room deviceFetch asset typesrooms
rooms/{roomId}/devices
zoom_rooms:read:list_rooms:admin
zoom_rooms:read:list_devices:admin
Optional
Zoom phone deviceFetch asset typesphone/devices
phone/devices/{deviceId}
phone:read:list_devices:admin
phone:read:device:admin
Optional

The Fetch devices only with hostname and MAC address advanced setting is a filtering option. It calls no endpoints and requires no scopes.

Meeting device requires the Zoom Dashboard feature

The Meeting device asset type uses Zoom Dashboard metrics endpoints. These endpoints are available only for Zoom accounts on the Business plan or higher that have the Dashboard feature enabled. Without the Dashboard feature, the fetch of Meeting devices fails.

To resolve this, either enable the Dashboard feature on your Zoom plan, or remove Meeting device from Fetch asset types in the adapter's advanced settings.

Application Settings and Licenses

Available only for systems with Axonius SaaS Applications.

Connection parameters: Zoom domain. For some settings, additional parameters are required - see the note below.

DataAdvanced SettingAPI EndpointsGranular ScopesRequired
Application Settings, LicensesFetch application settings and licenses (enabled by default)accounts/me/settings
accounts/me/settings?option=meeting_security
account:read:settings:adminOptional
Application SettingsFetch application settings and licensesaccounts/me/lock_settingsaccount:read:lock_settings:adminOptional
Application SettingsFetch application settings and licensesgroups
groups/{groupId}/settings
group:read:list_groups:admin
group:read:settings:admin
Optional
LicensesFetch application settings and licensesaccounts/me/billingbilling:read:billing_information:adminOptional
LicensesFetch application settings and licensesaccounts/me/plans
accounts/me/plans/usage
billing:read:plan_information:admin
billing:read:plan_usage:admin
Optional

If the app cannot read accounts/me/lock_settings, the adapter does not fetch the locked settings. The fetch does not fail, and it shows the missing-scope warning. To avoid the warning, add the account:read:lock_settings:admin scope.

Additional permissions to assign when creating a user account:

  • Users
  • User advanced settings
  • Role management
  • Groups
  • Account profile
  • Account setting
  • Single Sign-On
  • Integration
  • Subscription
  • Billing information

Connection parameters for fetching Application Settings and Licenses

While some settings license data can be fetched only with Account ID, OAuth Client ID and OAuth Client Secret, some high-privilege settings or data cannot be fetched with those parameters alone. This data require you to also provide the following parameters: Zoom Account ID, Username, Password, and 2FA Secret.

Activities

Available only for systems with Axonius SaaS Applications.

Connection parameters for all the data types in this section: Zoom domain, Account ID, OAuth Client ID, OAuth Client Secret.

DataAdvanced SettingAPI EndpointsGranular ScopesRequired
Audit ActivitiesActivity logsreport/operationlogs
report/activities
report:read:operation_logs:admin
report:read:user_activities:admin
Optional
Audit ActivitiesActivity logs
Fetch recordings download activities
users/USERID/recordings
meetings/{meetingUuid}/recordings/analytics_details
cloud_recording:read:list_user_recordings:admin
cloud_recording:read:recording_analytics_details:admin
Optional

Accounts

The Skip service accounts advanced setting is a filtering option. It calls no endpoints and requires no scopes. If Skip service accounts is enabled, no accounts are fetched and no connection parameters are required.


Did this page help you?