.
Looking for:
Zoom app marketplace permissions - zoom app marketplace permissions -
Information regarding the requested scopes is presented to the user as they are adding the app. For example:. Once a user authorizes the app with the requested scopes, the app requests Zoom for the user's access token. See shared access permissions for important details about your app's access to information. In this document you will find a complete list of scopes, their descriptions, and the associated API calls that the app with permitted scope has access to.
The following are the available Account scopes and their associated API calls:. This scope allows an app to view a Master account's account and sub account information. This includes account settings, account lock settings, managed domains, and an account's trusted domains. This scope allows an app to manage sub accounts on behalf of a Master account.
This includes creating or disassociating a sub account from a Master account, updating an account's owner or account settings, and updating lock settings. This scope allows an app to view and manage a Master account's sub accounts. The following are the available Billing scopes and their associated API calls:.
This scope allows an app to view and manage billing details. This includes modifying a sub account, viewing sub accounts' plans, and viewing a sub account's plan data usage. This scope allows an app to view the billing details of all of an account's users. The following are the available Chat scopes and their associated API calls:.
This scope allows an app to view user's chat messages and information, such as the date and time of when it was sent and the sender's email address. This scope allows an app to view chat messages of all of an account's users.
This includes accessing information related to messages, such as the date and time of when it was sent and the sender's email address.
Only users who are assigned a role that includes the View permission for chat messages can add and use apps that request this scope. Users who do not have this permission cannot add any apps that request this scope.
This scope allows an app to send chat messages, as well as update and delete a user's previously-sent messages. This scope allows an app to send chat messages, as well as update and delete previously-sent messages for an account's users.
Only users who are assigned a role that includes the Edit permission for chat messages can add and use apps that request this scope. This scope allows an app to view chat session information and user messages from a specific date. This scope allows an app to view all users' chat session details and messages.
This scope allows an app to send chat messages, as well as update and delete previously-sent messages for a user. This scope allows an app to view and manage chat channel information and perform actions on user's behalf. This includes creating or updating channels, inviting or removing channels members, and removing a channel.
This scope allows an app to view information about the chat channels joined by an account's users. Only users who are assigned a role that includes the View permission for chat channels can add and use apps that request this scope. This scope allows an app to view and manage information for chat channels joined by an account's users, as well as perform actions on a user's behalf. Only users who are assigned a role that includes the Edit permission for chat channels can add and use apps that request this scope.
The following are the available Chatbot scopes and their associated API calls:. This scope allows a chatbot to interact with users by sending messages to users, editing the sent messages, and deleting the sent messages. The following are the available Contacts scopes and their associated API calls:.
This scope allows an app to search for users in a Zoom account's company contacts. This scope allows an app to retrieve a user's chat contacts information. The following are the available Dashboard scopes and their associated API calls:. This scope allows an app to view an account's Meeting Dashboard data. This includes meeting and meeting participant metrics, the meeting's quality score, and the quality of service provided to the participants during meetings.
This scope allows an app to view an account's Webinar Dashboard data. This includes webinar and webinar participant metrics, as well as the quality of service provided to the webinar's participants. This scope allows an app to view an account's Zoom Rooms Dashboard data, such as Zoom Room information and issues.
This scope allows an app to view the Dashboard client satisfaction metrics for Zoom meetings and webinars. This scope allows an app to view the Zoom Chat Dashboard metrics for the usage of the Zoom Chat client by an account's users. This scope allows an app to an account's H. This includes information such as the device name, ID, protocol, and encryption options.
This scope allows an app to manage an account's H. The following are the available Group scopes and their associated API calls:. This scope allows an app to perform actions on behalf of a group administrator.
This include managing group members and settings, updating a group name, or deleting groups. This scope allows an app to perform actions on behalf of an IM group administrator, such as viewing IM group and member details in a Zoom account. This scope allows an app to perform actions on behalf of an IM group administrator.
The following are the available Meeting scopes and their associated API calls:. This scope allows an app to view a user's meeting information. This includes meeting reports, participants, polls, and registrant information. This scope allows an app to view the meeting information for all users in the Zoom account.
This includes meeting reports, participants, polls, and registrants. This scope allows an app to view and manage user's meetings. This includes performing actions such as scheduling and updating meetings, g meetings, and updating live streaming options. This scope allows an app to view and manage meeting information of all the users that are in the Zoom account. This includes performing actions such as scheduling and updating meetings, deleting meetings, and updating live streaming options.
This scope allows an app to manage meeting information for a Master account's sub accounts. This scope allows an app to view a user's local recording meeting token information.
This scope allows an app to view an account's users' local recording meeting token information. This scope allows an app to view PAC details for all users in an account.
This includes dedicated and global dial-in numbers, conference IDs, and passwords used to join a conference. This scope allows an app to view and manage the PAC information for all users in an account.
This scope allows an app to view and manage PAC information for all sub accounts associated with a Master account. This is your opportunity to tell Zoom users why they should add this integration, what value does your app provide, and why your app is the right solution for them. Ideal descriptions contain a concise, informative paragraph followed by a short list of main features. Long Descriptions can commonly cause an app submission to be denied if it lacks sufficient information about app functionality.
Long Descriptions can be updated when a new version of the app is submitted. A demo video in your app card is strongly recommended, but not required. Videos a maximum size of 40 MB should help users discover and learn about your app. Remember to not use content which does not belong to you music, clips, etc.
At least one image or video is required in preview content. Remember to use a high enough resolution to appear clearly on screens of varying sizes. Select a category which best describes the main function and purpose of your app. Release Notes for the App Reviewer help the Marketplace team effectively test your app. Be thorough as possible providing information on roles and permissions needed for effective functional testing.
App submissions without sufficient testing release notes may require resubmission. If you are upgrading an app , you can provide Release Notes for the App Users. This information will be delivered directly to any app user who has opted to receive transactional emails from the Marketplace. All published apps are required to provide a Documentation URL to guide users through adding and using the app.
When creating documentation, provide the following guidelines:. Adding the App Required : A step by step guide for a user to add your app. Link to a troubleshooting guide. Usage Required : For each feature or action, provide a clear use-case description and a list of any prerequisites. Removing the App Required : A guide to removing the app from your Zoom account. Notify the user the implications of deauthorization, and how you remove their data.
Include any specific requirements by your app. A simple list like the following will suffice, as removing the app is handled by Zoom:. Troubleshooting Optional, but highly recommended — List the most common user issues and their solutions including adding-app issues, adding meetings, accessing recordings, etc.
FAQ Optional — List the most frequently asked questions, including questions on authorization, activation emails, or unsubscribing to email updates. Contact Support Optional — Describe what users can expect when engaging your support team including the hours of your support team and first response SLA maximum time a user should expect to wait to hear from your support team.
All published apps are also required to provide a Support URL for individual on-going support for users. While the Marketplace provides active support for use of the platform, all apps are required to provide users with their own dedicated support options.
Describe what users can expect when engaging your support team including the hours of your support team and first response SLA maximum time a user should expect to wait to hear from your support team. Any domains receiving callbacks or requests from Zoom must be authorized. Once this is completed, click Validate to allow the app to be submitted for review.
Your submission must include a designated test account and credentials to support the Marketplace review team in functional and usability testing, in part to help ensure your app only has access to the APIs necessary for the app's functioning. If an account is not required to login to your app, select No account required. When an app has been approved, the Marketplace team notifies you of approval and public availability of the app. From this point, any Zoom user is able to add your app using production credentials.
For more information on this process, reference the Submission Review guide and the Submission Checklist. If the app has not yet been published, the app can be removed directly.
Comments
Post a Comment