gam7 7.17.0__tar.gz → 7.17.2__tar.gz

{gam7-7.17.0 → gam7-7.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gam7
-Version: 7.17.0
+Version: 7.17.2
 Summary: CLI tool to manage Google Workspace
 Project-URL: Homepage, https://github.com/GAM-team/GAM
 Project-URL: Issues, https://github.com/GAM-team/GAM/issues

{gam7-7.17.0 → gam7-7.17.2}/src/GamUpdate.txt

@@ -1,3 +1,15 @@
+7.17.02
+
+Updated `gam <UserTypeEntity> print|show webmastersites` to handle the following error
+that occurs if you haven't updated your project to include the Google Search Console API.
+```
+ERROR: 403: permissionDenied - Google Search Console API has not been used in project 111055363999 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/searchconsole.googleapis.com/overview?project=111055363999 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.
+```
+
+7.17.01
+
+Fixed bug in `gam <UserTypeEntity> show webmastersites` that caused a trap.
+
 7.17.00
 
 Added commands to discover Sites and WebResources that managed users (previously unmanaged) may have access to for better governance and visibility.

{gam7-7.17.0 → gam7-7.17.2}/src/gam/__init__.py

@@ -25,7 +25,7 @@ https://github.com/GAM-team/GAM/wiki
 """
 
 __author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
-__version__ = '7.17.00'
+__version__ = '7.17.02'
 __license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
 
 #pylint: disable=wrong-import-position
@@ -5688,19 +5688,22 @@ def getUserEmailFromID(uid, cd):
   try:
     result = callGAPI(cd.users(), 'get',
                       throwReasons=GAPI.USER_GET_THROW_REASONS,
+                      retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
                       userKey=uid, fields='primaryEmail')
     return result.get('primaryEmail')
   except (GAPI.userNotFound, GAPI.domainNotFound, GAPI.domainCannotUseApis, GAPI.forbidden,
-          GAPI.badRequest, GAPI.backendError, GAPI.systemError):
+          GAPI.badRequest, GAPI.backendError, GAPI.systemError, GAPI.serviceNotAvailable):
     return None
 
 def getGroupEmailFromID(uid, cd):
   try:
     result = callGAPI(cd.groups(), 'get',
                       throwReasons=GAPI.GROUP_GET_THROW_REASONS,
+                      retryReasons=GAPI.SERVICE_NOT_AVAILABLE_RETRY_REASONS,
                       groupKey=uid, fields='email')
     return result.get('email')
-  except (GAPI.groupNotFound, GAPI.domainNotFound, GAPI.domainCannotUseApis, GAPI.forbidden, GAPI.badRequest):
+  except (GAPI.groupNotFound, GAPI.domainNotFound, GAPI.domainCannotUseApis, GAPI.forbidden,
+          GAPI.badRequest, GAPI.serviceNotAvailable):
     return None
 
 def getServiceAccountEmailFromID(account_id, sal=None):
@@ -46963,8 +46966,8 @@ def doCreateSiteVerification():
   printKeyValueList(['Meta HTML Header Data', webserver_meta_record['token']])
   printBlankLine()
 
-def _showSiteVerificationInfo(site):
-  printKeyValueList(['Site', site['site']['identifier']])
+def _showSiteVerificationInfo(site, i=0, count=0):
+  printKeyValueListWithCount(['Site', site['site']['identifier']], i, count)
   Ind.Increment()
   printKeyValueList(['ID', unquote(site['id'])])
   printKeyValueList(['Type', site['site']['type']])
@@ -47072,8 +47075,11 @@ def doInfoSiteVerification():
   checkForExtraneousArguments()
   sites = callGAPIitems(verif.webResource(), 'list', 'items')
   if sites:
+    count = len(sites)
+    i = 0
     for site in sorted(sites, key=lambda k: (k['site']['type'], k['site']['identifier'])):
-      _showSiteVerificationInfo(site)
+      i += 1
+      _showSiteVerificationInfo(site, i, count)
   else:
     printKeyValueList(['No Sites Verified.'])
 
@@ -47101,7 +47107,7 @@ def printShowWebResources(users):
       j = 0
       for site in sorted(sites, key=lambda k: (k['site']['type'], k['site']['identifier'])):
         j += 1
-        _showSiteVerificationInfo(site)
+        _showSiteVerificationInfo(site, j, jcount)
       Ind.Decrement()
     else:
       for site in sites:
@@ -47126,7 +47132,11 @@ def printShowWebMasterSites(users):
     user, searchconsole = buildGAPIServiceObject(API.SEARCHCONSOLE, user, i, count)
     if not searchconsole:
       continue
-    sites = callGAPIitems(searchconsole.sites(), 'list', 'siteEntry')
+    try:
+      sites = callGAPIitems(searchconsole.sites(), 'list', 'siteEntry',
+                            throwReasons=[GAPI.PERMISSION_DENIED])
+    except GAPI.permissionDenied as e:
+      accessErrorExitNonDirectory(API.SEARCHCONSOLE, str(e))
     jcount = len(sites)
     if not csvPF:
       entityPerformActionNumItems([Ent.USER, user], jcount, Ent.WEB_MASTERSITE, i, count)
@@ -47134,7 +47144,10 @@ def printShowWebMasterSites(users):
       j = 0
       for site in sorted(sites, key=lambda k: k['siteUrl']):
         j += 1
-        _showSiteVerificationInfo(site)
+        printKeyValueListWithCount(['Site', site['siteUrl']], j, jcount)
+        Ind.Increment()
+        printKeyValueList(['permissionLevel', site['permissionLevel']])
+        Ind.Decrement()
       Ind.Decrement()
     else:
       for site in sites:

{gam7-7.17.0 → gam7-7.17.2}/wiki/GamUpdates.md

@@ -10,6 +10,21 @@ Add the `-s` option to the end of the above commands to suppress creating the `g
 
 See [Downloads-Installs-GAM7](https://github.com/GAM-team/GAM/wiki/Downloads-Installs) for Windows or other options, including manual installation
 
+### 7.17.01
+
+Fixed bug in `gam <UserTypeEntity> show webmastersites` that caused a trap.
+
+### 7.17.00
+
+Added commands to discover Sites and WebResources that managed users (previously unmanaged) may have access to for better governance and visibility.
+These are special purpose commands and will not generally be used.
+```
+gam <UserTypeEntity> show webresources
+gam <UserTypeEntity> print webresources [todrive <ToDriveAttribute>*]
+gam <UserTypeEntity> show webmastersites
+gam <UserTypeEntity> print webmastersites [todrive <ToDriveAttribute>*]
+```
+
 ### 7.16.01
 
 The Drive API now supports setting download restrictions on individual files.

{gam7-7.17.0 → gam7-7.17.2}/wiki/How-to-Upgrade-Legacy-GAM-to-GAM7.md

@@ -252,7 +252,7 @@ writes the credentials into the file oauth2.txt.
 admin@server:/Users/admin$ rm -f /Users/admin/GAMConfig/oauth2.txt
 admin@server:/Users/admin$ gam version
 WARNING: Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: /Users/admin/GAMConfig/oauth2.txt, Not Found
-GAM 7.16.01 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.17.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -990,7 +990,7 @@ writes the credentials into the file oauth2.txt.
 C:\>del C:\GAMConfig\oauth2.txt
 C:\>gam version
 WARNING: Config File: C:\GAMConfig\gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: C:\GAMConfig\oauth2.txt, Not Found
-GAM 7.16.01 - https://github.com/GAM-team/GAM - pythonsource
+GAM 7.17.01 - https://github.com/GAM-team/GAM - pythonsource
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 Windows-10-10.0.17134 AMD64

{gam7-7.17.0 → gam7-7.17.2}/wiki/Users-Drive-Files-Manage.md

@@ -125,7 +125,7 @@
         (folderColorRgb <ColorValue>)|
         (indexabletext <String>)|
         (inheritedpermissionsdisabled [<Boolean>])|
-        (itemdownloadrestriction (restrictedforreaders [<Boolean>]) (restrictedforwriters [<Boolean>]))|
+        (itemdownloadrestriction restrictedforreaders|restrictedforwriters [<Boolean>])|
         (keeprevisionforever|pinned)|
         (lastviewedbyme <Time>)|
         (mimetype <MimeType>)|

gam7-7.17.2/wiki/Users-Web-Resources-and-Sites.md

@@ -0,0 +1,48 @@
+# Users - Web Resources and Sites
+- [API documentation](#api-documentation)
+- [Introduction](#introduction)
+- [Definitions](#definitions)
+- [Display Web Resources](#display-web-resources)
+- [Display Web Sites](#display-web-sites)
+
+## API documentation
+* [Web Resources](https://developers.google.com/site-verification/v1/webResource/list)
+* [Web Sites](https://developers.google.com/webmaster-tools/v1/sites/list)
+
+
+## Introduction
+These features were added in version 7.17.00.
+
+To use these commands you add the 'Search Console API' to your project and update your service account authorization.
+```
+gam update project
+gam user user@domain.com update serviceaccount
+...
+[*] 39)  Search Console  API - read only
+[*] 42)  Site Verification API
+
+```
+## Definitions
+* [`<UserTypeEntity>`](Collections-of-Users)
+
+## Display Web Resources
+```
+gam <UserItem> show webresources
+```
+Gam displays the information as an indented list of keys and values.
+
+```
+gam <UserItem> print webresources [todrive <ToDriveAttribute>*]
+```
+Gam displays the information as columns of fields.
+
+## Display Web Sites
+```
+gam <UserItem> show websites
+```
+Gam displays the information as an indented list of keys and values.
+
+```
+gam <UserItem> print websites [todrive <ToDriveAttribute>*]
+```
+Gam displays the information as columns of fields.

{gam7-7.17.0 → gam7-7.17.2}/wiki/Version-and-Help.md

@@ -3,7 +3,7 @@
 Print the current version of Gam with details
 ```
 gam version
-GAM 7.16.01 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.17.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -15,7 +15,7 @@ Time: 2023-06-02T21:10:00-07:00
 Print the current version of Gam with details and time offset information
 ```
 gam version timeoffset
-GAM 7.16.01 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.17.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -27,7 +27,7 @@ Your system time differs from www.googleapis.com by less than 1 second
 Print the current version of Gam with extended details and SSL information
 ```
 gam version extended
-GAM 7.16.01 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.17.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64
@@ -64,7 +64,7 @@ MacOS High Sierra 10.13.6 x86_64
 Path: /Users/Admin/bin/gam7
 Version Check:
   Current: 5.35.08
-   Latest: 7.16.01
+   Latest: 7.17.01
 echo $?
 1
 ```
@@ -72,7 +72,7 @@ echo $?
 Print the current version number without details
 ```
 gam version simple
-7.16.01
+7.17.01
 ```
 In Linux/MacOS you can do:
 ```
@@ -82,7 +82,7 @@ echo $VER
 Print the current version of Gam and address of this Wiki
 ```
 gam help
-GAM 7.16.01 - https://github.com/GAM-team/GAM
+GAM 7.17.01 - https://github.com/GAM-team/GAM
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.5 64-bit final
 MacOS Sequoia 15.5 x86_64

{gam7-7.17.0 → gam7-7.17.2}/wiki/_Sidebar.md

@@ -174,6 +174,7 @@ Service Account Access
 * [Users - Tag Manager](Users-Tag-Manager)
 * [Users - Tasks](Users-Tasks)
 * [Users - YouTube](Users-YouTube)
+* [Users - Web Resources and Sites](Users-Web-Resources-and-Sites)
 
 GAM Tutorials
 * [Account Auditing](l-ExamplesAccountAuditing)