Google Workspace API scopes

Google Workspace reference

Find the OAuth scopes needed for the Google Workspace tables and operations you use in NIM.

Use the connection guide's scope configurator to select operations and copy the scope list into Google Admin.

Table and operation scopesDirect link to Table and operation scopes

Scopes requested by each Google Workspace table and operation
NIM table	Connector operations	Requested OAuth scopes
Connection test	Test Connection; default authentication	`https://www.googleapis.com/auth/admin.directory.user`
`chromeosdevices`	`chromeosdevices_get`	`https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly`
`chromeosdevices`	`chromeosdevice_update` `chromeosdevice_action_update`	`https://www.googleapis.com/auth/admin.directory.device.chromeos`
`classroom_course_aliases`	`course_aliases_get`	`https://www.googleapis.com/auth/classroom.courses.readonly`
`classroom_course_aliases`	`course_aliases_create` `course_aliases_delete`	`https://www.googleapis.com/auth/classroom.courses`
`classroom_course_students`	`course_students_get`	`https://www.googleapis.com/auth/classroom.rosters.readonly`
`classroom_course_students`	`course_students_create` `course_students_delete`	`https://www.googleapis.com/auth/classroom.rosters`
`classroom_course_teachers`	`course_teachers_get`	`https://www.googleapis.com/auth/classroom.rosters.readonly`
`classroom_course_teachers`	`course_teachers_create` `course_teachers_delete`	`https://www.googleapis.com/auth/classroom.rosters`
`classroom_courses`	`courses_get`	`https://www.googleapis.com/auth/classroom.courses.readonly`
`classroom_courses`	`courses_create` `courses_update` `courses_delete`	`https://www.googleapis.com/auth/classroom.courses`
`classroom_invitations`	`course_invitations_get`	`https://www.googleapis.com/auth/classroom.rosters.readonly`
`classroom_invitations`	`course_invitations_create` `course_invitations_delete`	`https://www.googleapis.com/auth/classroom.rosters`
`classroom_userProfiles_guardianInvitations`	`userProfiles_guardianInvitations_get`	`https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`
`classroom_userProfiles_guardianInvitations`	`userProfiles_guardianInvitations_create`	`https://www.googleapis.com/auth/classroom.guardianlinks.students`
`classroom_userProfiles_guardians`	`userProfiles_guardians_get`	`https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`
`classroom_userProfiles_guardians`	`userProfiles_guardians_delete`	`https://www.googleapis.com/auth/classroom.guardianlinks.students`
`datatransfer_applications`	`datatransfer_applications_get`	`https://www.googleapis.com/auth/admin.datatransfer`
`datatransfer_transfers`	`datatransfer_transfers_get`	`https://www.googleapis.com/auth/admin.datatransfer.readonly`
`datatransfer_transfers`	`datatransfer_transfers_create` `datatransfer_transfers_create_drive_only` `datatransfer_transfers_create_calendar_only`	`https://www.googleapis.com/auth/admin.datatransfer`
`drive_drives`	`drives_drive_get`	`https://www.googleapis.com/auth/drive.readonly`
`drive_drives`	`drives_drive_create` `drives_drive_delete`	`https://www.googleapis.com/auth/drive`
`groups`	`groups_get`	`https://www.googleapis.com/auth/admin.directory.group.readonly`
`groups`	`group_create` `group_delete` `group_update`	`https://www.googleapis.com/auth/admin.directory.group`
`groups_aliases`	`groups_aliases_get`	`https://www.googleapis.com/auth/admin.directory.group.readonly`
`groups_aliases`	`group_alias_create` `group_alias_delete`	`https://www.googleapis.com/auth/admin.directory.group`
`groups_settings`	`groups_settings_get` `group_settings_update`	`https://www.googleapis.com/auth/apps.groups.settings`
`license_assignments`	`licenses_assignments_get` `license_assignment_create` `license_assignment_delete`	`https://www.googleapis.com/auth/apps.licensing`
`licenses`	`licenses_get`	None: connector-provided constant data; no API request.
`managers`	`managers_get`	`https://www.googleapis.com/auth/admin.directory.group.readonly`
`managers`	`manager_add` `manager_remove`	`https://www.googleapis.com/auth/admin.directory.group`
`members`	`members_get`	`https://www.googleapis.com/auth/admin.directory.group.readonly`
`members`	`member_add` `member_update` `member_remove`	`https://www.googleapis.com/auth/admin.directory.group`
`mobiledevices`	`mobiledevices_get`	`https://www.googleapis.com/auth/admin.directory.device.mobile.readonly`
`mobiledevices`	`mobiledevice_delete`	`https://www.googleapis.com/auth/admin.directory.device.mobile`
`orgunits`	`org_units_get`	`https://www.googleapis.com/auth/admin.directory.orgunit.readonly`
`orgunits`	`org_unit_create` `org_unit_delete` `org_unit_update`	`https://www.googleapis.com/auth/admin.directory.orgunit`
`owners`	`owners_get`	`https://www.googleapis.com/auth/admin.directory.group.readonly`
`owners`	`owner_add` `owner_remove`	`https://www.googleapis.com/auth/admin.directory.group`
`privileges`	`privileges_get`	`https://www.googleapis.com/auth/admin.directory.rolemanagement`
`roleAssignments`	`roleAssignment_create` `roleAssignment_delete` `roleAssignments_get`	`https://www.googleapis.com/auth/admin.directory.rolemanagement`
`roles`	`roles_get`	`https://www.googleapis.com/auth/admin.directory.rolemanagement`
`users`	`users_get`	`https://www.googleapis.com/auth/admin.directory.user.readonly`
`users`	`user_create` `user_delete` `user_email_add_uncached` `user_email_delete_uncached` `user_update_undelete` `user_update`	`https://www.googleapis.com/auth/admin.directory.user`
`users`	`user_gmail_settings_delegate_create_uncached` `user_gmail_settings_delegate_delete_uncached`	`https://www.googleapis.com/auth/gmail.settings.sharing`
`users`	`user_update_turnOfftwoStepVerification` `user_update_signOut`	`https://www.googleapis.com/auth/admin.directory.user.security`
`users_aliases`	`users_aliases_get`	`https://www.googleapis.com/auth/admin.directory.user.readonly`
`users_aliases`	`user_alias_create` `user_alias_delete`	`https://www.googleapis.com/auth/admin.directory.user`
`users_asps`	`users_asps_get` `users_asps_delete`	`https://www.googleapis.com/auth/admin.directory.user.security`
`users_gmail_labels`	`users_gmail_labels_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_labels`	`users_gmail_labels_create` `users_gmail_labels_update` `users_gmail_labels_delete`	`https://www.googleapis.com/auth/gmail.labels`
`users_gmail_profiles`	`users_gmail_profiles_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_autoforwarding`	`users_gmail_settings_autoforwarding_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_autoforwarding`	`users_gmail_settings_autoforwarding_update`	`https://www.googleapis.com/auth/gmail.settings.sharing`
`users_gmail_settings_delegates`	`users_gmail_settings_delegates_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_delegates`	`users_gmail_settings_delegate_create` `users_gmail_settings_delegate_delete`	`https://www.googleapis.com/auth/gmail.settings.sharing`
`users_gmail_settings_filters`	`users_gmail_settings_filters_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_filters`	`users_gmail_settings_filters_create` `users_gmail_settings_filters_delete`	`https://www.googleapis.com/auth/gmail.settings.basic`
`users_gmail_settings_forwardingAddresses`	`users_gmail_settings_forwardingAddresses_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_forwardingAddresses`	`users_gmail_settings_forwardingAddress_create` `users_gmail_settings_forwardingAddress_delete`	`https://www.googleapis.com/auth/gmail.settings.sharing`
`users_gmail_settings_imap`	`users_gmail_settings_imap_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_imap`	`users_gmail_settings_imap_update`	`https://www.googleapis.com/auth/gmail.settings.basic`
`users_gmail_settings_language`	`users_gmail_settings_language_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_language`	`users_gmail_settings_language_update`	`https://www.googleapis.com/auth/gmail.settings.basic`
`users_gmail_settings_pop`	`users_gmail_settings_pop_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_pop`	`users_gmail_settings_pop_update`	`https://www.googleapis.com/auth/gmail.settings.basic`
`users_gmail_settings_sendas`	`users_gmail_settings_sendas_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_sendas`	`users_gmail_settings_sendas_create` `users_gmail_settings_sendas_delete`	`https://www.googleapis.com/auth/gmail.settings.sharing`
`users_gmail_settings_sendas`	`users_gmail_settings_sendas_update`	`https://www.googleapis.com/auth/gmail.settings.basic`
`users_gmail_settings_vacation`	`users_gmail_settings_vacation_get`	`https://www.googleapis.com/auth/gmail.readonly`
`users_gmail_settings_vacation`	`users_gmail_settings_vacation_update`	`https://www.googleapis.com/auth/gmail.settings.basic`
`users_photos`	`users_photos_get`	`https://www.googleapis.com/auth/admin.directory.user.readonly`
`users_photos`	`users_photos_create` `users_photos_update` `users_photos_delete`	`https://www.googleapis.com/auth/admin.directory.user`
`users_tokens`	`users_tokens_get` `users_tokens_delete`	`https://www.googleapis.com/auth/admin.directory.user.security`
`users_verificationCodes`	`users_verificationCodes_get` `users_verificationCodes_create` `users_verificationCodes_delete`	`https://www.googleapis.com/auth/admin.directory.user.security`