Zoom

Zoom

Zoom is a cloud-based video conferencing platform that can be used for video conferencing meetings, audio conferencing, webinars, meeting recordings, and live chat.

Zoom has become a critical piece of IT infrastructure for many businesses. Having accessible data on the usage, billing, and performance of Zoom as a communications tool will relieve pressure from IT teams who otherwise have to spend time and toil logging in to multiple tools and running reports.

Zoom Account creation

Create a Zoom Account in the Zoom App Marketplace.

Pre-requisites

Account ID of the customer is required. Hit an API to get Account Id. You will be able to see the Server-to-Server-OAuth token that is used as a Bearer token to hit the API for getting the Account Id. The bearer token is available in the APP Credentials tab under the installed Server-to-Server-OAuth App in Zoom App Marketplace.

The required API is https://api.zoom.us/v2/users/{userId}. For user-level applications, pass the me value instead of userId parameter. The response of the API contains the account_id of the customer.

If you want the userId of the user, hit API https://api.zoom.us/v2/users.

Supported Metrics

Types of Authentication

OpsRamp supports Server-to-Server OAuth Authentication.

Server-to-Server OAuth authentication

The administrator for a Zoom account must enable the view and edit permissions for Server-to-Server OAuth applications.

To do this, the administrator must enable the Server-to-Server OAuth application role. Go to User Management > Roles > Role Settings > Advanced features and select the View and Edit check boxes for Server-to-Server OAuth app.

Steps to Create a Server-to-Server OAuth Application

1. Choose the Server-to-Server OAuth app type under Build App section.
2. Click Create.

3. Add a name for your application.

4. Add the following details to activate your application to enable access for using ZOOM APIs:

• App credentials — View your Account ID, Client ID and Client Secret.

• Information — Add information about your app, such as a short description and developer contact information (name and email address is required for activation).

• Scopes - If you have the role permission to add scopes, add scopes that you would like to enable.

Choose Add Scopes to search for and add scopes:
Note: You need to add below permissions to get discovery and monitoring data from the Zoom app:
- account:read:admin
- dashboard_home:read:admin
- dashboard_meetings:read:admin
- dashboard_webinars:read:admin
- dashboard_zr:read:admin
- room:master
- room:read:admin
- user:master
- user:read:admin

5. Click Activate your app to activate the app.

6. Your appliation should be activated. You will not be able to generate an access token to make API calls unless your application is activated. If your application is deactivated, existing tokens will no longer work. You can also choose to Deactivate your app in the section.

For more information, refer Server-to-Server-OAuth App.

Use account credentials to get an access token

To use account credentials to get an access token for your application, call the Zoom OAuth token API with the account_credentials grant_type and your account_id:

POST https://zoom.us/oauth/token?grant_type=account_credentials&account_id={accountId}HTTP/1.1
Host: zoom.us
Authorization: Basic Base64Encoder(clientId:clientSecret)

The successful response will be the access token, which is a Bearer token type that expires in an hour, with the scopes that you chose in your application settings screen:

{
“Access_token“: String,
“Token_type”: “bearer”,
“Expire_in”: long,
“scope” : [String]
}

Make API calls to Zoom endpoints

Use OAuth 2.0 to make API calls to Zoom endpoints. Send the access token in the Authorization header as a Bearer token:

For example:

GET https://api.zoom.us/v2/users/{userID}
HTTP/1.1
Host: api.zoom.us
Authorization: Bearer

Configure the integration

1. From All Clients, select a client.

2. Navigate to Setup > Account.

3. Select the Integrations and Apps tab.

4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.

5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
   Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.

6. Click ADD in the Zoom tile:

   

7. In Add ZOOM page, enter your account information:

   

   Property	Description
   Name	(required) User-defined, descriptive integration name.
   Account Number	(required) Enter UserId.
   Client ID	(required) Enter API Key from Steps to Create a Server-to-Server OAuth App step 4
   Security Key	(required) Enter API Secret from Steps to Create a Server-to-Server OAuth App step 4
   Confirm Security Key	(required) Re-enter the API Secret.

8. Click Next.In the RESOURCE TYPE section, select:

   • ALL: All the existing and future resources will be discovered.
   • SELECT: You can select one or multiple resources to be discovered.

9. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

   • Minutes
   • Hourly
   • Daily
   • Weekly
   • Monthly

     

10. Click Finish.
    The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

11. After configuring the integration, Zoom metrics can be viewed from the Infrastructure page.

    

The Zoom integration enables discovery of the Zoom Rooms resource.