Skip to content

Commit

Permalink
Updated the readme file to remove the use of legacy app (#375)
Browse files Browse the repository at this point in the history 
* Updated the readme file to remove the use of legacy app

* Fixed the review comments
  • Loading branch information
@Kshitij-Katiyar
Kshitij-Katiyar authored May 9, 2024
1 parent 0498a0a commit 41ac248
Showing 1 changed file with 26 additions and 42 deletions.
68 changes: 26 additions & 42 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,29 +61,23 @@ You can set the **OAuth ClientID** and **OAuth Secret**, generated by Zoom, and
#### Create an app for Mattermost

1. Go to [https://marketplace.zoom.us/](https://marketplace.zoom.us/) and log in as an admin.
2. In the top left select **Develop** and then **Build Legacy App**.
3. Select **OAuth** in **Choose your app type** section.
4. Enter a name for your app.
2. In the top right select **Develop** and then **Build App**.
3. On top choose **Development**. We would choose **Production** if we were publishing to marketplace, but we won't be doing that here.
4. You can edit the name of your app from top left side by clicking on edit icon.
5. Choose **User-managed app** as the app type.
6. Choose whether you **Would like to publish this app on Zoom Marketplace**. In most cases you'll want this to be disabled, but the plugin supports apps that are published in the Zoom Marketplace.
7. Select **Create**.

![create_user_managed](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/b42465a6-f91d-4737-9697-5636e75addf0)
![app_type](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/47b81f49-3699-4737-815d-5cc2fccab0c4)

#### Configure your new OAuth app to work with Mattermost
6. Next you'll find your **Client ID** and **Client Secret**. Please copy this as these will be needed when you set up Mattermost to use the plugin.
7. Enter a valid **Redirect URL for OAuth** \(`https://SITEURL/plugins/zoom/oauth2/complete`\) and add the same URL under **Add Allow List**. Note that `SITEURL` should be your Mattermost server URL.

If you **would like to publish on Zoom Marketplace**, you'll find two sets of values: **development** and **production**. Make sure you follow the next steps with the production values.

1. Go to the **App Credentials** tab on the left. Here you'll find your **Client ID** and **Client Secret**. These will be needed when you set up Mattermost to use the plugin.
2. Enter a valid **Redirect URL for OAuth** \(`https://SITEURL/plugins/zoom/oauth2/complete`\) and add the same URL under **Add Allow List**. Note that `SITEURL` should be your Mattermost server URL.

![credentials](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/87844060-1fe8-4780-8701-2502d17997f0)
![credentials](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/62c9c2d9-e9e4-42a4-9ca7-03e8767304e3)

#### Add user scopes to the app

Select **Scopes** and add the following scopes: **meeting:read:meeting**, **meeting:write:meeting**,**user:read:user**.

![scopes-user-level-app](https://github.com/mattermost/mattermost-plugin-zoom/assets/100013900/584e0dc1-40e8-4567-af48-9c1c4ae112be)
![scopes-user-level-app](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/19b071be-01a8-4c76-8dcc-b43c281e9542)

#### Do not perform the install step

Expand All @@ -93,13 +87,13 @@ Zoom has one last option called **Install**. There is no need to perform this ac

This plugin allows users to be deauthorized directly from Zoom, in order to comply with Zoom’s commitment to security and the protection of user data. If you **would like to publish on Zoom Marketplace**, you can set up a deauthorization URL.

1. Select **Information**.
1. Select **App Listing** and then select **Link & Support**.
2. Near the end of the page is a section called **Deauthorization Notification**.
3. Enter a valid **Endpoint URL** \(`https://SITEURL/plugins/zoom/deauthorization?secret=WEBHOOKSECRET`\).
* `SITEURL` should be your Mattermost server URL.
* `WEBHOOKSECRET` is generated during when setting up Mattermost to use the plugin.

![deauthorization](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/3928708d-8b57-474b-9c4a-d1e21c054d31)
![deauthorization](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/94da92f8-8880-459d-9f04-d9ad44a0b661)

#### Finish setting up Mattermost server

Expand All @@ -114,31 +108,21 @@ You can set the **OAuth ClientID** and **OAuth Secret**, generated by Zoom, and
#### Create an app for Mattermost

1. Go to [https://marketplace.zoom.us/](https://marketplace.zoom.us/) and log in as an admin.
2. In the top left select **Develop** and then **Build App**.
3. Select **OAuth** in **Choose your app type** section.
4. Enter a name for your app.
5. Choose **Account-level app** as the app type.
6. Choose whether you **Would like to publish this app on Zoom Marketplace**. In most cases you'll want this to be disabled, but the plugin supports apps that are published in the Zoom Marketplace.
7. Select **Create**.

![Create account level app](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/a7af4594-9b22-43ea-9dd6-c4bf7ecbd794)

#### Configure your new OAuth app to work with Mattermost

If you **would like to publish on Zoom Marketplace**, you'll find two sets of values: **development** and **production**. Make sure you follow the next steps with the production values.
2. In the top right select **Develop** and then **Build App**.
3. On top choose **Development**. We would choose **Production** if we were publishing to marketplace, but we won't be doing that here.
4. You can edit the name of your app from top left side by clicking on edit icon.
5. Choose **Admin-managed app** as the app type.

1. Go to the **App Credentials** tab on the left. Here you'll find your **Client ID** and **Client Secret**.
* These will be needed when you set up Mattermost to use the plugin.
2. Enter a valid **Redirect URL for OAuth** \(`https://SITEURL/plugins/zoom/oauth2/complete`\) and add the same URL under **Add Allow List**.
* `SITEURL` should be your Mattermost server URL.
![app_type](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/3030b7ea-eea2-4fd1-b8f1-5b47a17efecc)

![credentials](https://github.com/mattermost/mattermost-plugin-zoom/assets/55234496/587d6c25-f1c2-4744-b4ca-86f56ec9a6a5)
6. Next you'll find your **Client ID** and **Client Secret**. Please copy this as these will be needed when you set up Mattermost to use the plugin.
7. Enter a valid **Redirect URL for OAuth** \(`https://SITEURL/plugins/zoom/oauth2/complete`\) and add the same URL under **Add Allow List**. Note that `SITEURL` should be your Mattermost server URL.

#### Add user scopes to the app

Select **Scopes** and add the following scopes: **meeting:read:meeting:admin**, **meeting:write:meeting:admin**,**user:read:user:admin**.

![scopes-account-level-app](https://github.com/mattermost/mattermost-plugin-zoom/assets/100013900/b9de1fe7-d2d0-4a47-8a31-96b0886c44be)
![scopes-account-level-app](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/07919a75-6b6b-4914-b009-70f6dfe5e906)

#### Do not perform the install step

Expand All @@ -148,13 +132,13 @@ Zoom has one last option called **Install**. There is no need to perform this ac

This plugin allows users to be deauthorized directly from Zoom, in order to comply with Zoom’s commitment to security and the protection of user data. If you **would like to publish on Zoom Marketplace**, you can set up a deauthorization URL.

1. Select **Information**.
1. Select **App Listing** and then select **Link & Support**.
2. Near the end of the page, is a section called **Deauthorization Notification**.
3. Enter a valid **Endpoint URL** \(`https://SITEURL/plugins/zoom/deauthorization?secret=WEBHOOKSECRET`\).
* `SITEURL` should be your Mattermost server URL.
* `WEBHOOKSECRET` is generated during [Mattermost Setup](../mattermost-setup.md).

![deauthorization](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/3928708d-8b57-474b-9c4a-d1e21c054d31)
![deauthorization](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/94da92f8-8880-459d-9f04-d9ad44a0b661)

#### Finish setting up Mattermost server

Expand All @@ -164,20 +148,20 @@ Follow the instructions for setting up Mattermost to use the plugin.

When a Zoom meeting ends, the original link shared in the channel can be changed to indicate the meeting has ended and how long it lasted. To enable this functionality, we need to create a webhook subscription in Zoom that tells the Mattermost server every time a meeting ends. The Mattermost server then updates the original Zoom message.

1. Select **Feature**.
1. Select **Access** in the Features.
2. Enable **Event Subscriptions**.
3. Select **Add New Event Subscription** and give it a name \(e.g. "Meeting Ended"\).
4. Select **Add events** and select the **End Meeting** event.

![event_types](https://github.com/mattermost/mattermost-plugin-zoom/assets/90389917/b2833ea8-fe0b-4c5e-9bba-62c281d928e4)

4. Enter a valid **Event notification endpoint URL** \(`https://SITEURL/plugins/zoom/webhook?secret=WEBHOOKSECRET`\).
* `SITEURL` should be your Mattermost server URL.
* `WEBHOOKSECRET` is generated when setting up Mattermost to use the plugin.

![mattermost_webhook_secret](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/58b9ac74-ecf9-4e3e-986e-94fd4c39bfb0)

Select **Add events** and select the **End Meeting** event.

![event_types](https://github.com/mattermost/mattermost-plugin-zoom/assets/74422101/a2f04fe9-e4fa-4e78-b198-1f493e53cf93)

Select **Done** and then save your app.
Select **Save** and then save your app.

### Mattermost Setup

Expand Down

0 comments on commit 41ac248

Please sign in to comment.