Connecting to Zoom

To authenticate to Zoom, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

Using OAuth Authentication

First you will need to create an OAuth app. To do so, navigate to https://marketplace.zoom.us/develop/create, select the Develop dropdown menu, and choose Build App. Then, select General App. When building the app, give your app a name, and then go to the Basic Information page. The Client Id and Client Secret listed here will be your OAuthClientId and OAuthClientSecret. You will also be able to set an OAuth Redirect Url, which will be your CallbackUrl. You may also wish to set how the app is managed to Admin-managed as some scopes require admin permission. Then go to the Scopes page. In order to access everything exposed by the driver, the following scopes will be needed:account:read:list_sub_accounts, account:read:sub_account, meeting:read:meeting, meeting:read:registrant, meeting:read:list_meetings, meeting:read:past_meeting, phone:read:list_call_logs, report:read:meeting, report:read:list_meeting_participants, user:read:user, user:read:list_users, webinar:read:webinar, webinar:read:list_webinars, webinar:read:list_absentees, webinar:read:list_past_instances, webinar:read:list_past_participants, webinar:read:list_registrants.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientID: Set this to the OAuth Client ID that is specified in your app settings.
OAuthClientSecret: Set this to the OAuth Client Secret that is specified in your app settings.
CallbackURL: Set this to the Redirect URI you specified in your app settings.

Example Connection String

Profile=Zoom.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are None or OAuth. Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT, APIKEY
CallbackURL	The URL users return to after authenticating to API via OAuth.
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.