Zoom With Tiered Accounts
The following sections explain prerequisites, resources, and instructions for integrating with SaaS Management.
| • | Stored Information for Zoom With Tiered Accounts |
| • | Required Minimum Permissions for Zoom With Tiered Accounts |
| • | Authentication Method for Zoom With Tiered Accounts |
| • | Required Credentials for Zoom With Tiered Accounts |
| • | License Types for Zoom With Tiered Accounts |
| • | Integrating Zoom With Tiered Accounts With SaaS Management |
| • | Auto-Populated License Information for Zoom With Tiered Accounts |
| • | Managing Available Licenses for Zoom With Tiered Accounts |
| • | API Endpoints for Zoom With Tiered Accounts |
Stored Information for Zoom With Tiered Accounts
The following table describes the available integration tasks and stored data within SaaS Management.
|
Available Integration Tasks |
Information Stored |
||||||||||||||||||
|
Application Roster |
|
||||||||||||||||||
|
Application Access |
|
||||||||||||||||||
|
License Differentiation |
For more information, see:
|
||||||||||||||||||
|
License Information |
Note:The SaaS Management License Information integration task retrieves information once every 24 hours. Therefore, the data in the Zoom Portal may not match the data in SaaS Management. Note:The Provisioned (license count) field entry in the Zoom with Tiered Accounts Licenses Tab is based on the Zoom user type.
|
||||||||||||||||||
|
Reclamation |
For more information, see Reclaiming SaaS Licenses. |
Note:The information stored is subject to change as enhancements are made to the SaaS application.
Required Minimum Permissions for Zoom With Tiered Accounts
The minimum API required permissions are based on the Required Scopes for Zoom With Tiered Accounts.
Note:To grant the appropriate scope, you must set up your Zoom account with multiple tiers or you must enable the main API permission for your Zoom account.
Required Scopes for Zoom With Tiered Accounts
|
Scopes Required |
Description |
Integration Task Name |
|
account:master |
Enables you to view and manage sub accounts. |
Application Roster License Information |
|
user:master |
Enables you to view and manage sub account's user information. |
Application Roster |
|
report:master |
Enables you to view sub account’s report data. |
Application Access |
|
meeting:master |
Enables you to view and manage sub account's user meetings. |
Application Access |
|
user:write:admin |
Enables you to view user information and manage users. |
Reclamation |
Authentication Method for Zoom With Tiered Accounts
The required authentication method is OAuth 2.0 With Authorize Flow. For more information, see Zoom’s documentation topic, OAuth 2.0 for Zoom.
Required Credentials for Zoom With Tiered Accounts
The following credentials are required:
| • | Username |
| • | Password |
| • | Include Free Users |
| • | Include On Premises. |
Note:Username and Password are required only for authorization. These values are not stored in SaaS Management.
License Types for Zoom With Tiered Accounts
SaaS Management integrates with the following paid Zoom with Tiered Accounts plans, which represent the license types in the Licenses tab and in the Activity tab for the Zoom with Tiered Accounts integration. For more plan details, see Zoom’s documentation topic, Plans & Pricing.
|
Paid Zoom With Tiered Accounts Plans Integrated With SaaS Management |
||
|
API Partner |
Enterprise |
Zoom Phone |
|
Bulk License |
Free |
Zoom Rooms |
|
Business |
Free Trial |
Zoom Video SDK |
|
Education |
Pro |
|
Integrating Zoom With Tiered Accounts With SaaS Management
Complete the following steps to integrate Zoom with Tiered Accounts with SaaS Management.
To integrate Zoom with Tiered Accounts with SaaS Management:
| 1. | Verify your Zoom account is enabled with the Master Account feature by signing in to the Zoom Web Portal. In the navigation menu, click Account Management then Sub Accounts, and verify if the account is enabled with the Master account feature. |
| 2. | In SaaS Management, add the Zoom with Tiered Accounts application. For more information, see Adding an Application. |
| 3. | In the SaaS Management Include Free Users field, enter the appropriate value. For more information, see the following table. |
|
Zoom Include Users Option |
Value to Enter |
|
To track free or basic free trial users in the Licenses and Activity tabs of SaaS Management |
Yes |
|
To track only licensed users in the Licenses and Activity tabs of SaaS Management |
No or leave the Include Free Users field blank |
| 4. | In the SaaS Management Include On Premises field, enter the appropriate value. For more information, see the following table. |
|
Zoom Include On Premises Option |
Value to Enter |
|
To track On-Premises users in the Licenses and Activity tabs of SaaS Management |
Yes |
|
To track only licensed or basic users in the Licenses and Activity tabs of SaaS Management |
No or leave the Include On Premises field blank |
Note:the following:
| • | If you enter Yes in the Include On Premises field, the SaaS Management Licenses Tab field Provisioned displays Unlimited for all Zoom user types: Basic, Licensed, and On-Prem. |
| • | If you enter No or leave the Include On Premises field blank, the SaaS Management Licenses Tab field Provisioned only displays a count for the Zoom Licensed user type. Unlimited is displayed for the Zoom Basic user type. |
| • | Zoom’s On-Premises Meeting Connector is only available for Enterprise, Business, and Education plans. |
| 5. | Click Authorize, which redirects you to the Zoom portal. |
| 6. | In the Zoom portal, enter your username and password. Based on SaaS Management’s production geographic region, the appropriate Zoom OAuth App is displayed. |
|
Geographic Region |
Zoom OAuth App Name |
Description |
|
North America (NA) |
FSM - Tiered Accounts |
In the NA production environment, this OAuth app is used to integrate the Zoom accounts (with the Master Account feature) with SaaS Management. During authorization, you need to grant the scope permissions to this app. |
|
Asia-Pacific (APAC) |
FSM - APAC Tiered Account |
In the APAC production environment, this OAuth app is used to integrate the Zoom accounts (with the Master Account feature) with SaaS Management. During authorization, you need to grant the scope permissions to this app. |
|
Europe (EU) |
FSM - EU Tiered Accounts |
In the EU production environment, this OAuth app is used to integrate the Zoom accounts (with the Master Account feature) with SaaS Management. During authorization, you need to grant the scope permissions to this app. |
| 7. | In the Zoom Permissions Requested window, click Allow to authorize. |
Note:To deauthorize the authorized Zoom OAuth client application, complete the follow steps.
| a. | Sign in to your Zoom account and go to the Zoom App Marketplace. |
| b. | Click Manage > Added Apps. |
| c. | Click the Remove button. |
For further information on managing and optimizing your organization’s Zoom with Tiered Accounts licenses, see:
| • | Auto-Populated License Information for Zoom With Tiered Accounts |
| • | Managing Available Licenses for Zoom With Tiered Accounts |
| • | Tracking Application Activity by License Type for License Differentiation |
| • | Reclaiming SaaS Licenses. |
Auto-Populated License Information for Zoom With Tiered Accounts
The SaaS Management integration with Zoom with Tiered Accounts offers a License Information integration task that automatically retrieves every 24 hours the name of the Zoom with Tiered Accounts plan, unique ID, and total allowed number of licenses. This auto-populated Zoom with Tiered Accounts license information provides a more complete view of your Zoom with Tiered Accounts SaaS entitlements and component usage by displaying:
| • | Assigned entitlements. |
| • | User’s license activity, based on the user’s last login. |
Important:If you enable the License Information integration task, you need to enter and keep up to date the following Licenses Tab information. The License Information integration task does not pull in this information. The SaaS application’s annual spend calculation relies on entered and accurate license effective and expiration dates.
| • | Effective Date |
| • | Expiration Date |
| • | Cost |
| • | Currency |
| • | Payment Frequency |
To auto-populate Zoom with Tiered Accounts license information, see Auto-Populating SaaS Application License Information. When the License Information integration task is enabled, the License type, Name, and Provisioned fields in the Zoom with Tiered Accounts Licenses tab are disabled as this information is automatically populated. The active and inactive ingested license data from Zoom with Tiered Accounts can be compared against your Zoom with Tiered Accounts billing.
Managing Available Licenses for Zoom With Tiered Accounts
After the License Information integration task for Auto-Populated License Information for Zoom With Tiered Accounts is enabled, you can add or remove the Zoom with Tiered Accounts product licenses you wish to manage within SaaS Management. To manage available Zoom with Tiered Accounts, see Managing Available SaaS Application Licenses.
API Endpoints for Zoom With Tiered Accounts
Application Roster
https://api.zoom.us/v2/accounts
https://api.zoom.us/v2/accounts/{accountId}/users
Application Access
https://api.zoom.us/v2/accounts
https://api.zoom.us/v2/accounts/{accountId}/users
https://api.zoom.us/v2/accounts/{accountId}/users/{userId}/meetings
https://api.zoom.us/v2/accounts/{accountId}/report/meetings/{meetingId}/participants
License Information
https://api.zoom.us/v2/accounts
Reclamation
https://api.zoom.us/v2/accounts/{accountId}/users/{userId}/status