Reference

Authentication Server OAuth (Granular scopes)

Description

Server-to-Server OAuth authentication method that lets applications access the Zoom API directly without user login or consent, using a Client ID and Secret to generate short-lived tokens. [API reference]

Instructions

Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):

  1. Go to the Zoom App Marketplace and sign in with your Zoom account.
  2. From the top navigation bar, open the Develop dropdown and select Build App.
  3. In the What kind of app are you creating window, select Server to Server OAuth App, click the Create button.
  4. Enter a name for your app and select the app type.
    (E.g. Basic OAuth App)
  5. Click Create to continue.
  6. Copy your Account ID, Client ID, and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
  7. In the Information window, enter the company name, developer name, and email address, then click Continue.
  8. From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
    Scope Levels:
    • Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
    • Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.

    Recommended Scopes:
    Admin-Level
    • user:read:settings:admin
    • user:write:user:admin
    • meeting:read:list_meetings:admin
    • meeting:read:meeting:admin
    • meeting:read:list_registrants:admin
    • meeting:read:past_meeting:admin
    • meeting:read:list_registration_questions:admin
    • user:read:list_users:admin
    • webinar:read:list_webinars:admin
    • webinar:read:webinar:admin
    • webinar:read:list_registrants:admin
    Master-Level
    • user:read:settings:master
    • meeting:read:list_meetings:master
    • meeting:read:meeting:master
    • meeting:read:list_registrants:master
    • user:read:list_users:master
    • webinar:read:list_webinars:master
    • webinar:read:webinar:master
    • webinar:read:list_registrants:master
  9. That’s it! After adding the scopes, click Continue to complete the process.
  10. In the ZappySys API Component/Driver UI, enter your Zoom app Account ID, Client ID, and Client Secret, then click Test Connection.
  11. You’re done!

Parameters

Parameter Required Default value Options
Name: account_id

Label: Account Id

 YES
Name: ClientId

Label: Client Id

 YES
Name: ClientSecret

Label: Client Secret

 YES
Name: TokenUrl

Label: Token Url

 YES https://zoom.us/oauth/token
Name: UseCustomApp

Label: UseCustomApp

Use your own app credentials or inbuilt app provided by ZappySys for ease of use. If you choose UseCustomApp=true then make sure to obtain your own ClientId and Secret using steps provided (Click [Steps to Configure] link found next to Authentication Type dropdown) 		YES True
Name: RetryMode

Label: Retry Mode

 RetryWhenStatusCodeMatch
Name Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
Name: RetryStatusCodeList

Label: Retry Status Code

 429
Name: RetryCountMax

Label: Retry Count Max

 5
Name: RetryMultiplyWaitTime

Label: Retry Multiply Wait Time

 True