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):
- Go to the Zoom App Marketplace and sign in with your Zoom account.
- From the top navigation bar, open the Develop dropdown and select Build App.
- In the What kind of app are you creating window, select General App, click the Create button.
- Enter a name for your app and select the app type.
(E.g. Zoom-General App) - Click Create to continue.
- In the Redirect URL for OAuth field, enter the following URI and add it to the allow list:
https://zappysys.com/oauth/ - Copy your Client ID and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
- 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
- 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
- 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
- That’s it! After adding the scopes, click Continue to complete the process.
- 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.
- You’re done!
Parameters
Parameter | Required | Default value | Options | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Name:
Label: Client Id |
YES | ||||||||||
Name:
Label: Client Secret |
YES | ||||||||||
Name:
Label: Redirect Url |
YES |
https://zappysys.com/oauth/
|
|||||||||
Name:
Label: Token Url |
YES |
https://zoom.us/oauth/token
|
|||||||||
Name:
Label: Authorization Url |
YES |
https://zoom.us/oauth/authorize
|
|||||||||
Name:
Label: Retry Mode |
RetryWhenStatusCodeMatch
|
|
|||||||||
Name:
Label: Retry Status Code |
429
|
||||||||||
Name:
Label: Retry Count Max |
5
|
||||||||||
Name:
Label: Retry Multiply Wait Time |
True
|