ConnectionOptionsGoogleApps

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionOptionsGoogleApps",
  "title": "ConnectionOptionsGoogleApps",
  "description": "Options for the 'google-apps' connection",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/ConnectionOptionsCommon"
    },
    {
      "type": "object",
      "required": [
        "client_id"
      ],
      "properties": {
        "admin_access_token": {
          "$ref": "#/components/schemas/ConnectionAdminAccessTokenGoogleApps"
        },
        "admin_access_token_expiresin": {
          "$ref": "#/components/schemas/ConnectionAdminAccessTokenExpiresInGoogleApps"
        },
        "admin_refresh_token": {
          "$ref": "#/components/schemas/ConnectionAdminRefreshTokenGoogleApps"
        },
        "allow_setting_login_scopes": {
          "type": "boolean",
          "description": "When true, allows customization of OAuth scopes requested during user login. Custom scopes are appended to the mandatory email and profile scopes. When false or omitted, only the default email and profile scopes are used. This property is automatically enabled when Token Vault or Connected Accounts features are activated.",
          "default": false
        },
        "api_enable_groups": {
          "$ref": "#/components/schemas/ConnectionApiEnableGroupsGoogleApps"
        },
        "api_enable_users": {
          "$ref": "#/components/schemas/ConnectionApiEnableUsersGoogleApps"
        },
        "client_id": {
          "$ref": "#/components/schemas/ConnectionClientIdGoogleApps"
        },
        "client_secret": {
          "$ref": "#/components/schemas/ConnectionClientSecretGoogleApps"
        },
        "domain": {
          "$ref": "#/components/schemas/ConnectionDomainGoogleApps"
        },
        "domain_aliases": {
          "$ref": "#/components/schemas/ConnectionDomainAliases"
        },
        "email": {
          "type": "boolean",
          "description": "Whether the OAuth flow requests the `email` scope.",
          "default": true
        },
        "ext_agreed_terms": {
          "$ref": "#/components/schemas/ConnectionExtAgreedTermsGoogleApps"
        },
        "ext_groups": {
          "$ref": "#/components/schemas/ConnectionExtGroupsGoogleApps"
        },
        "ext_groups_extended": {
          "type": "boolean",
          "description": "Controls whether enriched group entries include `id`, `email`, `name` (true) or only the group name (false); can only be set when `ext_groups` is true.",
          "default": true
        },
        "ext_is_admin": {
          "$ref": "#/components/schemas/ConnectionExtIsAdminGoogleApps"
        },
        "ext_is_suspended": {
          "$ref": "#/components/schemas/ConnectionExtIsSuspendedGoogleApps"
        },
        "federated_connections_access_tokens": {
          "$ref": "#/components/schemas/ConnectionFederatedConnectionsAccessTokens"
        },
        "handle_login_from_social": {
          "$ref": "#/components/schemas/ConnectionHandleLoginFromSocialGoogleApps"
        },
        "icon_url": {
          "$ref": "#/components/schemas/ConnectionIconUrlGoogleApps"
        },
        "map_user_id_to_id": {
          "type": "boolean",
          "description": "Determines how Auth0 generates the user_id for Google Workspace users. When false (default), the user's email address is used. When true, Google's stable numeric user ID is used instead, which persists even if the user's email changes. This setting can only be configured when creating the connection and cannot be changed afterward.",
          "default": false
        },
        "profile": {
          "type": "boolean",
          "description": "Whether the OAuth flow requests the `profile` scope.",
          "default": true
        },
        "scope": {
          "$ref": "#/components/schemas/ConnectionScopeGoogleApps"
        },
        "set_user_root_attributes": {
          "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
        },
        "tenant_domain": {
          "$ref": "#/components/schemas/ConnectionTenantDomainGoogleApps"
        },
        "upstream_params": {
          "$ref": "#/components/schemas/ConnectionUpstreamParams"
        }
      }
    }
  ],
  "additionalProperties": true
}