Page tree

Our new Zoom OAuth (Open Authentication) solution is recommended for training centers where Zoom has been implemented institution-wide and licensed user accounts already belong to university staff, faculty, and students. 

Build an OAuth application in your Zoom owner account to determine the list of permissions that CAE LearningSpace will have once CAE LearningSpace is authorized by users individually to access their Zoom accounts.

Your Zoom owner account is the primary account where you can manage every other user account, have access to subscriptions, and handle other account management-related settings. Your owner account also holds an account number which is included on your profile.

  1. Log into your Zoom owner account.
  2. Stay on your Profile, and in the side menu on the left, click on Advanced to display further options.
  3. Click on App Marketplace. You will land on https://marketplace.zoom.us/.



  4. On the Zoom App Marketplace page, select the Develop drop-down on the right and open it.
  5. Click Build Legacy App.


Build Legacy App

  1. On the Choose your app type page, find OAuth.

NOTE: JWT is not supported by Zoom any longer! Go to Set Up OAuth 2.0 (Open Authorization) for Existing Zoom Accounts for alternative solutions. (Learn more at Server-to-Server OAuth)



    1. Click Create.

      The OAuth application is a tool that allows you to determine the level of access that CAE LearningSpace will have once a user has authorized CAE LearningSpace to access their Zoom account.


    2. A window pops up where you need to
      1. Name the new OAuth application you are creating.

        In the example, we are simply naming the new application after LearningSpace, but you can give any name to the app you prefer.
        The name of the app does not affect the API configuration in any way.

      2. Select the User-managed app option.
        Users will be able to allow access for LearningSpace to their Zoom user account individually. 

      3. Deselect the third switch to avoid publishing your application on the Zoom App Marketplace.

        Do not share your OAuth application with external users.



  1. Click Create to continue.

  2. You will be directed to the App Credentials page of your new OAuth application.

    1. Copy your Client ID and Client Secret to a safe place of your choice.
      You will be needing these credentials later on when setting up the OAuth meeting provider in CAE LearningSpace.
    2. In the Redirect URL for OAuth field, provide the URL where your users access CAE LearningSpace.

      After authorizing LearningSpace access to a Zoom account, users will be redirected to this page.



    3. Scroll down to the OAuth Information section, OAuth Allow lists field.
      Here, provide the URL where your users access LearningSpace once more.



  3. Click Continue, and you will arrive at the Information page.
    Here, provide some further required details:

    1. Provide the Short and Long Descriptions of your OAuth application.



    2. Scroll down to the Company Name field.
      Name your organization.


    3. Add the Contact Information of the Developer in charge of the OAuth application.

      Developer Contact Information can be the same as the account owner’s information.

       

  4. Once finished, switch to the Scopes tab.
    Here, you have to determine the list of user-specific resources CAE LearningSpace can have access to in a Zoom user account following authorization.
    Once CAE LearningSpace is authorized by a user to access their Zoom account, CAE LearningSpace will be limited to the list of permissions specified in Scopes.



  5. Click the Add Scopes button.
    A pop-up will open where you can search and specify the scope of permissions.
    1. Select Meeting, then select both checkboxes as shown below:

      Once authorized, LearningSpace will be able to view and manage meetings in a Zoom user account.




    2. Select Recording, then select both checkboxes as shown below:

      Once authorized, CAE LearningSpace will also be able to view and manage recordings in a Zoom user account.




    3. Select User, then select the three checkboxes as shown below:

      Once authorized, LearningSpace will also be able to view and manage user information, and view profile information in a Zoom user account.




  6. You should have a total of 7 permissions selected. 
    To make sure, check the upper right corner of the Add scopes pop-up.

  7. Click Done to save your settings.
    You can also check your current scope settings on the Scopes page.



  8. Click Continue to arrive at the Activation tab of your OAuth application.

  9. Check if the Add button is active.



    Once all conditions are met, the Add button will become active.

    Do not install the application. Only check if the application is "ready" for installation. The OAuth installation is "ready" if the Add button is active.




  10. Click Manage in the upper right corner of your page to access your created applications.



    You should have your new application added to your Dashboard on the Created Apps tab:

     


On to the Next Step