Auth0 · Schema

ConnectionOptionsGoogleOAuth2

Options for the 'google-oauth2' connection

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM
View JSON Schema on GitHub

JSON Schema

auth0-connectionoptionsgoogleoauth2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionOptionsGoogleOAuth2",
  "title": "ConnectionOptionsGoogleOAuth2",
  "description": "Options for the 'google-oauth2' connection",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/ConnectionOptionsCommon"
    },
    {
      "type": "object",
      "properties": {
        "allowed_audiences": {
          "$ref": "#/components/schemas/ConnectionAllowedAudiencesGoogleOAuth2"
        },
        "client_id": {
          "$ref": "#/components/schemas/ConnectionClientIdGoogleOAuth2"
        },
        "client_secret": {
          "$ref": "#/components/schemas/ConnectionClientSecretGoogleOAuth2"
        },
        "freeform_scopes": {
          "$ref": "#/components/schemas/ConnectionFreeformScopesGoogleOAuth2"
        },
        "icon_url": {
          "$ref": "#/components/schemas/ConnectionIconUrlGoogleOAuth2"
        },
        "scope": {
          "$ref": "#/components/schemas/ConnectionScopeGoogleOAuth2"
        },
        "set_user_root_attributes": {
          "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
        },
        "upstream_params": {
          "$ref": "#/components/schemas/ConnectionUpstreamParams"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "adsense_management": {
          "type": "boolean",
          "description": "View and manage user's ad applications, ad units, and channels in AdSense"
        },
        "analytics": {
          "type": "boolean",
          "description": "View user's configuration information and reports"
        },
        "blogger": {
          "type": "boolean",
          "description": "View and manage user's posts and blogs on Blogger and Blogger comments"
        },
        "calendar": {
          "type": "boolean",
          "description": "See, edit, share, and permanently delete all the calendars you can access using Google Calendar"
        },
        "calendar_addons_execute": {
          "type": "boolean",
          "description": "Run as a Calendar add-on"
        },
        "calendar_events": {
          "type": "boolean",
          "description": "View and edit events on all your calendars"
        },
        "calendar_events_readonly": {
          "type": "boolean",
          "description": "View events on all your calendars"
        },
        "calendar_settings_readonly": {
          "type": "boolean",
          "description": "View your Calendar settings"
        },
        "chrome_web_store": {
          "type": "boolean",
          "description": "Read access to user's chrome web store"
        },
        "contacts": {
          "type": "boolean",
          "description": "Full access to the authenticated user's contacts"
        },
        "contacts_new": {
          "type": "boolean",
          "description": "Full access to the authenticated user's contacts"
        },
        "contacts_other_readonly": {
          "type": "boolean",
          "description": "Read-only access to the authenticated user's 'Other contacts'"
        },
        "contacts_readonly": {
          "type": "boolean",
          "description": "Read-only access to the authenticated user's contacts"
        },
        "content_api_for_shopping": {
          "type": "boolean",
          "description": "View and manage user's products, feeds, and subaccounts"
        },
        "coordinate": {
          "type": "boolean",
          "description": "Grants read and write access to the Coordinate API"
        },
        "coordinate_readonly": {
          "type": "boolean",
          "description": "Grants read access to the Coordinate API"
        },
        "directory_readonly": {
          "type": "boolean",
          "description": "Read-only access to the authenticated user's corporate directory (if applicable)"
        },
        "document_list": {
          "type": "boolean",
          "description": "Access to Google Docs document list feed"
        },
        "drive": {
          "type": "boolean",
          "description": "Full access to all files and folders in the user's Google Drive"
        },
        "drive_activity": {
          "type": "boolean",
          "description": "View and add to the activity record of files in your Drive"
        },
        "drive_activity_readonly": {
          "type": "boolean",
          "description": "View the activity record of files in your Drive"
        },
        "drive_appdata": {
          "type": "boolean",
          "description": "Access to the application's configuration data in the user's Google Drive"
        },
        "drive_apps_readonly": {
          "type": "boolean",
          "description": "View apps authorized to access your Drive"
        },
        "drive_file": {
          "type": "boolean",
          "description": "Access to files created or opened by the app"
        },
        "drive_metadata": {
          "type": "boolean",
          "description": "Access to file metadata, including listing files and folders"
        },
        "drive_metadata_readonly": {
          "type": "boolean",
          "description": "Read-only access to file metadata"
        },
        "drive_photos_readonly": {
          "type": "boolean",
          "description": "Read-only access to the user's Google Photos"
        },
        "drive_readonly": {
          "type": "boolean",
          "description": "Read-only access to all files and folders in the user's Google Drive"
        },
        "drive_scripts": {
          "type": "boolean",
          "description": "Modify the behavior of Google Apps Scripts"
        },
        "email": {
          "type": "boolean",
          "description": "Email and verified email flag"
        },
        "gmail": {
          "type": "boolean",
          "description": "Full access to the account's mailboxes, including permanent deletion of threads and messages"
        },
        "gmail_compose": {
          "type": "boolean",
          "description": "Read all resources and their metadata\u2014no write operations"
        },
        "gmail_insert": {
          "type": "boolean",
          "description": "Insert and import messages only"
        },
        "gmail_labels": {
          "type": "boolean",
          "description": "Create, read, update, and delete labels only"
        },
        "gmail_metadata": {
          "type": "boolean",
          "description": "Read resources metadata including labels, history records, and email message headers, but not the message body or attachments"
        },
        "gmail_modify": {
          "type": "boolean",
          "description": "All read/write operations except immediate, permanent deletion of threads and messages, bypassing Trash"
        },
        "gmail_new": {
          "type": "boolean",
          "description": "Full access to the account's mailboxes, including permanent deletion of threads and messages"
        },
        "gmail_readonly": {
          "type": "boolean",
          "description": "Read all resources and their metadata\u2014no write operations"
        },
        "gmail_send": {
          "type": "boolean",
          "description": "Send messages only. No read or modify privileges on mailbox"
        },
        "gmail_settings_basic": {
          "type": "boolean",
          "description": "Manage basic mail settings"
        },
        "gmail_settings_sharing": {
          "type": "boolean",
          "description": "Manage sensitive mail settings, including forwarding rules and aliases. Note: Operations guarded by this scope are restricted to administrative use only"
        },
        "google_affiliate_network": {
          "type": "boolean",
          "description": "View and manage user's publisher data in the Google Affiliate Network"
        },
        "google_books": {
          "type": "boolean",
          "description": "View and manage user's books and library in Google Books"
        },
        "google_cloud_storage": {
          "type": "boolean",
          "description": "View and manage user's data stored in Google Cloud Storage"
        },
        "google_drive": {
          "type": "boolean",
          "description": "Full access to all files and folders in the user's Google Drive"
        },
        "google_drive_files": {
          "type": "boolean",
          "description": "Access to files created or opened by the app"
        },
        "google_plus": {
          "type": "boolean",
          "description": "Associate user with its public Google profile"
        },
        "latitude_best": {
          "type": "boolean",
          "description": "View and manage user's best-available current location and location history in Google Latitude"
        },
        "latitude_city": {
          "type": "boolean",
          "description": "View and manage user's city-level current location and location history in Google Latitude"
        },
        "moderator": {
          "type": "boolean",
          "description": "View and manage user's votes, topics, and submissions"
        },
        "offline_access": {
          "type": "boolean",
          "description": "Request a refresh token when the user authorizes your application"
        },
        "orkut": {
          "type": "boolean",
          "description": "View and manage user's friends, applications and profile and status"
        },
        "picasa_web": {
          "type": "boolean",
          "description": "View and manage user's Google photos, videos, photo and video tags and comments"
        },
        "profile": {
          "type": "boolean",
          "description": "Name, public profile URL, photo, country, language, and timezone"
        },
        "sites": {
          "type": "boolean",
          "description": "View and manage user's sites on Google Sites"
        },
        "tasks": {
          "type": "boolean",
          "description": "Full access to create, edit, organize, and delete all your tasks"
        },
        "tasks_readonly": {
          "type": "boolean",
          "description": "Read-only access to view your tasks and task lists"
        },
        "url_shortener": {
          "type": "boolean",
          "description": "View, manage and view statistics user's short URLs"
        },
        "webmaster_tools": {
          "type": "boolean",
          "description": "View and manage user's sites and messages, view keywords"
        },
        "youtube": {
          "type": "boolean",
          "description": "Manage your YouTube account"
        },
        "youtube_channelmemberships_creator": {
          "type": "boolean",
          "description": "See a list of your current active channel members, their current level, and when they became a member"
        },
        "youtube_new": {
          "type": "boolean",
          "description": "Manage your YouTube account"
        },
        "youtube_readonly": {
          "type": "boolean",
          "description": "View your YouTube account"
        },
        "youtube_upload": {
          "type": "boolean",
          "description": "Manage your YouTube videos"
        },
        "youtubepartner": {
          "type": "boolean",
          "description": "View and manage your assets and associated content on YouTube"
        }
      }
    }
  ],
  "additionalProperties": true
}