Reference

Authentication User OAuth (Granular scopes)


Description

OAuth App must be created under Admin Console > Channel > API > Settings. [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 General App, click the Create button.
  4. Enter a name for your app and select the app type.
    (E.g. Zoom-General App)
  5. Click Create to continue.
  6. In the Redirect URL for OAuth field, enter the following URI and add it to the allow list:
    https://zappysys.com/oauth/
  7. Copy your Client ID and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
  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:
    • User-Level: Grants access only to the authenticated user’s data. Suitable for apps where users connect with their own Zoom account.
    • 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:
    User-Level
    • user:read:settings
    • meeting:read:list_meetings
    • meeting:read:meeting
    • meeting:read:list_registrants
    • meeting:read:past_meeting
    • meeting:read:list_registration_questions
    • webinar:read:list_webinars
    • webinar:read:webinar
    • webinar:read:list_registrants
    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 Client ID and Client Secret, then click Generate Token to obtain the access tokens.
  11. You’re done!

Parameters

Parameter Required Default value Options
Name: ClientId

Label: Client Id

YES
Name: ClientSecret

Label: Client Secret

YES
Name: ReturnUrl

Label: Redirect Url

YES https://zappysys.com/oauth/
Name: TokenUrl

Label: Token Url

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

Label: Authorization Url

YES https://zoom.us/oauth/authorize
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