Google Workspace · OAuth

Gmail, Calendar, and Drive permissions

OAuth scopes define what an app can read or change in a Google account. This reference lists every scope currently documented for Gmail, Google Calendar, and Google Drive.

Request the narrowest scopes your app needs. Public apps using sensitive or restricted scopes may need Google verification; restricted data stored or transmitted by a server can also require a security assessment.

ScopeWhat it allows
https://www.googleapis.com/auth/gmail.addons.current.action.composeManage drafts and send email while the user interacts with a Gmail add-on.
https://www.googleapis.com/auth/gmail.addons.current.message.actionView messages while the user interacts with a Gmail add-on.
https://www.googleapis.com/auth/gmail.labelsView and edit Gmail labels.
https://www.googleapis.com/auth/gmail.addons.current.message.metadataView message metadata while a Gmail add-on is running.
https://www.googleapis.com/auth/gmail.addons.current.message.readonlyView messages while a Gmail add-on is running.
https://www.googleapis.com/auth/gmail.sendSend email on the user's behalf.
https://mail.google.com/Read, compose, send, and permanently delete all Gmail data.
https://www.googleapis.com/auth/gmail.readonlyView email messages and Gmail settings.
https://www.googleapis.com/auth/gmail.composeCreate and manage drafts, and send email.
https://www.googleapis.com/auth/gmail.insertInsert email directly into the mailbox.
https://www.googleapis.com/auth/gmail.modifyRead, compose, send, and modify email without bypassing Trash for permanent deletion.
https://www.googleapis.com/auth/gmail.metadataView message metadata such as labels and headers, but not message bodies.
https://www.googleapis.com/auth/gmail.settings.basicView and change basic Gmail settings and filters.
https://www.googleapis.com/auth/gmail.settings.sharingManage sensitive sharing settings. Available only to Workspace administrators using domain-wide delegation.
20 scopes
ScopeWhat it allows
https://www.googleapis.com/auth/calendarSee, edit, share, and permanently delete every accessible calendar.
https://www.googleapis.com/auth/calendar.readonlyView and download accessible calendars.
https://www.googleapis.com/auth/calendar.freebusyView the user's availability.
https://www.googleapis.com/auth/calendar.eventsView and edit events on all accessible calendars.
https://www.googleapis.com/auth/calendar.events.readonlyView events on all accessible calendars.
https://www.googleapis.com/auth/calendar.settings.readonlyView Calendar settings.
https://www.googleapis.com/auth/calendar.addons.executeRun as a Calendar add-on.
https://www.googleapis.com/auth/calendar.addons.current.event.readView the event currently open in a Calendar add-on.
https://www.googleapis.com/auth/calendar.addons.current.event.writeEdit the event currently open in a Calendar add-on.
https://www.googleapis.com/auth/calendar.events.ownedView, create, change, and delete events on calendars the user owns.
https://www.googleapis.com/auth/calendar.events.owned.readonlyView events on calendars the user owns.
https://www.googleapis.com/auth/calendar.events.freebusyView availability on accessible calendars.
https://www.googleapis.com/auth/calendar.app.createdCreate secondary calendars and manage events on calendars created by the app.
https://www.googleapis.com/auth/calendar.calendarlistView, add, and remove calendars in the user's calendar list.
https://www.googleapis.com/auth/calendar.calendarlist.readonlyView the user's calendar list.
https://www.googleapis.com/auth/calendar.calendarsView and change calendar properties, and create secondary calendars.
https://www.googleapis.com/auth/calendar.calendars.readonlyView properties of accessible calendars.
https://www.googleapis.com/auth/calendar.aclsView and change sharing permissions for calendars the user owns.
https://www.googleapis.com/auth/calendar.acls.readonlyView sharing permissions for calendars the user owns.
https://www.googleapis.com/auth/calendar.events.public.readonlyView events on public calendars.
13 scopes
ScopeWhat it allows
https://www.googleapis.com/auth/drive.appdataView and manage the app's own configuration data in Drive.
https://www.googleapis.com/auth/drive.appfolderAlias of drive.appdata; view and manage the app's configuration data.
https://www.googleapis.com/auth/drive.installAllow the app to appear in Drive's Open with and New menus.
https://www.googleapis.com/auth/drive.fileCreate files and access only files the user opens with or shares with the app.
https://www.googleapis.com/auth/drive.apps.readonlyView apps authorized to access the user's Drive.
https://www.googleapis.com/auth/driveView and manage all the user's Drive files.
https://www.googleapis.com/auth/drive.readonlyView and download all the user's Drive files.
https://www.googleapis.com/auth/drive.activityView and add to the activity record of Drive files.
https://www.googleapis.com/auth/drive.activity.readonlyView the activity record of Drive files.
https://www.googleapis.com/auth/drive.meet.readonlyView Drive files created or edited by Google Meet.
https://www.googleapis.com/auth/drive.metadataView and manage metadata for Drive files.
https://www.googleapis.com/auth/drive.metadata.readonlyView metadata for Drive files.
https://www.googleapis.com/auth/drive.scriptsModify how Google Apps Script projects behave.