Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Info

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.

...


  1. Image Added

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

...

Select Meeting, then select both checkboxes as shown below:

Info

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

...

Select Recording, then select both checkboxes as shown below:

Info

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

...

Select User, then select all of the three checkboxes as shown below:

Info

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

...

Check if the Install button is active.

Note

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

...

Info
titleOn to the Next Step

Continue to this page to connect your Zoom OAuth application with CAE LearningSpace

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.

Info

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.

...

On the Choose your app type page, find OAuth.

Info

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.

...


  1. Image Added

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

    Info

    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.


  3. Click Create.

...

Name the new OAuth application you are creating.

Info

In the example, we are simply naming the new application after CAE 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.

...

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

Note

Do not share your OAuth application with external users.

...

Info

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

...

Tip

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

...


  1. Image Added

    Warning

    The JWT app type will be deprecated June 1, 2023. We recommend that you create Server-to-Server OAuth or OAuth apps to replace the functionality of a JWT app in your account.


  1. A window pops up where you need to

    1. Name the new OAuth application you are creating.

      Info

      In the example, we are simply naming the new application after CAE 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 CAE LearningSpace to their Zoom user account individually. 

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

      Note

      Do not share your OAuth application with external users.

...


    1. Image Added


  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.

      Info

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

...

    1. Image Added

    2. Scroll down to the

...

    1. OAuth allow list section, Add allow lists field.
      Here, provide the URL where your users access

...

    1. CAE LearningSpace

...

    1. once more.

...

titleImportant

...


    1. Image Added

  1. Click Continue,

In this case, return to the Whitelist URL field on the App Credentials tab in your Zoom OAuth application and add the URL of your CAE LearningSpace system. The Zoom-page automatically saves every change you make (look for the green (tick) Saved sign next to the Continue button). 

...

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

    1. Provide the Short and Long

...

    1. Descriptions of your OAuth application.

...


    1. Image Added

    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.

...


    1. Image Added

      Tip

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


  1. 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.

...


  1. Image Added

  2. 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:

      Info

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

...


    1. Image Added

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

      Info

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

...

    1. Image Added

    2. Select User, then select all of the three checkboxes as shown below:

      Info

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

...


    1. Image Added

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

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

...


  1. Image Added

  2. Click Continue to arrive at the

...

  1. Activation tab of your OAuth application.
  2. Check if the

...

  1. Add button is active.
    Image Added

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

    Note

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

...

  1. Add button is active.

...


  1. Image Added

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

...


  1. Image Added

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

...


  1. Image Added

Info
titleOn to the Next Step

Continue to this page to connect your Zoom OAuth application with CAE LearningSpace