GraphQL scopes
Beta
Zoom GraphQL is in a public beta.
GraphQL scopes operate similarly to REST API scopes. Configure the scope required for the GraphQL object on your Marketplace app page.
See the table below for the scopes and permissions required to view or edit the following GraphQL objects.
Meeting
| GraphQL Object | Scope | Permission |
|---|---|---|
meeting | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetings | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
users | user:read:admin user:write:admin | User:Read |
user | user:read user:read:admin user_info:read user:write user:write:admin | User:Read |
meetingRegistrants | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetingRegistrant | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetingPolls | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetingRegistrationQuestion | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetingInvitation | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetingLiveStream | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
meetingTemplates | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
pastMeetings | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
pastMeetingByID | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
pastMeetingPollByID | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
pastMeetingParticipants | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
createMeeting | meeting:write meeting:write:admin | User:Edit |
updateMeeting | meeting:write meeting:write:admin | User:Edit |
deleteMeeting | meeting:write meeting:write:admin | User:Edit |
addMeetingRegistrant | meeting:write meeting:write:admin | User:Edit |
deleteMeetingRegistrant | meeting:write meeting:write:admin | User:Edit |
updateMeetingRegistrantStatus | meeting:write meeting:write:admin | User:Edit |
createMeetingPolls | meeting:write meeting:write:admin | User:Edit |
updateMeetingPolls | meeting:write meeting:write:admin | User:Edit |
deleteMeetingPolls | meeting:write meeting:write:admin | User:Edit |
updateLiveStream | meeting:write meeting:write:admin | User:Edit |
updateLiveStreamStatus | meeting:write meeting:write:admin | User:Edit |
batchMeetingRegistration | meeting:write meeting:write:admin | User:Edit |
updateMeetingEvents | meeting:write meeting:write:admin meeting:master | User:Edit |
createMeetingInviteLink | meeting:write meeting:write:admin | User:Edit |
batchCreateMeetingPolls | meeting:write meeting:write:admin | User:Edit |
updateMeetingSurvey | meeting:write meeting:write:admin | User:Edit |
deleteMeetingSurvey | meeting:write meeting:write:admin | User:Edit |
updateMeetingStatus | meeting:write meeting:write:admin | User:Edit |
meetingSurvey | meeting:read meeting:read:admin meeting:write meeting:write:admin | User:Read |
updateRegistrationQuestions | meeting:write meeting:write:admin | User:Edit |
User
| GraphQL Object | Scope | Permission |
|---|---|---|
deleteUserProfilePicture | user:write:admin user:write | User:Edit |
updateUserStatus | user:write:admin user:write | User:Edit |
updateUserProfile | user:write:admin user:write | User:Edit |
updateUserPresenceStatus | user:write:admin user:write | User:Edit |
updateUserPassword | user:write:admin user:write | User:Edit |
updateUserEmail | user:write:admin user:write | User:Edit |
revokeUserToken | user:write:admin user:write | User:Edit |
createUserAssistant | user:write:admin user:write | User:Edit |
assistants | user:write:admin user:read:admin user:write user:read | User:Read |
deleteUserAssistant | user:write:admin user:write | User:Edit |
deleteUserAssistants | user:write:admin user:write | User:Edit |
schedulers | user:write:admin user:read:admin user:write user:read | User:Read |
deleteUserScheduler | user:write:admin user:write | User:Edit |
deleteUserSchedulers | user:write:admin user:write | User:Edit |
createUser | user:write:admin user:write | User:Edit |
deleteUser | user:write:admin user:write | User:Edit |
deleteUserVirtualBackgroundFiles | user:write:admin user:write | User:Edit |
checkPersonalMeetingRoom | user:read:admin user:read user:write:admin user:write | User:Read |
zoomAccessToken | user_zak:read user:write:admin user:write | User:Read |
userToken | user:read:admin user:read user:write:admin user:write | User:Read |
userPermissions | user:read:admin user:read user:write:admin user:write | User:Read |
verifyUserEmail | user:read:admin user:read user:write:admin user:write | User:Read |
Recording
| GraphQL Object | Scope | Permission |
|---|---|---|
deleteMeetingRecordings | recording:write recording:write:admin | Recording:Edit |
meetingRecordings | recording:read recording:read:admin recording:write recording:write:admin | Recording:Read |
deleteMeetingRecordingFile | recording:write recording:write:admin | Recording:Edit |
recoverMeetingRecordingFile | recording:write recording:write:admin | Recording:Edit |
meetingRecordingRegistrants | recording:read recording:read:admin recording:write recording:write:admin | Recording:Read |
createMeetingRecordingRegistrants | recording:write recording:write:admin | Recording:Edit |
meetingRecordingRegistrantQuestions | recording:read recording:read:admin recording:write recording:write:admin | Recording:Read |
updateMeetingRecordingRegistrantQuestions | recording:write recording:write:admin | Recording:Edit |
updateMeetingRecordingRegistrantStatus | recording:write recording:write:admin | Recording:Edit |
meetingRecordingSettings | recording:read recording:read:admin recording:write recording:write:admin | Recording:Read |
updateMeetingRecordingsSettings | recording:write recording:write:admin | Recording:Edit |
recoverMeetingRecordings | recording:write recording:write:admin | Recording:Edit |
userMeetingRecordings | recording:read recording:read:admin recording:write recording:write:admin | Recording:Read |
Webinar
| GraphQL Object | Scope | Permission |
|---|---|---|
pastWebinarAbsentees | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
pastWebinarsInstances | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
pastWebinarParticipants | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
pastWebinarPolls | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
pastWebinarQAs | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
webinarTemplates | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
webinars | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
createUserWebinars | webinar:write webinar:write:admin | User:Edit |
webinar | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
deleteWebinar | webinar:write webinar:write:admin | User:Edit |
updateWebinar | webinar:write webinar:write:admin | User:Edit |
updateWebinarStatus | webinar:write webinar:write:admin | User:Edit |
webinarLiveStream | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
updateWebinarLiveStreamStatus | webinar:write webinar:write:admin | User:Edit |
updateWebinarLiveStream | webinar:write webinar:write:admin | User:Edit |
webinarPolls | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
webinarPoll | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
createWebinarPoll | webinar:write webinar:write:admin | User:Edit |
updateWebinarPoll | webinar:write webinar:write:admin | User:Edit |
deleteWebinarPoll | webinar:write webinar:write:admin | User:Edit |
webinarPanelists | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
createWebinarPanelist | webinar:write webinar:write:admin | User:Edit |
deleteWebinarPanelist | webinar:write webinar:write:admin | User:Edit |
deleteWebinarPanelists | webinar:write webinar:write:admin | User:Edit |
webinarRegistrants | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
createWebinarRegistrant | webinar:write webinar:write:admin | User:Edit |
addBatchWebinarRegistrants | webinar:write webinar:write:admin | User:Edit |
webinarRegistrantQuestions | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
updateWebinarRegistrantQuestions | webinar:write webinar:write:admin | User:Edit |
updateWebinarRegistrantStatus | webinar:write webinar:write:admin | User:Edit |
webinarRegistrant | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
deleteWebinarRegistrant | webinar:write webinar:write:admin | User:Edit |
webinarSurvey | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
deleteWebinarSurvey | webinar:write webinar:write:admin | User:Edit |
updateWebinarSurvey | webinar:write webinar:write:admin | User:Edit |
webinarBranding | webinar:read webinar:read:admin webinar:write webinar:write:admin | User:Read |
deleteWebinarBrandingVirtualBackgrounds | webinar:write webinar:write:admin | User:Edit |
setWebinarBrandingVirtualBackground | webinar:write webinar:write:admin | User:Edit |
deleteWebinarBrandingWallpaper | webinar:write webinar:write:admin | User:Edit |
createWebinarBrandingNameTag | webinar:write webinar:write:admin | User:Edit |
updateWebinarBrandingNameTag | webinar:write webinar:write:admin | User:Edit |
webinarLocalRecordingJoinToken | webinar_token:read:local_recording webinar_token:read:admin:local_recording | User:Read |
deleteWebinarChatMessage | webinar:write webinar:write:admin | User:Edit |
createWebinarInviteLinks | webinar:write webinar:write:admin | User:Edit |
webinarToken | webinar:read webinar:read:admin | User:Read |
trackingSources | webinar:read webinar:read:admin | User:Read |
webinarLocalArchiveToken | webinar_token:read:admin:local_archiving | User:Read |
webinarLiveStreamingJoinToken | webinar_token:read:live_streaming webinar_token:read:admin:live_streaming | User:Read |
Dashboards
| GraphQL Object | Scope | Permission |
|---|---|---|
metricsChat | dashboard_im:read:admin | DashboardIM:Read |
metricsClientFeedbacks | dashboard_home:read:admin | DashboardHome:Read |
metricsClientFeedbackDetails | dashboard_home:read:admin | DashboardHome:Read |
metricsClientSatisfaction | dashboard:read:admin | DashboardHome:Read |
metricsCrcUsages | dashboard_crc:read:admin | DashboardCRC:Read |
metricsTop25RoomsWithIssues | dashboard_home:read:admin | DashboardHome:Read |
metricsZoomRoomIssues | dashboard_home:read:admin | DashboardHome:Read |
metricsMeetings | dashboard_meetings:read:admin | DashboardMeetings:Read |
metricsMeetingsByMeetingId | dashboard_meetings:read:admin | DashboardMeetings:Read |
metricsParticipants | dashboard_meetings:read:admin | DashboardMeetings:Read |
metricsQosParticipants | dashboard_meetings:read:admin | DashboardMeetings:Read |
metricsQosParticipantsSummary | dashboard_meetings:read:admin | DashboardMeetings:Read |
metricsParticipantsSatisfaction | dashboard_meetings:read:admin dashboard:read:admin | DashboardMeetings:Read |
metricsSharingRecordingDetails | dashboard_meetings:read:admin dashboard:read:admin | DashboardMeetings:Read |
metricsQosParticipantsByParticipantId | dashboard_meetings:read:admin dashboard:read:admin | DashboardMeetings:Read |
metricsQualityScores | dashboard_home:read:admin dashboard:read:admin | DashboardHome:Read |
metricsWebinarQosParticipant | dashboard_webinars:read:admin dashboard:read:admin | DashboardWebinars:Read |
metricsZoomRooms | dashboard_zr:read:admin dashboard:read:admin | DashboardZR:Read |
metricsTop25IssuesWithZoomRooms | dashboard_zr:read:admin dashboard:read:admin | DashboardZR:Read |
metricsZoomRoom | dashboard_zr:read:admin dashboard:read:admin | DashboardZR:Read |
metricsClientVersions | dashboard:read:admin dashboard_home:read:admin zms:dashboard:read | DashboardHome:Read |
metricsWebinarQosParticipantsSummary | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsWebinars | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsWebinar | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsWebinarParticipants | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsWebinarParticipantsQos | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsWebinarParticipantsSatisfaction | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsWebinarSharingRecordingDetails | dashboard:read:admin dashboard_webinars:read:admin | DashboardWebinars:Read |
metricsMeetingParticipants | dashboard_meetings:read:admin | DashboardMeetings:Read |
Report
| GraphQL Object | Scope | Permission |
|---|---|---|
meetingDetailReports | report:read:admin | UsageReport:Read |
meetingPollReports | report:read:admin | UsageReport:Read |
meetingReports | report:read:admin | UsageReport:Read |
activityReport | report:read:admin | UsageReport:Read |
dailyReport | report:read:admin | UsageReport:Read |
webinarDetailReport | report:read:admin | UsageReport:Read |
webinarParticipantReports | report:read:admin | UsageReport:Read |
webinarPollReport | report:read:admin | UsageReport:Read |
webinarQAReport | report:read:admin | UsageReport:Read |
hostReports | report:read:admin | UsageReport:Read |
cloudRecordingReports | report:read:admin | UsageReport:Read |
operationLogsReports | report:read:admin | UsageReport:Read |
upcomingEventsReports | report:read:admin | UsageReport:Read |
billingReports | report:read:admin report:master | UsageReport:Read |
billingInvoiceReports | report:read:admin report:master | UsageReport:Read |
telephoneReports | report:read:admin | UsageReport:Read |
meetingParticipantReports | report:read:admin | UsageReport:Read |
Chat
| GraphQL Object | Scope | Permission |
|---|---|---|
userLevelChannel | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatChannel:Read |
deleteUserLevelChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
updateUserLevelChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
joinChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
leaveChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
channel | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
channels | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
accountChannels | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
channelMembers | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
createChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
deleteChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
updateChannel | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
removeAUserLevelChannelMember | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
batchRemoveChannelMembers | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
chatMessages | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatMessage:Read |
chatMessage | chat_channel:read chat_channel:read:admin chat_channel:write chat_channel:write:admin | ChatMessage:Read |
sendAChatMessage | chat_channel:write chat_channel:write:admin | ChatMessage:Edit |
editChatMessage | chat_channel:write chat_channel:write:admin | ChatMessage:Edit |
deleteChatMessage | chat_channel:write chat_channel:write:admin | ChatMessage:Edit |
reactChatMessage | chat_channel:write chat_channel:write:admin | ChatMessage:Edit |
updateChatMessageStatus | chat_channel:write chat_channel:write:admin | ChatMessage:Edit |
channelAdministrators | chat_channel:read chat_channel:read:admin | ChatChannel:Read |
inviteChannelMembers | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
removeChatChannelMembers | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
promoteChatChannelAdmins | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
demoteChatChannelAdmins | chat_channel:write chat_channel:write:admin | ChatChannel:Edit |
userContacts | chat_contact:read | |
userContactDetail | chat_contact:read | |
companyChatContacts | contact:read contact:read:admin | |
chatSessionReports | report_chat:read:admin imchat:read:admin | NewIMChatHistory:Read |
chatMessageReports | report_chat:read:admin imchat:read:admin | NewIMChatHistory:Read |
Groups
| GraphQL Object | Scope | Permission |
|---|---|---|
groups | group:read:admin group:write:admin | Group:Read |
group | group:read:admin group:write:admin | Group:Read |
createGroups | group:write:admin | Group:Edit |
deleteGroup | group:write:admin | Group:Edit |
updateGroup | group:write:admin | Group:Edit |
groupAdmins | group:read:admin group:write:admin | Group:Read |
groupMembers | group:read:admin group:write:admin | Group:Read |
createGroupAdmin | group:write:admin | Group:Edit |
deleteGroupAdmin | group:write:admin | Group:Edit |
createGroupMember | group:write:admin | Group:Edit |
deleteGroupMember | group:write:admin | Group:Edit |
updateGroupMember | group:write:admin | Group:Edit |
deleteVirtualBackGroundFiles | group:write:admin | Group:Edit |
Device
| GraphQL Object | Scope | Permission |
|---|---|---|
h323Devices | h323:read:admin h323:write:admin | RoomConnector:Read |
createH323Device | h323:write:admin | RoomConnector:Edit |
updateH323Device | h323:write:admin | RoomConnector:Edit |
deleteH323Device | h323:write:admin | RoomConnector:Edit |