Back to Node Auth0

Interface ConnectionOptionsGoogleOAuth2

docs/interfaces/management.Management.ConnectionOptionsGoogleOAuth2.html

5.9.118.4 KB
Original Source

Interface ConnectionOptionsGoogleOAuth2

Options for the 'google-oauth2' connection

interface ConnectionOptionsGoogleOAuth2 {
non_persistent_attrs?: ConnectionNonPersistentAttrs;
allowed_audiences?: ConnectionAllowedAudiencesGoogleOAuth2;
client_id?: string;
client_secret?: string;
freeform_scopes?: ConnectionScopeArray;
icon_url?: string;
scope?: ConnectionScopeArray;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
upstream_params?: ConnectionUpstreamParams;
adsense_management?: boolean;
analytics?: boolean;
blogger?: boolean;
calendar?: boolean;
calendar_addons_execute?: boolean;
calendar_events?: boolean;
calendar_events_readonly?: boolean;
calendar_settings_readonly?: boolean;
chrome_web_store?: boolean;
contacts?: boolean;
contacts_new?: boolean;
contacts_other_readonly?: boolean;
contacts_readonly?: boolean;
content_api_for_shopping?: boolean;
coordinate?: boolean;
coordinate_readonly?: boolean;
directory_readonly?: boolean;
document_list?: boolean;
drive?: boolean;
drive_activity?: boolean;
drive_activity_readonly?: boolean;
drive_appdata?: boolean;
drive_apps_readonly?: boolean;
drive_file?: boolean;
drive_metadata?: boolean;
drive_metadata_readonly?: boolean;
drive_photos_readonly?: boolean;
drive_readonly?: boolean;
drive_scripts?: boolean;
email?: boolean;
gmail?: boolean;
gmail_compose?: boolean;
gmail_insert?: boolean;
gmail_labels?: boolean;
gmail_metadata?: boolean;
gmail_modify?: boolean;
gmail_new?: boolean;
gmail_readonly?: boolean;
gmail_send?: boolean;
gmail_settings_basic?: boolean;
gmail_settings_sharing?: boolean;
google_affiliate_network?: boolean;
google_books?: boolean;
google_cloud_storage?: boolean;
google_drive?: boolean;
google_drive_files?: boolean;
google_plus?: boolean;
latitude_best?: boolean;
latitude_city?: boolean;
moderator?: boolean;
offline_access?: boolean;
orkut?: boolean;
picasa_web?: boolean;
profile?: boolean;
sites?: boolean;
tasks?: boolean;
tasks_readonly?: boolean;
url_shortener?: boolean;
webmaster_tools?: boolean;
youtube?: boolean;
youtube_channelmemberships_creator?: boolean;
youtube_new?: boolean;
youtube_readonly?: boolean;
youtube_upload?: boolean;
youtubepartner?: boolean;
key: string: any;
}

Hierarchy (View Summary)

Indexable

Accepts any additional properties

Index

Properties

non_persistent_attrs?allowed_audiences?client_id?client_secret?freeform_scopes?icon_url?scope?set_user_root_attributes?upstream_params?adsense_management?analytics?blogger?calendar?calendar_addons_execute?calendar_events?calendar_events_readonly?calendar_settings_readonly?chrome_web_store?contacts?contacts_new?contacts_other_readonly?contacts_readonly?content_api_for_shopping?coordinate?coordinate_readonly?directory_readonly?document_list?drive?drive_activity?drive_activity_readonly?drive_appdata?drive_apps_readonly?drive_file?drive_metadata?drive_metadata_readonly?drive_photos_readonly?drive_readonly?drive_scripts?email?gmail?gmail_compose?gmail_insert?gmail_labels?gmail_metadata?gmail_modify?gmail_new?gmail_readonly?gmail_send?gmail_settings_basic?gmail_settings_sharing?google_affiliate_network?google_books?google_cloud_storage?google_drive?google_drive_files?google_plus?latitude_best?latitude_city?moderator?offline_access?orkut?picasa_web?profile?sites?tasks?tasks_readonly?url_shortener?webmaster_tools?youtube?youtube_channelmemberships_creator?youtube_new?youtube_readonly?youtube_upload?youtubepartner?

Properties

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

Optionalallowed_audiences

allowed_audiences?: ConnectionAllowedAudiencesGoogleOAuth2

Optionalclient_id

client_id?: string

Optionalclient_secret

client_secret?: string

Optionalfreeform_scopes

freeform_scopes?: ConnectionScopeArray

Optionalicon_url

icon_url?: string

Optionalscope

scope?: ConnectionScopeArray

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Optionaladsense_management

adsense_management?: boolean

View and manage user's ad applications, ad units, and channels in AdSense

Optionalanalytics

analytics?: boolean

View user's configuration information and reports

Optionalblogger

blogger?: boolean

View and manage user's posts and blogs on Blogger and Blogger comments

Optionalcalendar

calendar?: boolean

See, edit, share, and permanently delete all the calendars you can access using Google Calendar

Optionalcalendar_addons_execute

calendar_addons_execute?: boolean

Run as a Calendar add-on

Optionalcalendar_events

calendar_events?: boolean

View and edit events on all your calendars

Optionalcalendar_events_readonly

calendar_events_readonly?: boolean

View events on all your calendars

Optionalcalendar_settings_readonly

calendar_settings_readonly?: boolean

View your Calendar settings

Optionalchrome_web_store

chrome_web_store?: boolean

Read access to user's chrome web store

Optionalcontacts

contacts?: boolean

Full access to the authenticated user's contacts

Optionalcontacts_new

contacts_new?: boolean

Full access to the authenticated user's contacts

Optionalcontacts_other_readonly

contacts_other_readonly?: boolean

Read-only access to the authenticated user's 'Other contacts'

Optionalcontacts_readonly

contacts_readonly?: boolean

Read-only access to the authenticated user's contacts

Optionalcontent_api_for_shopping

content_api_for_shopping?: boolean

View and manage user's products, feeds, and subaccounts

Optionalcoordinate

coordinate?: boolean

Grants read and write access to the Coordinate API

Optionalcoordinate_readonly

coordinate_readonly?: boolean

Grants read access to the Coordinate API

Optionaldirectory_readonly

directory_readonly?: boolean

Read-only access to the authenticated user's corporate directory (if applicable)

Optionaldocument_list

document_list?: boolean

Access to Google Docs document list feed

Optionaldrive

drive?: boolean

Full access to all files and folders in the user's Google Drive

Optionaldrive_activity

drive_activity?: boolean

View and add to the activity record of files in your Drive

Optionaldrive_activity_readonly

drive_activity_readonly?: boolean

View the activity record of files in your Drive

Optionaldrive_appdata

drive_appdata?: boolean

Access to the application's configuration data in the user's Google Drive

Optionaldrive_apps_readonly

drive_apps_readonly?: boolean

View apps authorized to access your Drive

Optionaldrive_file

drive_file?: boolean

Access to files created or opened by the app

Optionaldrive_metadata

drive_metadata?: boolean

Access to file metadata, including listing files and folders

Optionaldrive_metadata_readonly

drive_metadata_readonly?: boolean

Read-only access to file metadata

Optionaldrive_photos_readonly

drive_photos_readonly?: boolean

Read-only access to the user's Google Photos

Optionaldrive_readonly

drive_readonly?: boolean

Read-only access to all files and folders in the user's Google Drive

Optionaldrive_scripts

drive_scripts?: boolean

Modify the behavior of Google Apps Scripts

Optionalemail

email?: boolean

Email and verified email flag

Optionalgmail

gmail?: boolean

Full access to the account's mailboxes, including permanent deletion of threads and messages

Optionalgmail_compose

gmail_compose?: boolean

Read all resources and their metadata—no write operations

Optionalgmail_insert

gmail_insert?: boolean

Insert and import messages only

Optionalgmail_labels

gmail_labels?: boolean

Create, read, update, and delete labels only

Optionalgmail_metadata

gmail_metadata?: boolean

Read resources metadata including labels, history records, and email message headers, but not the message body or attachments

Optionalgmail_modify

gmail_modify?: boolean

All read/write operations except immediate, permanent deletion of threads and messages, bypassing Trash

Optionalgmail_new

gmail_new?: boolean

Full access to the account's mailboxes, including permanent deletion of threads and messages

Optionalgmail_readonly

gmail_readonly?: boolean

Read all resources and their metadata—no write operations

Optionalgmail_send

gmail_send?: boolean

Send messages only. No read or modify privileges on mailbox

Optionalgmail_settings_basic

gmail_settings_basic?: boolean

Manage basic mail settings

Optionalgmail_settings_sharing

gmail_settings_sharing?: boolean

Manage sensitive mail settings, including forwarding rules and aliases. Note: Operations guarded by this scope are restricted to administrative use only

Optionalgoogle_affiliate_network

google_affiliate_network?: boolean

View and manage user's publisher data in the Google Affiliate Network

Optionalgoogle_books

google_books?: boolean

View and manage user's books and library in Google Books

Optionalgoogle_cloud_storage

google_cloud_storage?: boolean

View and manage user's data stored in Google Cloud Storage

Optionalgoogle_drive

google_drive?: boolean

Full access to all files and folders in the user's Google Drive

Optionalgoogle_drive_files

google_drive_files?: boolean

Access to files created or opened by the app

Optionalgoogle_plus

google_plus?: boolean

Associate user with its public Google profile

Optionallatitude_best

latitude_best?: boolean

View and manage user's best-available current location and location history in Google Latitude

Optionallatitude_city

latitude_city?: boolean

View and manage user's city-level current location and location history in Google Latitude

Optionalmoderator

moderator?: boolean

View and manage user's votes, topics, and submissions

Optionaloffline_access

offline_access?: boolean

Request a refresh token when the user authorizes your application

Optionalorkut

orkut?: boolean

View and manage user's friends, applications and profile and status

Optionalpicasa_web

picasa_web?: boolean

View and manage user's Google photos, videos, photo and video tags and comments

Optionalprofile

profile?: boolean

Name, public profile URL, photo, country, language, and timezone

Optionalsites

sites?: boolean

View and manage user's sites on Google Sites

Optionaltasks

tasks?: boolean

Full access to create, edit, organize, and delete all your tasks

Optionaltasks_readonly

tasks_readonly?: boolean

Read-only access to view your tasks and task lists

Optionalurl_shortener

url_shortener?: boolean

View, manage and view statistics user's short URLs

Optionalwebmaster_tools

webmaster_tools?: boolean

View and manage user's sites and messages, view keywords

Optionalyoutube

youtube?: boolean

Manage your YouTube account

Optionalyoutube_channelmemberships_creator

youtube_channelmemberships_creator?: boolean

See a list of your current active channel members, their current level, and when they became a member

Optionalyoutube_new

youtube_new?: boolean

Manage your YouTube account

Optionalyoutube_readonly

youtube_readonly?: boolean

View your YouTube account

Optionalyoutube_upload

youtube_upload?: boolean

Manage your YouTube videos

Optionalyoutubepartner

youtubepartner?: boolean

View and manage your assets and associated content on YouTube

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties non_persistent_attrsallowed_audiencesclient_idclient_secretfreeform_scopesicon_urlscopeset_user_root_attributesupstream_paramsadsense_managementanalyticsbloggercalendarcalendar_addons_executecalendar_eventscalendar_events_readonlycalendar_settings_readonlychrome_web_storecontactscontacts_newcontacts_other_readonlycontacts_readonlycontent_api_for_shoppingcoordinatecoordinate_readonlydirectory_readonlydocument_listdrivedrive_activitydrive_activity_readonlydrive_appdatadrive_apps_readonlydrive_filedrive_metadatadrive_metadata_readonlydrive_photos_readonlydrive_readonlydrive_scriptsemailgmailgmail_composegmail_insertgmail_labelsgmail_metadatagmail_modifygmail_newgmail_readonlygmail_sendgmail_settings_basicgmail_settings_sharinggoogle_affiliate_networkgoogle_booksgoogle_cloud_storagegoogle_drivegoogle_drive_filesgoogle_pluslatitude_bestlatitude_citymoderatoroffline_accessorkutpicasa_webprofilesitestaskstasks_readonlyurl_shortenerwebmaster_toolsyoutubeyoutube_channelmemberships_creatoryoutube_newyoutube_readonlyyoutube_uploadyoutubepartner