Auth0 Node.js SDK - v5.2.0
    Preparing search index...

    Interface ConnectionOptionsGoogleOAuth2

    Options for the 'google-oauth2' connection

    interface ConnectionOptionsGoogleOAuth2 {
        non_persistent_attrs?: ConnectionNonPersistentAttrs;
        adsense_management?: boolean;
        allowed_audiences?: ConnectionAllowedAudiencesGoogleOAuth2;
        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;
        client_id?: ConnectionClientIdGoogleOAuth2;
        client_secret?: ConnectionClientSecretGoogleOAuth2;
        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;
        freeform_scopes?: ConnectionScopeArray;
        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;
        icon_url?: string;
        latitude_best?: boolean;
        latitude_city?: boolean;
        moderator?: boolean;
        offline_access?: boolean;
        orkut?: boolean;
        picasa_web?: boolean;
        profile?: boolean;
        scope?: ConnectionScopeArray;
        set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
        sites?: boolean;
        tasks?: boolean;
        tasks_readonly?: boolean;
        upstream_params?: ConnectionUpstreamParams;
        url_shortener?: boolean;
        webmaster_tools?: boolean;
        youtube?: boolean;
        youtube_channelmemberships_creator?: boolean;
        youtube_new?: boolean;
        youtube_readonly?: boolean;
        youtube_upload?: boolean;
        youtubepartner?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    non_persistent_attrs? adsense_management? allowed_audiences? analytics? blogger? calendar? calendar_addons_execute? calendar_events? calendar_events_readonly? calendar_settings_readonly? chrome_web_store? client_id? client_secret? 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? freeform_scopes? 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? icon_url? latitude_best? latitude_city? moderator? offline_access? orkut? picasa_web? profile? scope? set_user_root_attributes? sites? tasks? tasks_readonly? upstream_params? url_shortener? webmaster_tools? youtube? youtube_channelmemberships_creator? youtube_new? youtube_readonly? youtube_upload? youtubepartner?

    Properties

    non_persistent_attrs?: ConnectionNonPersistentAttrs
    adsense_management?: boolean

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

    allowed_audiences?: ConnectionAllowedAudiencesGoogleOAuth2
    analytics?: boolean

    View user's configuration information and reports

    blogger?: boolean

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

    calendar?: boolean

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

    calendar_addons_execute?: boolean

    Run as a Calendar add-on

    calendar_events?: boolean

    View and edit events on all your calendars

    calendar_events_readonly?: boolean

    View events on all your calendars

    calendar_settings_readonly?: boolean

    View your Calendar settings

    chrome_web_store?: boolean

    Read access to user's chrome web store

    client_id?: ConnectionClientIdGoogleOAuth2
    client_secret?: ConnectionClientSecretGoogleOAuth2
    contacts?: boolean

    Full access to the authenticated user's contacts

    contacts_new?: boolean

    Full access to the authenticated user's contacts

    contacts_other_readonly?: boolean

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

    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

    coordinate?: boolean

    Grants read and write access to the Coordinate API

    coordinate_readonly?: boolean

    Grants read access to the Coordinate API

    directory_readonly?: boolean

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

    document_list?: boolean

    Access to Google Docs document list feed

    drive?: boolean

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

    drive_activity?: boolean

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

    drive_activity_readonly?: boolean

    View the activity record of files in your Drive

    drive_appdata?: boolean

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

    drive_apps_readonly?: boolean

    View apps authorized to access your Drive

    drive_file?: boolean

    Access to files created or opened by the app

    drive_metadata?: boolean

    Access to file metadata, including listing files and folders

    drive_metadata_readonly?: boolean

    Read-only access to file metadata

    drive_photos_readonly?: boolean

    Read-only access to the user's Google Photos

    drive_readonly?: boolean

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

    drive_scripts?: boolean

    Modify the behavior of Google Apps Scripts

    email?: boolean

    Email and verified email flag

    freeform_scopes?: ConnectionScopeArray
    gmail?: boolean

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

    gmail_compose?: boolean

    Read all resources and their metadata—no write operations

    gmail_insert?: boolean

    Insert and import messages only

    gmail_labels?: boolean

    Create, read, update, and delete labels only

    gmail_metadata?: boolean

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

    gmail_modify?: boolean

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

    gmail_new?: boolean

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

    gmail_readonly?: boolean

    Read all resources and their metadata—no write operations

    gmail_send?: boolean

    Send messages only. No read or modify privileges on mailbox

    gmail_settings_basic?: boolean

    Manage basic mail settings

    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

    google_affiliate_network?: boolean

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

    google_books?: boolean

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

    google_cloud_storage?: boolean

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

    google_drive?: boolean

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

    google_drive_files?: boolean

    Access to files created or opened by the app

    google_plus?: boolean

    Associate user with its public Google profile

    icon_url?: string
    latitude_best?: boolean

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

    latitude_city?: boolean

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

    moderator?: boolean

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

    offline_access?: boolean

    Request a refresh token when the user authorizes your application

    orkut?: boolean

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

    picasa_web?: boolean

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

    profile?: boolean

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

    scope?: ConnectionScopeArray
    set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum
    sites?: boolean

    View and manage user's sites on Google Sites

    tasks?: boolean

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

    tasks_readonly?: boolean

    Read-only access to view your tasks and task lists

    upstream_params?: ConnectionUpstreamParams
    url_shortener?: boolean

    View, manage and view statistics user's short URLs

    webmaster_tools?: boolean

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

    youtube?: boolean

    Manage your YouTube account

    youtube_channelmemberships_creator?: boolean

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

    youtube_new?: boolean

    Manage your YouTube account

    youtube_readonly?: boolean

    View your YouTube account

    youtube_upload?: boolean

    Manage your YouTube videos

    youtubepartner?: boolean

    View and manage your assets and associated content on YouTube

    Settings

    Member Visibility

    On This Page

    Properties
    non_persistent_attrsadsense_managementallowed_audiencesanalyticsbloggercalendarcalendar_addons_executecalendar_eventscalendar_events_readonlycalendar_settings_readonlychrome_web_storeclient_idclient_secretcontactscontacts_newcontacts_other_readonlycontacts_readonlycontent_api_for_shoppingcoordinatecoordinate_readonlydirectory_readonlydocument_listdrivedrive_activitydrive_activity_readonlydrive_appdatadrive_apps_readonlydrive_filedrive_metadatadrive_metadata_readonlydrive_photos_readonlydrive_readonlydrive_scriptsemailfreeform_scopesgmailgmail_composegmail_insertgmail_labelsgmail_metadatagmail_modifygmail_newgmail_readonlygmail_sendgmail_settings_basicgmail_settings_sharinggoogle_affiliate_networkgoogle_booksgoogle_cloud_storagegoogle_drivegoogle_drive_filesgoogle_plusicon_urllatitude_bestlatitude_citymoderatoroffline_accessorkutpicasa_webprofilescopeset_user_root_attributessitestaskstasks_readonlyupstream_paramsurl_shortenerwebmaster_toolsyoutubeyoutube_channelmemberships_creatoryoutube_newyoutube_readonlyyoutube_uploadyoutubepartner