mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-29 18:31:38 +00:00
Compare commits
14 Commits
v7.08.00
...
20250604.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
27d4c37be3 | ||
|
|
a5818e144d | ||
|
|
4e6f1717fb | ||
|
|
9d347719c7 | ||
|
|
7235022a8e | ||
|
|
5db5dad576 | ||
|
|
72a6651a9f | ||
|
|
47f6dfc730 | ||
|
|
9e6c6138f8 | ||
|
|
c4ec856a58 | ||
|
|
2a32f6d2e4 | ||
|
|
afc6af68a4 | ||
|
|
80ec0a739b | ||
|
|
7a08fb0518 |
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
@@ -126,7 +126,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
cache.tar.xz
|
cache.tar.xz
|
||||||
key: gam-${{ matrix.jid }}-20250422
|
key: gam-${{ matrix.jid }}-20250603
|
||||||
|
|
||||||
- name: Untar Cache archive
|
- name: Untar Cache archive
|
||||||
if: matrix.goal == 'build' && steps.cache-python-ssl.outputs.cache-hit == 'true'
|
if: matrix.goal == 'build' && steps.cache-python-ssl.outputs.cache-hit == 'true'
|
||||||
|
|||||||
@@ -4820,7 +4820,8 @@ gam show shareddrives
|
|||||||
[formatjson] [noorgunits [<Boolean>]]
|
[formatjson] [noorgunits [<Boolean>]]
|
||||||
|
|
||||||
gam print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
gam print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
||||||
[shareddriveadminquery|query <QuerySharedDrive>]
|
[(shareddriveadminquery|query <QuerySharedDrive>) |
|
||||||
|
(shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
||||||
[orgunit|org|ou <OrgUnitPath>]
|
[orgunit|org|ou <OrgUnitPath>]
|
||||||
[matchname <REMatchPattern>]
|
[matchname <REMatchPattern>]
|
||||||
[domainlist <DomainList>]
|
[domainlist <DomainList>]
|
||||||
@@ -8337,7 +8338,9 @@ gam <UserTypeEntity> show shareddrives
|
|||||||
[formatjson]
|
[formatjson]
|
||||||
|
|
||||||
gam <UserTypeEntity> print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
gam <UserTypeEntity> print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
||||||
[adminaccess|asadmin] [shareddriveadminquery|query <QuerySharedDrive>]
|
[adminaccess|asadmin]
|
||||||
|
[(shareddriveadminquery|query <QuerySharedDrive>) |
|
||||||
|
(shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
||||||
[orgunit|org|ou <OrgUnitPath>]
|
[orgunit|org|ou <OrgUnitPath>]
|
||||||
[matchname <REMatchPattern>]
|
[matchname <REMatchPattern>]
|
||||||
[domainlist <DomainList>]
|
[domainlist <DomainList>]
|
||||||
|
|||||||
@@ -1,3 +1,35 @@
|
|||||||
|
7.08.03
|
||||||
|
|
||||||
|
Fixed bug in `gam <UserTypeEntity> check|update serviceaccount` where the first use of
|
||||||
|
the command after project creation enabled the following scopes that should be off by default.
|
||||||
|
```
|
||||||
|
Identity and Access Management API
|
||||||
|
Youtube API - read only
|
||||||
|
```
|
||||||
|
|
||||||
|
7.08.02
|
||||||
|
|
||||||
|
Updated the defaults in `gam print shareddriveorganizers` to match the most common use case, not the script.
|
||||||
|
|
||||||
|
* `domainlist` - The workspace primary domain
|
||||||
|
* `includetypes` - user
|
||||||
|
* `oneorganizer` - True
|
||||||
|
* `shownoorganizerdrives` - True
|
||||||
|
* `includefileorganizers` - False
|
||||||
|
|
||||||
|
To select organizers from any domain, use: `domainlist ""`
|
||||||
|
|
||||||
|
These commands produce the same result.
|
||||||
|
```
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers domainlist mydomain.com includetypes user oneorganizer shownoorganizerdrives
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers
|
||||||
|
```
|
||||||
|
|
||||||
|
7.08.01
|
||||||
|
|
||||||
|
Added option `shareddrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>))` to
|
||||||
|
`gam print shareddriveorganizers` that displays organizers for a specific list of Shared Drive IDs.
|
||||||
|
|
||||||
7.08.00
|
7.08.00
|
||||||
|
|
||||||
Added the following command that can be used instead of the `GetTeamDriveOrganizers.py` script.
|
Added the following command that can be used instead of the `GetTeamDriveOrganizers.py` script.
|
||||||
@@ -16,7 +48,7 @@ gam [<UserTypeEntity>] print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
|||||||
```
|
```
|
||||||
The command defaults match the script defaults:
|
The command defaults match the script defaults:
|
||||||
* `domainlist` - All domains
|
* `domainlist` - All domains
|
||||||
* `includetypes` - user,groups
|
* `includetypes` - user,group
|
||||||
* `oneorganizer` - False
|
* `oneorganizer` - False
|
||||||
* `shownoorganizerdrives` - True
|
* `shownoorganizerdrives` - True
|
||||||
* `includefileorganizers` - False
|
* `includefileorganizers` - False
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ https://github.com/GAM-team/GAM/wiki
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
__author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
|
__author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
|
||||||
__version__ = '7.08.00'
|
__version__ = '7.08.03'
|
||||||
__license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
|
__license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
|
||||||
|
|
||||||
#pylint: disable=wrong-import-position
|
#pylint: disable=wrong-import-position
|
||||||
@@ -4785,8 +4785,9 @@ def defaultSvcAcctScopes():
|
|||||||
scopesList = API.getSvcAcctScopesList(GC.Values[GC.USER_SERVICE_ACCOUNT_ACCESS_ONLY], False)
|
scopesList = API.getSvcAcctScopesList(GC.Values[GC.USER_SERVICE_ACCOUNT_ACCESS_ONLY], False)
|
||||||
saScopes = {}
|
saScopes = {}
|
||||||
for scope in scopesList:
|
for scope in scopesList:
|
||||||
saScopes.setdefault(scope['api'], [])
|
if not scope.get('offByDefault'):
|
||||||
saScopes[scope['api']].append(scope['scope'])
|
saScopes.setdefault(scope['api'], [])
|
||||||
|
saScopes[scope['api']].append(scope['scope'])
|
||||||
saScopes[API.DRIVEACTIVITY].append(API.DRIVE_SCOPE)
|
saScopes[API.DRIVEACTIVITY].append(API.DRIVE_SCOPE)
|
||||||
saScopes[API.DRIVE2] = saScopes[API.DRIVE3]
|
saScopes[API.DRIVE2] = saScopes[API.DRIVE3]
|
||||||
saScopes[API.DRIVETD] = saScopes[API.DRIVE3]
|
saScopes[API.DRIVETD] = saScopes[API.DRIVE3]
|
||||||
@@ -12275,7 +12276,7 @@ def checkServiceAccount(users):
|
|||||||
else:
|
else:
|
||||||
if not checkScopesSet:
|
if not checkScopesSet:
|
||||||
scopesList = API.getSvcAcctScopesList(GC.Values[GC.USER_SERVICE_ACCOUNT_ACCESS_ONLY], True)
|
scopesList = API.getSvcAcctScopesList(GC.Values[GC.USER_SERVICE_ACCOUNT_ACCESS_ONLY], True)
|
||||||
selectedScopes = getScopesFromUser(scopesList, False, GM.Globals[GM.SVCACCT_SCOPES])
|
selectedScopes = getScopesFromUser(scopesList, False, GM.Globals[GM.SVCACCT_SCOPES] if GM.Globals[GM.SVCACCT_SCOPES_DEFINED] else None)
|
||||||
if selectedScopes is None:
|
if selectedScopes is None:
|
||||||
return False
|
return False
|
||||||
i = 0
|
i = 0
|
||||||
@@ -12337,8 +12338,8 @@ def checkServiceAccount(users):
|
|||||||
if saTokenStatus == testFail:
|
if saTokenStatus == testFail:
|
||||||
invalidOauth2serviceJsonExit(f'Authentication{auth_error}')
|
invalidOauth2serviceJsonExit(f'Authentication{auth_error}')
|
||||||
_getSvcAcctData() # needed to read in GM.OAUTH2SERVICE_JSON_DATA
|
_getSvcAcctData() # needed to read in GM.OAUTH2SERVICE_JSON_DATA
|
||||||
if GM.Globals[GM.SVCACCT_SCOPES_DEFINED] and API.IAM not in GM.Globals[GM.SVCACCT_SCOPES]:
|
if API.IAM not in GM.Globals[GM.SVCACCT_SCOPES]:
|
||||||
GM.Globals[GM.SVCACCT_SCOPES][API.IAM] = [API.CLOUD_PLATFORM_SCOPE]
|
GM.Globals[GM.SVCACCT_SCOPES][API.IAM] = [API.IAM_SCOPE]
|
||||||
key_type = GM.Globals[GM.OAUTH2SERVICE_JSON_DATA].get('key_type', 'default')
|
key_type = GM.Globals[GM.OAUTH2SERVICE_JSON_DATA].get('key_type', 'default')
|
||||||
if key_type == 'default':
|
if key_type == 'default':
|
||||||
printMessage(Msg.SERVICE_ACCOUNT_CHECK_PRIVATE_KEY_AGE)
|
printMessage(Msg.SERVICE_ACCOUNT_CHECK_PRIVATE_KEY_AGE)
|
||||||
@@ -66053,7 +66054,9 @@ def doPrintShowSharedDriveACLs():
|
|||||||
PRINT_ORGANIZER_TYPES = {'group', 'user'}
|
PRINT_ORGANIZER_TYPES = {'group', 'user'}
|
||||||
|
|
||||||
# gam [<UserTypeEntity>] print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
# gam [<UserTypeEntity>] print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
||||||
# [adminaccess|asadmin] [shareddriveadminquery|query <QuerySharedDrive>]
|
# [adminaccess|asadmin]
|
||||||
|
# [(shareddriveadminquery|query <QuerySharedDrive>) |
|
||||||
|
# (shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
||||||
# [matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
# [matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
# [domainlist <DomainList>]
|
# [domainlist <DomainList>]
|
||||||
# [includetypes user|group]
|
# [includetypes user|group]
|
||||||
@@ -66068,16 +66071,24 @@ def printSharedDriveOrganizers(users, useDomainAdminAccess=False):
|
|||||||
includeTypes = set()
|
includeTypes = set()
|
||||||
showNoOrganizerDrives = SHOW_NO_PERMISSIONS_DRIVES_CHOICE_MAP['false']
|
showNoOrganizerDrives = SHOW_NO_PERMISSIONS_DRIVES_CHOICE_MAP['false']
|
||||||
fieldsList = ['role', 'type', 'emailAddress']
|
fieldsList = ['role', 'type', 'emailAddress']
|
||||||
cd = orgUnitId = query = matchPattern = None
|
cd = entityList = orgUnitId = query = matchPattern = None
|
||||||
domainList = []
|
domainList = [GC.Values[GC.DOMAIN]]
|
||||||
oneOrganizer = False
|
oneOrganizer = True
|
||||||
while Cmd.ArgumentsRemaining():
|
while Cmd.ArgumentsRemaining():
|
||||||
myarg = getArgument()
|
myarg = getArgument()
|
||||||
if csvPF and myarg == 'todrive':
|
if csvPF and myarg == 'todrive':
|
||||||
csvPF.GetTodriveParameters()
|
csvPF.GetTodriveParameters()
|
||||||
elif myarg == 'delimiter':
|
elif myarg == 'delimiter':
|
||||||
delimiter = getCharacter()
|
delimiter = getCharacter()
|
||||||
|
elif myarg in {'shareddrive', 'shareddrives', 'teamdrive', 'teamdrives'}:
|
||||||
|
sharedDriveArg = myarg
|
||||||
|
itemList = getString(Cmd.OB_SHAREDDRIVE_ID_LIST)
|
||||||
|
if itemList != 'select':
|
||||||
|
entityList = itemList.replace(',', ' ').split()
|
||||||
|
else:
|
||||||
|
entityList = getEntityList(Cmd.OB_SHAREDDRIVE_ID_LIST)
|
||||||
elif myarg in {'teamdriveadminquery', 'shareddriveadminquery', 'query'}:
|
elif myarg in {'teamdriveadminquery', 'shareddriveadminquery', 'query'}:
|
||||||
|
queryArg = myarg
|
||||||
queryLocation = Cmd.Location()
|
queryLocation = Cmd.Location()
|
||||||
query = getString(Cmd.OB_QUERY, minLen=0) or None
|
query = getString(Cmd.OB_QUERY, minLen=0) or None
|
||||||
if query:
|
if query:
|
||||||
@@ -66094,7 +66105,7 @@ def printSharedDriveOrganizers(users, useDomainAdminAccess=False):
|
|||||||
elif myarg in ADMIN_ACCESS_OPTIONS:
|
elif myarg in ADMIN_ACCESS_OPTIONS:
|
||||||
useDomainAdminAccess = True
|
useDomainAdminAccess = True
|
||||||
elif myarg == 'domainlist':
|
elif myarg == 'domainlist':
|
||||||
domainList = set(getString(Cmd.OB_DOMAIN_NAME_LIST).replace(',', ' ').lower().split())
|
domainList = set(getString(Cmd.OB_DOMAIN_NAME_LIST, minLen=0).replace(',', ' ').lower().split())
|
||||||
elif myarg == 'includetypes':
|
elif myarg == 'includetypes':
|
||||||
for itype in getString(Cmd.OB_ORGANIZER_TYPE_LIST).lower().replace(',', ' ').split():
|
for itype in getString(Cmd.OB_ORGANIZER_TYPE_LIST).lower().replace(',', ' ').split():
|
||||||
if itype in PRINT_ORGANIZER_TYPES:
|
if itype in PRINT_ORGANIZER_TYPES:
|
||||||
@@ -66110,16 +66121,20 @@ def printSharedDriveOrganizers(users, useDomainAdminAccess=False):
|
|||||||
roles.add('fileOrganizer')
|
roles.add('fileOrganizer')
|
||||||
else:
|
else:
|
||||||
unknownArgumentExit()
|
unknownArgumentExit()
|
||||||
if query and not useDomainAdminAccess:
|
if query:
|
||||||
Cmd.SetLocation(queryLocation-1)
|
if not useDomainAdminAccess:
|
||||||
usageErrorExit(Msg.ONLY_ADMINISTRATORS_CAN_PERFORM_SHARED_DRIVE_QUERIES)
|
Cmd.SetLocation(queryLocation-1)
|
||||||
|
usageErrorExit(Msg.ONLY_ADMINISTRATORS_CAN_PERFORM_SHARED_DRIVE_QUERIES)
|
||||||
|
if entityList:
|
||||||
|
Cmd.SetLocation(queryLocation-1)
|
||||||
|
usageErrorExit(Msg.ARE_MUTUALLY_EXCLUSIVE.format(queryArg, sharedDriveArg))
|
||||||
if orgUnitId is not None:
|
if orgUnitId is not None:
|
||||||
if not useDomainAdminAccess:
|
if not useDomainAdminAccess:
|
||||||
Cmd.SetLocation(orgLocation-1)
|
Cmd.SetLocation(orgLocation-1)
|
||||||
usageErrorExit(Msg.ONLY_ADMINISTRATORS_CAN_SPECIFY_SHARED_DRIVE_ORGUNIT)
|
usageErrorExit(Msg.ONLY_ADMINISTRATORS_CAN_SPECIFY_SHARED_DRIVE_ORGUNIT)
|
||||||
csvPF.AddTitles(['orgUnit', 'orgUnitId'])
|
csvPF.AddTitles(['orgUnit', 'orgUnitId'])
|
||||||
if not includeTypes:
|
if not includeTypes:
|
||||||
includeTypes = PRINT_ORGANIZER_TYPES
|
includeTypes = set(['user'])
|
||||||
fields = getItemFieldsFromFieldsList('permissions', fieldsList, True)
|
fields = getItemFieldsFromFieldsList('permissions', fieldsList, True)
|
||||||
i, count, users = getEntityArgument(users)
|
i, count, users = getEntityArgument(users)
|
||||||
for user in users:
|
for user in users:
|
||||||
@@ -66127,28 +66142,46 @@ def printSharedDriveOrganizers(users, useDomainAdminAccess=False):
|
|||||||
user, drive = buildGAPIServiceObject(API.DRIVE3, user, i, count)
|
user, drive = buildGAPIServiceObject(API.DRIVE3, user, i, count)
|
||||||
if not drive:
|
if not drive:
|
||||||
continue
|
continue
|
||||||
if useDomainAdminAccess:
|
if entityList is None:
|
||||||
printGettingAllAccountEntities(Ent.SHAREDDRIVE, query)
|
if useDomainAdminAccess:
|
||||||
pageMessage = getPageMessage()
|
printGettingAllAccountEntities(Ent.SHAREDDRIVE, query)
|
||||||
|
pageMessage = getPageMessage()
|
||||||
|
else:
|
||||||
|
printGettingAllEntityItemsForWhom(Ent.SHAREDDRIVE, user, i, count, query)
|
||||||
|
pageMessage = getPageMessageForWhom()
|
||||||
|
try:
|
||||||
|
feed = callGAPIpages(drive.drives(), 'list', 'drives',
|
||||||
|
pageMessage=pageMessage,
|
||||||
|
throwReasons=GAPI.DRIVE_USER_THROW_REASONS+[GAPI.INVALID_QUERY, GAPI.INVALID,
|
||||||
|
GAPI.QUERY_REQUIRES_ADMIN_CREDENTIALS,
|
||||||
|
GAPI.NO_LIST_TEAMDRIVES_ADMINISTRATOR_PRIVILEGE,
|
||||||
|
GAPI.FILE_NOT_FOUND],
|
||||||
|
q=query, useDomainAdminAccess=useDomainAdminAccess,
|
||||||
|
fields='nextPageToken,drives(id,name,createdTime,orgUnitId)', pageSize=100)
|
||||||
|
except (GAPI.invalidQuery, GAPI.invalid, GAPI.queryRequiresAdminCredentials,
|
||||||
|
GAPI.noListTeamDrivesAdministratorPrivilege, GAPI.fileNotFound) as e:
|
||||||
|
entityActionFailedWarning([Ent.USER, user, Ent.SHAREDDRIVE, None], str(e), i, count)
|
||||||
|
continue
|
||||||
|
except (GAPI.serviceNotAvailable, GAPI.authError, GAPI.domainPolicy) as e:
|
||||||
|
userDriveServiceNotEnabledWarning(user, str(e), i, count)
|
||||||
|
continue
|
||||||
else:
|
else:
|
||||||
printGettingAllEntityItemsForWhom(Ent.SHAREDDRIVE, user, i, count, query)
|
feed = []
|
||||||
pageMessage = getPageMessageForWhom()
|
jcount = len(entityList)
|
||||||
try:
|
j = 0
|
||||||
feed = callGAPIpages(drive.drives(), 'list', 'drives',
|
for driveId in entityList:
|
||||||
pageMessage=pageMessage,
|
j +=1
|
||||||
throwReasons=GAPI.DRIVE_USER_THROW_REASONS+[GAPI.INVALID_QUERY, GAPI.INVALID,
|
try:
|
||||||
GAPI.QUERY_REQUIRES_ADMIN_CREDENTIALS,
|
feed.append(callGAPI(drive.drives(), 'get',
|
||||||
GAPI.NO_LIST_TEAMDRIVES_ADMINISTRATOR_PRIVILEGE,
|
throwReasons=GAPI.DRIVE_USER_THROW_REASONS+[GAPI.NOT_FOUND],
|
||||||
GAPI.FILE_NOT_FOUND],
|
useDomainAdminAccess=useDomainAdminAccess,
|
||||||
q=query, useDomainAdminAccess=useDomainAdminAccess,
|
driveId=driveId, fields='id,name,createdTime,orgUnitId'))
|
||||||
fields='nextPageToken,drives(id,name,createdTime,orgUnitId)', pageSize=100)
|
except (GAPI.fileNotFound, GAPI.notFound) as e:
|
||||||
except (GAPI.invalidQuery, GAPI.invalid, GAPI.queryRequiresAdminCredentials,
|
entityActionNotPerformedWarning([Ent.USER, user, Ent.SHAREDDRIVE_ID, driveId], str(e), j, jcount)
|
||||||
GAPI.noListTeamDrivesAdministratorPrivilege, GAPI.fileNotFound) as e:
|
continue
|
||||||
entityActionFailedWarning([Ent.USER, user, Ent.SHAREDDRIVE, None], str(e), i, count)
|
except (GAPI.serviceNotAvailable, GAPI.authError, GAPI.domainPolicy) as e:
|
||||||
continue
|
userDriveServiceNotEnabledWarning(user, str(e), i, count)
|
||||||
except (GAPI.serviceNotAvailable, GAPI.authError, GAPI.domainPolicy) as e:
|
break
|
||||||
userDriveServiceNotEnabledWarning(user, str(e), i, count)
|
|
||||||
continue
|
|
||||||
matchFeed = []
|
matchFeed = []
|
||||||
jcount = len(feed)
|
jcount = len(feed)
|
||||||
j = 0
|
j = 0
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
# Copyright (C) 2024 Ross Scroggs All Rights Reserved.
|
# Copyright (C) 2025 Ross Scroggs All Rights Reserved.
|
||||||
#
|
#
|
||||||
# All Rights Reserved.
|
# All Rights Reserved.
|
||||||
#
|
#
|
||||||
@@ -596,7 +596,7 @@ _SVCACCT_SCOPES = [
|
|||||||
{'name': 'Cloud Identity Devices API',
|
{'name': 'Cloud Identity Devices API',
|
||||||
'api': CLOUDIDENTITY_DEVICES,
|
'api': CLOUDIDENTITY_DEVICES,
|
||||||
'subscopes': READONLY,
|
'subscopes': READONLY,
|
||||||
'scope': 'https://www.googleapis.com/auth/cloud-identity'},
|
'scope': 'https://www.googleapis.com/auth/cloud-identity.devices'},
|
||||||
# {'name': 'Cloud Identity User Invitations API',
|
# {'name': 'Cloud Identity User Invitations API',
|
||||||
# 'api': CLOUDIDENTITY_USERINVITATIONS,
|
# 'api': CLOUDIDENTITY_USERINVITATIONS,
|
||||||
# 'subscopes': READONLY,
|
# 'subscopes': READONLY,
|
||||||
@@ -647,8 +647,9 @@ _SVCACCT_SCOPES = [
|
|||||||
'scope': 'https://www.googleapis.com/auth/gmail.settings.sharing'},
|
'scope': 'https://www.googleapis.com/auth/gmail.settings.sharing'},
|
||||||
{'name': 'Identity and Access Management API',
|
{'name': 'Identity and Access Management API',
|
||||||
'api': IAM,
|
'api': IAM,
|
||||||
|
'offByDefault': True,
|
||||||
'subscopes': [],
|
'subscopes': [],
|
||||||
'scope': CLOUD_PLATFORM_SCOPE},
|
'scope': IAM_SCOPE},
|
||||||
{'name': 'Keep API',
|
{'name': 'Keep API',
|
||||||
'api': KEEP,
|
'api': KEEP,
|
||||||
'subscopes': READONLY,
|
'subscopes': READONLY,
|
||||||
|
|||||||
@@ -10,6 +10,60 @@ 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
|
See [Downloads-Installs-GAM7](https://github.com/GAM-team/GAM/wiki/Downloads-Installs) for Windows or other options, including manual installation
|
||||||
|
|
||||||
|
### 7.08.02
|
||||||
|
|
||||||
|
Updated the defaults in `gam print shareddriveorganizers` to match the most common use case, not the script.
|
||||||
|
|
||||||
|
* `domainlist` - The workspace primary domain
|
||||||
|
* `includetypes` - user
|
||||||
|
* `oneorganizer` - True
|
||||||
|
* `shownoorganizerdrives` - True
|
||||||
|
* `includefileorganizers` - False
|
||||||
|
|
||||||
|
To select organizers from any domain, use: `domainlist ""`
|
||||||
|
|
||||||
|
These commands produce the same result.
|
||||||
|
```
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers domainlist mydomain.com includetypes user oneorganizer shownoorganizerdrives
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers
|
||||||
|
```
|
||||||
|
|
||||||
|
### 7.08.01
|
||||||
|
|
||||||
|
Added option `shareddrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>))` to
|
||||||
|
`gam print shareddriveorganizers` that displays organizers for a specific list of Shared Drive IDs.
|
||||||
|
|
||||||
|
See: https://github.com/GAM-team/GAM/wiki/Shared-Drives#display-shared-drive-organizers
|
||||||
|
|
||||||
|
### 7.08.00
|
||||||
|
|
||||||
|
Added the following command that can be used instead of the `GetTeamDriveOrganizers.py` script.
|
||||||
|
|
||||||
|
gam [<UserTypeEntity>] print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
||||||
|
[adminaccessasadmin] [shareddriveadminquery|query <QuerySharedDrive>]
|
||||||
|
[orgunit|org|ou <OrgUnitPath>]
|
||||||
|
[matchname <REMatchPattern>]
|
||||||
|
[domainlist <DomainList>]
|
||||||
|
[includetypes <OrganizerTypeList>]
|
||||||
|
[oneorganizer [<Boolean>]]
|
||||||
|
[shownorganizerdrives [false|true|only]]
|
||||||
|
[includefileorganizers [<Boolean>]]
|
||||||
|
[delimiter <Character>]
|
||||||
|
```
|
||||||
|
See: https://github.com/GAM-team/GAM/wiki/Shared-Drives#display-shared-drive-organizers
|
||||||
|
|
||||||
|
The command defaults match the script defaults:
|
||||||
|
* `domainlist` - All domains
|
||||||
|
* `includetypes` - user,group
|
||||||
|
* `oneorganizer` - False
|
||||||
|
* `shownoorganizerdrives` - True
|
||||||
|
* `includefileorganizers` - False
|
||||||
|
|
||||||
|
For example, to get a single user organizer from your domain for all Shared Drives including no organizer drives:
|
||||||
|
```
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers domainlist mydomain.com includetypes user oneorganizer shownoorganizerdrives
|
||||||
|
```
|
||||||
|
|
||||||
### 7.07.17
|
### 7.07.17
|
||||||
|
|
||||||
Added option `oneuserperrow` to `gam print devices` to have each of a
|
Added option `oneuserperrow` to `gam print devices` to have each of a
|
||||||
|
|||||||
@@ -251,7 +251,7 @@ writes the credentials into the file oauth2.txt.
|
|||||||
admin@server:/Users/admin$ rm -f /Users/admin/GAMConfig/oauth2.txt
|
admin@server:/Users/admin$ rm -f /Users/admin/GAMConfig/oauth2.txt
|
||||||
admin@server:/Users/admin$ gam version
|
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
|
WARNING: Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: /Users/admin/GAMConfig/oauth2.txt, Not Found
|
||||||
GAM 7.07.17 - https://github.com/GAM-team/GAM - pyinstaller
|
GAM 7.08.02 - https://github.com/GAM-team/GAM - pyinstaller
|
||||||
GAM Team <google-apps-manager@googlegroups.com>
|
GAM Team <google-apps-manager@googlegroups.com>
|
||||||
Python 3.13.3 64-bit final
|
Python 3.13.3 64-bit final
|
||||||
MacOS Sequoia 15.5 x86_64
|
MacOS Sequoia 15.5 x86_64
|
||||||
@@ -989,7 +989,7 @@ writes the credentials into the file oauth2.txt.
|
|||||||
C:\>del C:\GAMConfig\oauth2.txt
|
C:\>del C:\GAMConfig\oauth2.txt
|
||||||
C:\>gam version
|
C:\>gam version
|
||||||
WARNING: Config File: C:\GAMConfig\gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: C:\GAMConfig\oauth2.txt, Not Found
|
WARNING: Config File: C:\GAMConfig\gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: C:\GAMConfig\oauth2.txt, Not Found
|
||||||
GAM 7.07.17 - https://github.com/GAM-team/GAM - pythonsource
|
GAM 7.08.02 - https://github.com/GAM-team/GAM - pythonsource
|
||||||
GAM Team <google-apps-manager@googlegroups.com>
|
GAM Team <google-apps-manager@googlegroups.com>
|
||||||
Python 3.13.3 64-bit final
|
Python 3.13.3 64-bit final
|
||||||
Windows-10-10.0.17134 AMD64
|
Windows-10-10.0.17134 AMD64
|
||||||
|
|||||||
@@ -15,6 +15,7 @@
|
|||||||
- [Display Shared Drive Counts](#display-shared-drive-counts)
|
- [Display Shared Drive Counts](#display-shared-drive-counts)
|
||||||
- [Display List of Shared Drives in an Organizational Unit](#display-list-of-shared-drives-in-an-organizational-unit)
|
- [Display List of Shared Drives in an Organizational Unit](#display-list-of-shared-drives-in-an-organizational-unit)
|
||||||
- [Display Count of Shared Drives in an Organizational Unit](#display-count-of-shared-drives-in-an-organizational-unit)
|
- [Display Count of Shared Drives in an Organizational Unit](#display-count-of-shared-drives-in-an-organizational-unit)
|
||||||
|
- [Display Shared Drive Organizers](#display-shared-drive-organizers)
|
||||||
- [Display all Shared Drives with no members](#display-all-shared-drives-with-no-members)
|
- [Display all Shared Drives with no members](#display-all-shared-drives-with-no-members)
|
||||||
- [Display all Shared Drives with no organizers](#display-all-shared-drives-with-no-organizers)
|
- [Display all Shared Drives with no organizers](#display-all-shared-drives-with-no-organizers)
|
||||||
- [Display all Shared Drives with a specific organizer](#display-all-shared-drives-with-a-specific-organizer)
|
- [Display all Shared Drives with a specific organizer](#display-all-shared-drives-with-a-specific-organizer)
|
||||||
@@ -78,6 +79,9 @@
|
|||||||
```
|
```
|
||||||
<JSONData> ::= (json [charset <Charset>] <String>) | (json file <FileName> [charset <Charset>]) |
|
<JSONData> ::= (json [charset <Charset>] <String>) | (json file <FileName> [charset <Charset>]) |
|
||||||
|
|
||||||
|
<OrganizerType> ::= user|group
|
||||||
|
<OrganizerTypeList> ::= "<OrganizerType>(,<OrganizerType>)*"
|
||||||
|
|
||||||
<OrgUnitID> ::= id:<String>
|
<OrgUnitID> ::= id:<String>
|
||||||
<OrgUnitPath> ::= /|(/<String>)+
|
<OrgUnitPath> ::= /|(/<String>)+
|
||||||
<OrgUnitItem> ::= <OrgUnitID>|<OrgUnitPath>
|
<OrgUnitItem> ::= <OrgUnitID>|<OrgUnitPath>
|
||||||
@@ -228,14 +232,14 @@ Three forms of the commands are available:
|
|||||||
|
|
||||||
## Display Shared Drive themes
|
## Display Shared Drive themes
|
||||||
```
|
```
|
||||||
gam show teamdrivethemes
|
gam show shareddrivethemes
|
||||||
```
|
```
|
||||||
## Manage Shared Drives
|
## Manage Shared Drives
|
||||||
|
|
||||||
## Create a Shared Drive
|
## Create a Shared Drive
|
||||||
The user that creates a Shared Drive is given the permission role organizer for the Shared Drive,
|
The user that creates a Shared Drive is given the permission role organizer for the Shared Drive,
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] create teamdrive <Name>
|
gam [<UserTypeEntity>] create shareddrive <Name>
|
||||||
[(theme|themeid <String>)|
|
[(theme|themeid <String>)|
|
||||||
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
||||||
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
||||||
@@ -244,7 +248,7 @@ gam [<UserTypeEntity>] create teamdrive <Name>
|
|||||||
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
||||||
[adminaccess|asadmin]
|
[adminaccess|asadmin]
|
||||||
```
|
```
|
||||||
* `themeid` - a Shared Drive themeId obtained from `show teamdrivethemes`
|
* `themeid` - a Shared Drive themeId obtained from `show shareddrivethemes`
|
||||||
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
||||||
* `<Float>` - X coordinate, typically 0.0
|
* `<Float>` - X coordinate, typically 0.0
|
||||||
* `<Float>` - Y coordinate, typically 0.0
|
* `<Float>` - Y coordinate, typically 0.0
|
||||||
@@ -277,9 +281,9 @@ When either of these options is chosen, no infomation about Shared Drive restric
|
|||||||
To retrieve the Shared Drive ID with `returnidonly`:
|
To retrieve the Shared Drive ID with `returnidonly`:
|
||||||
```
|
```
|
||||||
Linux/MacOS
|
Linux/MacOS
|
||||||
teamDriveId=$(gam create teamdrive ... returnidonly)
|
teamDriveId=$(gam create shareddrive ... returnidonly)
|
||||||
Windows PowerShell
|
Windows PowerShell
|
||||||
$teamDriveId = & gam create teamdrive ... returnidonly
|
$teamDriveId = & gam create shareddrive ... returnidonly
|
||||||
```
|
```
|
||||||
|
|
||||||
## Bulk Create Shared Drives
|
## Bulk Create Shared Drives
|
||||||
@@ -289,7 +293,7 @@ As a newly created Drive can't be updated for 30+ seconds; split the operation i
|
|||||||
|
|
||||||
Make a CSV file SharedDriveNames.csv with at least one column, name.
|
Make a CSV file SharedDriveNames.csv with at least one column, name.
|
||||||
```
|
```
|
||||||
gam redirect csv ./SharedDrivesCreated.csv multiprocess csv SharedDriveNames.csv gam create teamdrive "~name" csv
|
gam redirect csv ./SharedDrivesCreated.csv multiprocess csv SharedDriveNames.csv gam create shareddrive "~name" csv
|
||||||
```
|
```
|
||||||
This will create a three column CSV file SharedDrivesCreated.csv with columns: User,name,id
|
This will create a three column CSV file SharedDrivesCreated.csv with columns: User,name,id
|
||||||
* There will be a row for each Shared Drive.
|
* There will be a row for each Shared Drive.
|
||||||
@@ -320,14 +324,14 @@ gam redirect stdout ./StudentSharedDrivesAccess.txt multiprocess redirect stderr
|
|||||||
|
|
||||||
These commands are used to set basic Shared Drive settings.
|
These commands are used to set basic Shared Drive settings.
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] update teamdrive <SharedDriveEntity> [name <Name>]
|
gam [<UserTypeEntity>] update shareddrive <SharedDriveEntity> [name <Name>]
|
||||||
[adminaccess|asadmin]
|
[adminaccess|asadmin]
|
||||||
[(theme|themeid <String>)|
|
[(theme|themeid <String>)|
|
||||||
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
||||||
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
||||||
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
||||||
```
|
```
|
||||||
* `themeid` - a Shared Drive themeId obtained from `show teamdrivethemes`
|
* `themeid` - a Shared Drive themeId obtained from `show shareddrivethemes`
|
||||||
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
||||||
* `color` - set the Shared Drive color
|
* `color` - set the Shared Drive color
|
||||||
* `<SharedDriveRestrictionsSubfieldName> <Boolean>` - Set Shared Drive Restrictions
|
* `<SharedDriveRestrictionsSubfieldName> <Boolean>` - Set Shared Drive Restrictions
|
||||||
@@ -339,7 +343,7 @@ This option is only available when the command is run as an administrator.
|
|||||||
|
|
||||||
## Delete a Shared Drive
|
## Delete a Shared Drive
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] delete teamdrive <SharedDriveEntity>
|
gam [<UserTypeEntity>] delete shareddrive <SharedDriveEntity>
|
||||||
[adminaccess|asadmin] [allowitemdeletion]
|
[adminaccess|asadmin] [allowitemdeletion]
|
||||||
```
|
```
|
||||||
By default, deleting a Shared Drive that contains any files/folders will fail.
|
By default, deleting a Shared Drive that contains any files/folders will fail.
|
||||||
@@ -348,24 +352,24 @@ This is not reversible, proceed with caution.
|
|||||||
|
|
||||||
## Change Shared Drive visibility
|
## Change Shared Drive visibility
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] hide teamdrive <SharedDriveEntity>
|
gam [<UserTypeEntity>] hide shareddrive <SharedDriveEntity>
|
||||||
gam [<UserTypeEntity>] unhide teamdrive <SharedDriveEntity>
|
gam [<UserTypeEntity>] unhide shareddrive <SharedDriveEntity>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display Shared Drives
|
## Display Shared Drives
|
||||||
These commands are used to get information about Shared Drives themselves, not the files/folders on the Shared Drives.
|
These commands are used to get information about Shared Drives themselves, not the files/folders on the Shared Drives.
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] info teamdrive <SharedDriveEntity>
|
gam [<UserTypeEntity>] info shareddrive <SharedDriveEntity>
|
||||||
[adminaccess|asadmin]
|
[adminaccess|asadmin]
|
||||||
[fields <SharedDriveFieldNameList>] [formatjson]
|
[fields <SharedDriveFieldNameList>] [formatjson]
|
||||||
gam [<UserTypeEntity>] show teamdriveinfo <SharedDriveEntity>
|
gam [<UserTypeEntity>] show shareddriveinfo <SharedDriveEntity>
|
||||||
[adminaccess|asadmin]
|
[adminaccess|asadmin]
|
||||||
[fields <SharedDriveFieldNameList>] [formatjson]
|
[fields <SharedDriveFieldNameList>] [formatjson]
|
||||||
```
|
```
|
||||||
By default, Gam displays the information as an indented list of keys and values.
|
By default, Gam displays the information as an indented list of keys and values.
|
||||||
* `formatjson` - Display the fields in JSON format.
|
* `formatjson` - Display the fields in JSON format.
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] show teamdrives
|
gam [<UserTypeEntity>] show shareddrives
|
||||||
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
||||||
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
[fields <SharedDriveFieldNameList>] [formatjson]
|
[fields <SharedDriveFieldNameList>] [formatjson]
|
||||||
@@ -378,7 +382,7 @@ By default, all Shared Drives are displayed; use the following options to select
|
|||||||
By default, Gam displays the information as an indented list of keys and values.
|
By default, Gam displays the information as an indented list of keys and values.
|
||||||
* `formatjson` - Display the fields in JSON format.
|
* `formatjson` - Display the fields in JSON format.
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] print teamdrives [todrive <ToDriveAttribute>*]
|
gam [<UserTypeEntity>] print shareddrives [todrive <ToDriveAttribute>*]
|
||||||
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
||||||
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
[fields <SharedDriveFieldNameList>] [formatjson [quotechar <Character>]]
|
[fields <SharedDriveFieldNameList>] [formatjson [quotechar <Character>]]
|
||||||
@@ -400,22 +404,67 @@ The `quotechar <Character>` option allows you to choose an alternate quote chara
|
|||||||
### Examples
|
### Examples
|
||||||
Print information about all Shared Drives in the organization.
|
Print information about all Shared Drives in the organization.
|
||||||
```
|
```
|
||||||
gam print teamdrives
|
gam print shareddrives
|
||||||
gam user admin@domain.com print teamdrives adminaccess
|
gam user admin@domain.com print shareddrives adminaccess
|
||||||
```
|
```
|
||||||
Print information about Shared Drives that have admin@domain.com as a member.
|
Print information about Shared Drives that have admin@domain.com as a member.
|
||||||
```
|
```
|
||||||
gam user admin@domain.com print teamdrives
|
gam user admin@domain.com print shareddrives
|
||||||
|
```
|
||||||
|
|
||||||
|
## Display Shared Drive Organizers
|
||||||
|
The following command can be used instead of the `GetTeamDriveOrganizers.py` script.
|
||||||
|
|
||||||
|
```
|
||||||
|
gam [<UserTypeEntity>] print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
||||||
|
[adminaccess|asadmin]
|
||||||
|
[(shareddriveadminquery|query <QuerySharedDrive>) |
|
||||||
|
(shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
||||||
|
[orgunit|org|ou <OrgUnitPath>]
|
||||||
|
[matchname <REMatchPattern>]
|
||||||
|
[domainlist <DomainList>]
|
||||||
|
[includetypes <OrganizerTypeList>]
|
||||||
|
[oneorganizer [<Boolean>]]
|
||||||
|
[shownorganizerdrives [false|true|only]]
|
||||||
|
[includefileorganizers [<Boolean>]]
|
||||||
|
[delimiter <Character>]
|
||||||
|
```
|
||||||
|
Options `shareddriveadminquery|query` and `shareddrives|teamdrives` are mutually exclusive.
|
||||||
|
|
||||||
|
Options `shareddriveadminquery|query` and `orgunit|org|ou` require `adminaccess|asadmin`.
|
||||||
|
|
||||||
|
By default, organizers for all Shared Drives are displayed; use the following options to select a subset of Shared Drives:
|
||||||
|
* `teamdriveadminquery|query <QueryTeamDrive>` - Use a query to select Shared Drives
|
||||||
|
* `shareddrives|teamdrives <SharedDriveIDList>` - Select the Shared Drive IDs specified in `<SharedDriveIDList>`
|
||||||
|
* `shareddrives|teamdrives select <FileSelector>|<CSVFileSelector>` - Select the Shared Drive IDs specified in `<FileSelector>|<CSVFileSelector>`
|
||||||
|
* `orgunit|org|ou <OrgUnitPath>` - Only Shared Drives in the specified Org Unit are selected
|
||||||
|
* `matchname <REMatchPattern>` - Retrieve Shared Drives with names that match a pattern.
|
||||||
|
|
||||||
|
For multiple organizers:
|
||||||
|
* `delimiter <Character>` - Separate `organizers` entries with `<Character>`; the default value is `csv_output_field_delimiter` from `gam.cfg`.
|
||||||
|
|
||||||
|
The command defaults do not match the script defaults, they are set for the most common use case:
|
||||||
|
* `domainlist` - The workspace primary domain
|
||||||
|
* `includetypes` - user
|
||||||
|
* `oneorganizer` - True
|
||||||
|
* `shownoorganizerdrives` - True
|
||||||
|
* `includefileorganizers` - False
|
||||||
|
|
||||||
|
To select organizers from any domain, use: `domainlist ""`
|
||||||
|
|
||||||
|
For example, to get a single user organizer from your domain for all Shared Drives including no organizer drives:
|
||||||
|
```
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display all Shared Drives with no members
|
## Display all Shared Drives with no members
|
||||||
```
|
```
|
||||||
gam print teamdrives query "memberCount = 0"
|
gam print shareddrives query "memberCount = 0"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display all Shared Drives with no organizers
|
## Display all Shared Drives with no organizers
|
||||||
```
|
```
|
||||||
gam print teamdrives query "organizerCount = 0"
|
gam print shareddrives query "organizerCount = 0"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display Shared Drive Counts
|
## Display Shared Drive Counts
|
||||||
@@ -451,20 +500,20 @@ count = & gam print shareddrives showitemcountonly
|
|||||||
## Display all Shared Drives with a specific organizer
|
## Display all Shared Drives with a specific organizer
|
||||||
Substitute actual email address for `organizer@domain.com`.
|
Substitute actual email address for `organizer@domain.com`.
|
||||||
```
|
```
|
||||||
gam config csv_output_header_filter "id,name" print teamdriveacls pm emailaddress organizer@domain.com role organizer em pma process pmselect
|
gam config csv_output_header_filter "id,name" print shareddriveacls pm emailaddress organizer@domain.com role organizer em pma process pmselect
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display all Shared Drives without a specific organizer
|
## Display all Shared Drives without a specific organizer
|
||||||
Substitute actual email address for `organizer@domain.com`.
|
Substitute actual email address for `organizer@domain.com`.
|
||||||
```
|
```
|
||||||
gam config csv_output_header_filter "id,name" print teamdriveacls pm emailaddress organizer@domain.com role organizer em pma skip pmselect
|
gam config csv_output_header_filter "id,name" print shareddriveacls pm emailaddress organizer@domain.com role organizer em pma skip pmselect
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display List of Shared Drives in an Organizational Unit
|
## Display List of Shared Drives in an Organizational Unit
|
||||||
Get the orgUnitID of the desired OU and use it (without the id:) in the print|show command. Adjust fields as desired.
|
Get the orgUnitID of the desired OU and use it (without the id:) in the print|show command. Adjust fields as desired.
|
||||||
```
|
```
|
||||||
gam show teamdrives query "orgUnitId='03ph8a2z21rexy'" fields id,name,orgunit,createdtime
|
gam show shareddrives query "orgUnitId='03ph8a2z21rexy'" fields id,name,orgunit,createdtime
|
||||||
gam print teamdrives query "orgUnitId='03ph8a2z21rexy'" fields id,name,orgunit,createdtime
|
gam print shareddrives query "orgUnitId='03ph8a2z21rexy'" fields id,name,orgunit,createdtime
|
||||||
```
|
```
|
||||||
Alternative method; `<OrgUnitPath>` defaults to `/`.
|
Alternative method; `<OrgUnitPath>` defaults to `/`.
|
||||||
```
|
```
|
||||||
@@ -552,12 +601,12 @@ These commands are used to transfer ACLs from one Shared Drive to another.
|
|||||||
* `copy` - Copy all ACLs from the source Shared Drive to the target Shared Drive. The role of an existing ACL in the target Shared Drive will never be reduced.
|
* `copy` - Copy all ACLs from the source Shared Drive to the target Shared Drive. The role of an existing ACL in the target Shared Drive will never be reduced.
|
||||||
* `sync` - Add/delete/update ACLs in the target Shared Drive to match those in the source Shared Drive.
|
* `sync` - Add/delete/update ACLs in the target Shared Drive to match those in the source Shared Drive.
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] copy teamdriveacls <SharedDriveEntity> to <SharedDriveEntity>
|
gam [<UserTypeEntity>] copy shareddriveacls <SharedDriveEntity> to <SharedDriveEntity>
|
||||||
[showpermissionsmessages [<Boolean>]]
|
[showpermissionsmessages [<Boolean>]]
|
||||||
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
||||||
(mappermissionsdomain <DomainName> <DomainName>)*
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
||||||
[adminaccess|asadmin]
|
[adminaccess|asadmin]
|
||||||
gam [<UserTypeEntity>] sync teamdriveacls <SharedDriveEntity> with <SharedDriveEntity>
|
gam [<UserTypeEntity>] sync shareddriveacls <SharedDriveEntity> with <SharedDriveEntity>
|
||||||
[showpermissionsmessages [<Boolean>]]
|
[showpermissionsmessages [<Boolean>]]
|
||||||
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
||||||
(mappermissionsdomain <DomainName> <DomainName>)*
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
||||||
@@ -595,7 +644,7 @@ gam [<UserTypeEntity>] print drivefileacls <SharedDriveEntityAdmin> [todrive <To
|
|||||||
### Examples:
|
### Examples:
|
||||||
Find all the organizers and file organizers on the Golgafrincham shared drive in CSV form.
|
Find all the organizers and file organizers on the Golgafrincham shared drive in CSV form.
|
||||||
```
|
```
|
||||||
gam print drivefileacls teamdrive "Golgafrincham" pm role organizer em pm role fileorganizer em oneitemperrow
|
gam print drivefileacls shareddrive "Golgafrincham" pm role organizer em pm role fileorganizer em oneitemperrow
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, all Shared Drives specified are displayed; use the following option to select a subset of those Shared Drives.
|
By default, all Shared Drives specified are displayed; use the following option to select a subset of those Shared Drives.
|
||||||
@@ -626,7 +675,7 @@ gam config csv_output_header_drop_filter "User,createdTime,permission.photoLink,
|
|||||||
|
|
||||||
## Display Shared Drive access for selected Shared Drives
|
## Display Shared Drive access for selected Shared Drives
|
||||||
```
|
```
|
||||||
gam [<UserTypeEntity>] show teamdriveacls
|
gam [<UserTypeEntity>] show shareddriveacls
|
||||||
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
||||||
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
||||||
@@ -635,7 +684,7 @@ gam [<UserTypeEntity>] show teamdriveacls
|
|||||||
[shownopermissionsdrives false|true|only]
|
[shownopermissionsdrives false|true|only]
|
||||||
[formatjson]
|
[formatjson]
|
||||||
|
|
||||||
gam [<UserTypeEntity>] print teamdriveacls [todrive <ToDriveAttribute>*]
|
gam [<UserTypeEntity>] print shareddriveacls [todrive <ToDriveAttribute>*]
|
||||||
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
||||||
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
||||||
@@ -662,7 +711,7 @@ By default, all ACLS are displayed; use the following options to select a subset
|
|||||||
* `role|roles <SharedDriveACLRoleList>` - Display ACLs for the specified roles only.
|
* `role|roles <SharedDriveACLRoleList>` - Display ACLs for the specified roles only.
|
||||||
* `<PermissionMatch>* [<PermissionMatchAction>]` - Use permission matching to display a subset of the ACLs for each Shared Drive; this only applies when `pmselect` is not specified
|
* `<PermissionMatch>* [<PermissionMatchAction>]` - Use permission matching to display a subset of the ACLs for each Shared Drive; this only applies when `pmselect` is not specified
|
||||||
|
|
||||||
With `print teamdriveacls` or `show teamdrivecls formatjson`, the ACLs selected for display are all output on one row/line as a repeating item with the matching Shared Drive id.
|
With `print shareddriveacls` or `show shareddrivecls formatjson`, the ACLs selected for display are all output on one row/line as a repeating item with the matching Shared Drive id.
|
||||||
When `oneitemperrow` is specified, each ACL is output on a separate row/line with the matching Shared Drive id and name. This simplifies processing the CSV file with subsequent Gam commands.
|
When `oneitemperrow` is specified, each ACL is output on a separate row/line with the matching Shared Drive id and name. This simplifies processing the CSV file with subsequent Gam commands.
|
||||||
|
|
||||||
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
||||||
@@ -674,35 +723,35 @@ The `quotechar <Character>` option allows you to choose an alternate quote chara
|
|||||||
### Examples
|
### Examples
|
||||||
Find all organizers and viewers on the shared drive Heart of Gold in CSV form.
|
Find all organizers and viewers on the shared drive Heart of Gold in CSV form.
|
||||||
```
|
```
|
||||||
gam print teamdriveacls matchname "Heart of Gold" role organizer,reader oneitemperrow
|
gam print shareddriveacls matchname "Heart of Gold" role organizer,reader oneitemperrow
|
||||||
```
|
```
|
||||||
|
|
||||||
Print ACLs for all Shared Drives in the organization created after November 1, 2017.
|
Print ACLs for all Shared Drives in the organization created after November 1, 2017.
|
||||||
```
|
```
|
||||||
gam print teamdriveacls teamdriveadminquery "createdTime > '2017-11-01T00:00:00'"
|
gam print shareddriveacls shareddriveadminquery "createdTime > '2017-11-01T00:00:00'"
|
||||||
```
|
```
|
||||||
|
|
||||||
Print ACLs for all Shared Drives in the organization with foo@bar.com as an organizer.
|
Print ACLs for all Shared Drives in the organization with foo@bar.com as an organizer.
|
||||||
```
|
```
|
||||||
gam print teamdriveacls user foo@bar.com role organizer
|
gam print shareddriveacls user foo@bar.com role organizer
|
||||||
```
|
```
|
||||||
|
|
||||||
Print ACLs for all Shared Drives in the organization with foo@bar.com or groups that contain foo@bar.com as a reader.
|
Print ACLs for all Shared Drives in the organization with foo@bar.com or groups that contain foo@bar.com as a reader.
|
||||||
```
|
```
|
||||||
gam print teamdriveacls user foo@bar.com role reader checkgroups
|
gam print shareddriveacls user foo@bar.com role reader checkgroups
|
||||||
```
|
```
|
||||||
|
|
||||||
## Display ACLs for Shared Drives with no organizers
|
## Display ACLs for Shared Drives with no organizers
|
||||||
### For all Shared Drives
|
### For all Shared Drives
|
||||||
```
|
```
|
||||||
One row per Shared Drive, all ACLs on the same row
|
One row per Shared Drive, all ACLs on the same row
|
||||||
gam redirect csv ./SharedDriveACLsNoOrganizers.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted query "organizerCount = 0"
|
gam redirect csv ./SharedDriveACLsNoOrganizers.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted query "organizerCount = 0"
|
||||||
|
|
||||||
A row per Shared Drive/ACL combination
|
A row per Shared Drive/ACL combination
|
||||||
gam redirect csv ./SharedDriveACLsNoOrganizers.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted query "organizerCount = 0" oneitemperrow
|
gam redirect csv ./SharedDriveACLsNoOrganizers.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted query "organizerCount = 0" oneitemperrow
|
||||||
```
|
```
|
||||||
### For selected Shared Drives
|
### For selected Shared Drives
|
||||||
Create a CSV file TeamDrives.csv with at least two columns (id, name) for the selected Shared Drives.
|
Create a CSV file shareddrives.csv with at least two columns (id, name) for the selected Shared Drives.
|
||||||
```
|
```
|
||||||
One row per Shared Drive, all ACLs on the same row
|
One row per Shared Drive, all ACLs on the same row
|
||||||
gam redirect csv ./SharedDriveACLsNoOrganizers.csv multiprocess csv ./SharedDrives.csv gam print drivefileacls "~id" addtitle "~name" fields id,domain,emailaddress,role,type,deleted pm role organizer em pma skip pmselect
|
gam redirect csv ./SharedDriveACLsNoOrganizers.csv multiprocess csv ./SharedDrives.csv gam print drivefileacls "~id" addtitle "~name" fields id,domain,emailaddress,role,type,deleted pm role organizer em pma skip pmselect
|
||||||
@@ -715,13 +764,13 @@ gam redirect csv ./SharedDriveACLsNoOrganizersOIPR.csv multiprocess csv ./Shared
|
|||||||
### For all Shared Drives
|
### For all Shared Drives
|
||||||
```
|
```
|
||||||
One row per Shared Drive, all ACLs on the same row
|
One row per Shared Drive, all ACLs on the same row
|
||||||
gam redirect csv ./SharedDriveACLsAllExternalOrganizers.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted role organizer pm role organizer domainlist domain.com,... em pma skip pmselect
|
gam redirect csv ./SharedDriveACLsAllExternalOrganizers.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted role organizer pm role organizer domainlist domain.com,... em pma skip pmselect
|
||||||
|
|
||||||
A row per Shared Drive/ACL combination
|
A row per Shared Drive/ACL combination
|
||||||
gam redirect csv ./SharedDriveACLsAllExternalOrganizers.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted role organizer pm role organizer domainlist domain.com,... em pma skip pmselect
|
gam redirect csv ./SharedDriveACLsAllExternalOrganizers.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted role organizer pm role organizer domainlist domain.com,... em pma skip pmselect
|
||||||
```
|
```
|
||||||
### For selected Shared Drives
|
### For selected Shared Drives
|
||||||
Create a CSV file TeamDrives.csv with at least two columns (id, name) for the selected Shared Drives.
|
Create a CSV file shareddrives.csv with at least two columns (id, name) for the selected Shared Drives.
|
||||||
```
|
```
|
||||||
One row per Shared Drive, all ACLs on the same row
|
One row per Shared Drive, all ACLs on the same row
|
||||||
gam redirect csv ./SharedDriveACLsAllExternalOrganizers.csv multiprocess csv ./SharedDrives.csv gam print drivefileacls "~id" addtitle "~name" fields id,domain,emailaddress,role,type,deleted pm role organizer domainlist domain.com,... em pma skip pmselect
|
gam redirect csv ./SharedDriveACLsAllExternalOrganizers.csv multiprocess csv ./SharedDrives.csv gam print drivefileacls "~id" addtitle "~name" fields id,domain,emailaddress,role,type,deleted pm role organizer domainlist domain.com,... em pma skip pmselect
|
||||||
@@ -735,13 +784,13 @@ gam redirect csv ./SharedDriveACLsAllExternalOrganizersOIPR.csv multiprocess csv
|
|||||||
Include a permission match `pm domainlist domain.com,... em` that lists your internal domain(s).
|
Include a permission match `pm domainlist domain.com,... em` that lists your internal domain(s).
|
||||||
```
|
```
|
||||||
One row per Shared Drive, all ACLs on the same row
|
One row per Shared Drive, all ACLs on the same row
|
||||||
gam redirect csv ./SharedDriveACLsAllExternal.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect
|
gam redirect csv ./SharedDriveACLsAllExternal.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect
|
||||||
|
|
||||||
A row per Shared Drive/ACL combination
|
A row per Shared Drive/ACL combination
|
||||||
gam redirect csv ./SharedDriveACLsAllExternalOIPR.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect oneitemperrow
|
gam redirect csv ./SharedDriveACLsAllExternalOIPR.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect oneitemperrow
|
||||||
```
|
```
|
||||||
### For selected Shared Drives
|
### For selected Shared Drives
|
||||||
Create a CSV file TeamDrives.csv with at least two columns (id, name) for the selected Shared Drives.
|
Create a CSV file shareddrives.csv with at least two columns (id, name) for the selected Shared Drives.
|
||||||
|
|
||||||
Include a permission match `pm domainlist domain.com,... em` that lists your internal domain(s).
|
Include a permission match `pm domainlist domain.com,... em` that lists your internal domain(s).
|
||||||
```
|
```
|
||||||
@@ -764,16 +813,16 @@ to get the Shared Drive ACLs for the scammed Shared Drives.
|
|||||||
|
|
||||||
```
|
```
|
||||||
One row per Shared Drive, all ACLs on the same row
|
One row per Shared Drive, all ACLs on the same row
|
||||||
gam redirect csv ./SharedDriveACLsAllExternal.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect
|
gam redirect csv ./SharedDriveACLsAllExternal.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect
|
||||||
|
|
||||||
A row per Shared Drive/ACL combination
|
A row per Shared Drive/ACL combination
|
||||||
gam redirect csv ./SharedDriveACLsAllExternalOIPR.csv print teamdriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect oneitemperrow
|
gam redirect csv ./SharedDriveACLsAllExternalOIPR.csv print shareddriveacls fields id,domain,emailaddress,role,type,deleted pm domainlist domain.com,... em pma skip pmselect oneitemperrow
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add an organizer from your domain
|
### Add an organizer from your domain
|
||||||
Sustitute an appropriate value for `admin@domain.com`.
|
Sustitute an appropriate value for `admin@domain.com`.
|
||||||
```
|
```
|
||||||
gam redirect stdout ./AddOrganizer.txt multiprocess redirect stderr stdout csv ./SharedDriveACLsAllExternal.csv gam add drivefileacl teamdriveid "~id" user admin@domain.com role organizer
|
gam redirect stdout ./AddOrganizer.txt multiprocess redirect stderr stdout csv ./SharedDriveACLsAllExternal.csv gam add drivefileacl shareddriveid "~id" user admin@domain.com role organizer
|
||||||
```
|
```
|
||||||
|
|
||||||
### Delete non domain ACLs
|
### Delete non domain ACLs
|
||||||
@@ -782,7 +831,7 @@ you must delete all rows in `SharedDriveACLsAllExternalOIPR.csv` that have the s
|
|||||||
|
|
||||||
This will disable all non-domain users access to the Shared Drive.
|
This will disable all non-domain users access to the Shared Drive.
|
||||||
```
|
```
|
||||||
gam redirect stdout ./DeleteExternalACLs.txt multiprocess redirect stderr stdout csv ./SharedDriveACLsAllExternalOIPR.csv gam delete drivefileacl teamdriveid "~id" "id:~~permission.id~~"
|
gam redirect stdout ./DeleteExternalACLs.txt multiprocess redirect stderr stdout csv ./SharedDriveACLsAllExternalOIPR.csv gam delete drivefileacl shareddriveid "~id" "id:~~permission.id~~"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Delete the Shared Drives
|
### Delete the Shared Drives
|
||||||
@@ -790,36 +839,18 @@ The `allowitemdeletion` option allows deletion of non-empty Shared Drives. This
|
|||||||
|
|
||||||
This is not reversible, proceed with caution.
|
This is not reversible, proceed with caution.
|
||||||
```
|
```
|
||||||
gam redirect stdout ./DeleteSharedDrives.txt multiprocess redirect stderr stdout csv ./SharedDriveACLsAllExternal.csv gam delete teamdrive "~id" allowitemdeletion
|
gam redirect stdout ./DeleteSharedDrives.txt multiprocess redirect stderr stdout csv ./SharedDriveACLsAllExternal.csv gam delete shareddrive "~id" allowitemdeletion
|
||||||
```
|
```
|
||||||
|
|
||||||
## Delete old empty Shared Drives
|
## Delete old empty Shared Drives
|
||||||
```
|
```
|
||||||
# Get a list of Shared Drives created before one year ago; alter date<-1y as required
|
# Get a list of Shared Drives organizers for Shared Drives created before one year ago; alter date<-1y as required.
|
||||||
gam config csv_output_row_filter "createdTime:date<-1y" redirect csv ./TeamDrives.csv print teamdrives fields id,name,createdtime
|
gam config csv_output_row_filter "createdTime:date<-1y" redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers domainlist mydomain.com includetypes user oneorganizer shownoorganizerdrives
|
||||||
|
|
||||||
# You'll need a list of Shared Drive IDs and organizers; get ACLs for Shared Drives from above
|
# Inspect shareddriveOrganizers.csv, you'll have to deal with Shared Drives with no organizer/manager
|
||||||
gam redirect csv ./TeamDriveACLs.csv multiprocess csv ./TeamDrives.csv gam print drivefileacls "~id" fields id,emailaddress,role,type,deleted
|
|
||||||
|
|
||||||
# Customize script: https://github.com/taers232c/GAM-Scripts3/blob/master/GetTeamDriveOrganizers.py
|
|
||||||
DOMAIN_LIST = ['yourdomain.org']
|
|
||||||
|
|
||||||
INCLUDE_TYPES = {
|
|
||||||
'user': True,
|
|
||||||
'group': False,
|
|
||||||
}
|
|
||||||
|
|
||||||
ONE_ORGANIZER = True
|
|
||||||
SHOW_NO_ORGANIZER_DRIVES = True
|
|
||||||
INCLUDE_FILE_ORGANIZERS = False
|
|
||||||
|
|
||||||
# Run script
|
|
||||||
python GetTeamDriveOrganizers.py TeamDriveACLs.csv TeamDrives.csv TeamDriveOrganizers.csv
|
|
||||||
|
|
||||||
# Inspect TeamDriveOrganizers.csv, you'll have to deal with Shared Drives with no organizer/manager
|
|
||||||
|
|
||||||
# Get old empty Shared Drives
|
# Get old empty Shared Drives
|
||||||
gam config num_threads 10 csv_input_row_filter "organizers:regex:^.+$" csv_output_row_filter "Total:count=0" redirect csv ./OldEmptySharedDrives.csv multiprocess redirect stderr - multiprocess csv ./TeamDriveOrganizers.csv gam user "~organizers" print filecounts select teamdriveid "~id" showsize
|
gam config num_threads 10 csv_input_row_filter "organizers:regex:^.+$" csv_output_row_filter "Total:count=0" redirect csv ./OldEmptySharedDrives.csv multiprocess redirect stderr - multiprocess csv ./TeamDriveOrganizers.csv gam user "~organizers" print filecounts select shareddriveid "~id" showsize
|
||||||
|
|
||||||
# Inspect OldEmptySharedDrives.csv, if you're confident of the results, proceed
|
# Inspect OldEmptySharedDrives.csv, if you're confident of the results, proceed
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
- [Change Shared Drive visibility](#change-shared-drive-visibility)
|
- [Change Shared Drive visibility](#change-shared-drive-visibility)
|
||||||
- [Display Shared Drives](#display-shared-drives)
|
- [Display Shared Drives](#display-shared-drives)
|
||||||
- [Display Shared Drive Counts](#display-shared-drive-counts)
|
- [Display Shared Drive Counts](#display-shared-drive-counts)
|
||||||
|
- [Display Shared Drive Organizers](#display-shared-drive-organizers)
|
||||||
- [Manage Shared Drive access](#manage-shared-drive-access)
|
- [Manage Shared Drive access](#manage-shared-drive-access)
|
||||||
- [Display Shared Drive access](#display-shared-drive-access)
|
- [Display Shared Drive access](#display-shared-drive-access)
|
||||||
- [Display Shared Drive access for specific Shared Drives](#display-shared-drive-access-for-specific-shared-drives)
|
- [Display Shared Drive access for specific Shared Drives](#display-shared-drive-access-for-specific-shared-drives)
|
||||||
@@ -72,6 +73,9 @@
|
|||||||
```
|
```
|
||||||
<JSONData> ::= (json [charset <Charset>] <String>) | (json file <FileName> [charset <Charset>]) |
|
<JSONData> ::= (json [charset <Charset>] <String>) | (json file <FileName> [charset <Charset>]) |
|
||||||
|
|
||||||
|
<OrganizerType> ::= user|group
|
||||||
|
<OrganizerTypeList> ::= "<OrganizerType>(,<OrganizerType>)*"
|
||||||
|
|
||||||
<OrgUnitID> ::= id:<String>
|
<OrgUnitID> ::= id:<String>
|
||||||
<OrgUnitPath> ::= /|(/<String>)+
|
<OrgUnitPath> ::= /|(/<String>)+
|
||||||
<OrgUnitItem> ::= <OrgUnitID>|<OrgUnitPath>
|
<OrgUnitItem> ::= <OrgUnitID>|<OrgUnitPath>
|
||||||
@@ -200,14 +204,14 @@ sharingfoldersrequiresorganizerpermission true
|
|||||||
|
|
||||||
## Display Shared Drive themes
|
## Display Shared Drive themes
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> show teamdrivethemes
|
gam <UserTypeEntity> show shareddrivethemes
|
||||||
```
|
```
|
||||||
## Manage Shared Drives
|
## Manage Shared Drives
|
||||||
|
|
||||||
## Create a Shared Drive
|
## Create a Shared Drive
|
||||||
The user that creates a Shared Drive is given the permission role organizer for the Shared Drive,
|
The user that creates a Shared Drive is given the permission role organizer for the Shared Drive,
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> create teamdrive <Name>
|
gam <UserTypeEntity> create shareddrive <Name>
|
||||||
[(theme|themeid <String>)|
|
[(theme|themeid <String>)|
|
||||||
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
||||||
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
||||||
@@ -215,7 +219,7 @@ gam <UserTypeEntity> create teamdrive <Name>
|
|||||||
[errorretries <Integer>] [updateinitialdelay <Integer>] [updateretrydelay <Integer>]
|
[errorretries <Integer>] [updateinitialdelay <Integer>] [updateretrydelay <Integer>]
|
||||||
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
||||||
```
|
```
|
||||||
* `themeid` - a Shared Drive themeId obtained from `show teamdrivethemes`
|
* `themeid` - a Shared Drive themeId obtained from `show shareddrivethemes`
|
||||||
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
||||||
* `<Float>` - X coordinate, typically 0.0
|
* `<Float>` - X coordinate, typically 0.0
|
||||||
* `<Float>` - Y coordinate, typically 0.0
|
* `<Float>` - Y coordinate, typically 0.0
|
||||||
@@ -248,9 +252,9 @@ When either of these options is chosen, no infomation about Shared Drive restric
|
|||||||
To retrieve the Shared Drive ID with `returnidonly`:
|
To retrieve the Shared Drive ID with `returnidonly`:
|
||||||
```
|
```
|
||||||
Linux/MacOS
|
Linux/MacOS
|
||||||
teamDriveId=$(gam user user@domain.com create teamdrive ... returnidonly)
|
teamDriveId=$(gam user user@domain.com create shareddrive ... returnidonly)
|
||||||
Windows PowerShell
|
Windows PowerShell
|
||||||
$teamDriveId = & gam user user@domain.com create teamdrive ... returnidonly
|
$teamDriveId = & gam user user@domain.com create shareddrive ... returnidonly
|
||||||
```
|
```
|
||||||
|
|
||||||
## Bulk Create Shared Drives
|
## Bulk Create Shared Drives
|
||||||
@@ -260,7 +264,7 @@ As a newly created Drive can't be updated for 30+ seconds; split the operation i
|
|||||||
|
|
||||||
Make a CSV file SharedDriveNames.csv with at least two columns, User and name.
|
Make a CSV file SharedDriveNames.csv with at least two columns, User and name.
|
||||||
```
|
```
|
||||||
gam redirect csv ./SharedDrivesCreated.csv multiprocess csv SharedDriveNames.csv gam user "~User" create teamdrive "~name" csv
|
gam redirect csv ./SharedDrivesCreated.csv multiprocess csv SharedDriveNames.csv gam user "~User" create shareddrive "~name" csv
|
||||||
```
|
```
|
||||||
This will create a three column CSV file SharedDriveNamesIDs.csv with columns: User,name,id
|
This will create a three column CSV file SharedDriveNamesIDs.csv with columns: User,name,id
|
||||||
* There will be a row for each Shared Drive.
|
* There will be a row for each Shared Drive.
|
||||||
@@ -274,13 +278,13 @@ gam redirect stdout ./SharedDrivesUpdated.txt multiprocess redirect stderr stdou
|
|||||||
|
|
||||||
This command is used to set basic Shared Drive settings.
|
This command is used to set basic Shared Drive settings.
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> update teamdrive <SharedDriveEntity> [adminaccess|asadmin] [name <Name>]
|
gam <UserTypeEntity> update shareddrive <SharedDriveEntity> [adminaccess|asadmin] [name <Name>]
|
||||||
[(theme|themeid <String>)|
|
[(theme|themeid <String>)|
|
||||||
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
||||||
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
(<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
||||||
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
||||||
```
|
```
|
||||||
* `themeid` - a Shared Drive themeId obtained from `show teamdrivethemes`
|
* `themeid` - a Shared Drive themeId obtained from `show shareddrivethemes`
|
||||||
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
* `customtheme` - set the backgroundImageFile property described here: https://developers.google.com/drive/v3/reference/teamdrives
|
||||||
* `color` - set the Shared Drive color
|
* `color` - set the Shared Drive color
|
||||||
* `<SharedDriveRestrictionsSubfieldName> <Boolean>` - Set Shared Drive Restrictions
|
* `<SharedDriveRestrictionsSubfieldName> <Boolean>` - Set Shared Drive Restrictions
|
||||||
@@ -291,7 +295,7 @@ This option is only available when the command is run as an administrator.
|
|||||||
|
|
||||||
## Delete a Shared Drive
|
## Delete a Shared Drive
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> delete teamdrive <SharedDriveEntity> [allowitemdeletion] [adminaccess|asadmin]
|
gam <UserTypeEntity> delete shareddrive <SharedDriveEntity> [allowitemdeletion] [adminaccess|asadmin]
|
||||||
```
|
```
|
||||||
By default, deleting a Shared Drive that contains any files/folders will fail.
|
By default, deleting a Shared Drive that contains any files/folders will fail.
|
||||||
The `allowitemdeletion` option allows a Super Admin to delete a non-empty Shared Drive.
|
The `allowitemdeletion` option allows a Super Admin to delete a non-empty Shared Drive.
|
||||||
@@ -299,19 +303,19 @@ This is not reversible, proceed with caution.
|
|||||||
|
|
||||||
## Change Shared Drive visibility
|
## Change Shared Drive visibility
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> hide teamdrive <SharedDriveEntity>
|
gam <UserTypeEntity> hide shareddrive <SharedDriveEntity>
|
||||||
gam <UserTypeEntity> unhide teamdrive <SharedDriveEntity>
|
gam <UserTypeEntity> unhide shareddrive <SharedDriveEntity>
|
||||||
```
|
```
|
||||||
## Display Shared Drives
|
## Display Shared Drives
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> show teamdriveinfo <SharedDriveEntity>
|
gam <UserTypeEntity> show shareddriveinfo <SharedDriveEntity>
|
||||||
gam <UserTypeEntity> info teamdrive <SharedDriveEntity>
|
gam <UserTypeEntity> info shareddrive <SharedDriveEntity>
|
||||||
[fields <SharedDriveFieldNameList>]
|
[fields <SharedDriveFieldNameList>]
|
||||||
[guiroles [<Boolean>] [formatjson]
|
[guiroles [<Boolean>] [formatjson]
|
||||||
gam <UserTypeEntity> show teamdriveinfo <SharedDriveEntity>
|
gam <UserTypeEntity> show shareddriveinfo <SharedDriveEntity>
|
||||||
[fields <SharedDriveFieldNameList>]
|
[fields <SharedDriveFieldNameList>]
|
||||||
[guiroles [<Boolean>] [formatjson]
|
[guiroles [<Boolean>] [formatjson]
|
||||||
gam <UserTypeEntity> show teamdrives
|
gam <UserTypeEntity> show shareddrives
|
||||||
[matchname <REMatchPattern>] (role|roles <SharedDriveACLRoleList>)*
|
[matchname <REMatchPattern>] (role|roles <SharedDriveACLRoleList>)*
|
||||||
[fields <SharedDriveFieldNameList>]
|
[fields <SharedDriveFieldNameList>]
|
||||||
[guiroles [<Boolean>] [formatjson]
|
[guiroles [<Boolean>] [formatjson]
|
||||||
@@ -323,7 +327,7 @@ By default, Gam displays all Teams Drives accessible by the user.
|
|||||||
By default, Gam displays the information as an indented list of keys and values.
|
By default, Gam displays the information as an indented list of keys and values.
|
||||||
* `formatjson` - Display the fields in JSON format.
|
* `formatjson` - Display the fields in JSON format.
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> print teamdrives [todrive <ToDriveAttribute>*]
|
gam <UserTypeEntity> print shareddrives [todrive <ToDriveAttribute>*]
|
||||||
[matchname <REMatchPattern>] (role|roles <SharedDriveACLRoleList>)*
|
[matchname <REMatchPattern>] (role|roles <SharedDriveACLRoleList>)*
|
||||||
[fields <SharedDriveFieldNameList>] [formatjson [quotechar <Character>]]
|
[fields <SharedDriveFieldNameList>] [formatjson [quotechar <Character>]]
|
||||||
```
|
```
|
||||||
@@ -386,6 +390,51 @@ count=$(gam user user@domain.com print shareddrives showitemcountonly)
|
|||||||
Windows PowerShell
|
Windows PowerShell
|
||||||
count = & gam user user@domain.com print shareddrives showitemcountonly
|
count = & gam user user@domain.com print shareddrives showitemcountonly
|
||||||
```
|
```
|
||||||
|
## Display Shared Drive Organizers
|
||||||
|
The following command can be used instead of the `GetTeamDriveOrganizers.py` script.
|
||||||
|
|
||||||
|
```
|
||||||
|
gam <UserTypeEntity> print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
||||||
|
[adminaccess|asadmin]
|
||||||
|
[(shareddriveadminquery|query <QuerySharedDrive>) |
|
||||||
|
(shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
||||||
|
[orgunit|org|ou <OrgUnitPath>]
|
||||||
|
[matchname <REMatchPattern>]
|
||||||
|
[domainlist <DomainList>]
|
||||||
|
[includetypes <OrganizerTypeList>]
|
||||||
|
[oneorganizer [<Boolean>]]
|
||||||
|
[shownorganizerdrives [false|true|only]]
|
||||||
|
[includefileorganizers [<Boolean>]]
|
||||||
|
[delimiter <Character>]
|
||||||
|
```
|
||||||
|
Options `shareddriveadminquery|query` and `shareddrives|teamdrives` are mutually exclusive.
|
||||||
|
|
||||||
|
Options `shareddriveadminquery|query` and `orgunit|org|ou` require `adminaccess|asadmin`.
|
||||||
|
|
||||||
|
By default, organizers for all Shared Drives are displayed; use the following options to select a subset of Shared Drives:
|
||||||
|
* `teamdriveadminquery|query <QueryTeamDrive>` - Use a query to select Shared Drives
|
||||||
|
* `shareddrives|teamdrives <SharedDriveIDList>` - Select the Shared Drive IDs specified in `<SharedDriveIDList>`
|
||||||
|
* `shareddrives|teamdrives select <FileSelector>|<CSVFileSelector>` - Select the Shared Drive IDs specified in `<FileSelector>|<CSVFileSelector>`
|
||||||
|
* `orgunit|org|ou <OrgUnitPath>` - Only Shared Drives in the specified Org Unit are selected
|
||||||
|
* `matchname <REMatchPattern>` - Retrieve Shared Drives with names that match a pattern.
|
||||||
|
|
||||||
|
For multiple organizers:
|
||||||
|
* `delimiter <Character>` - Separate `organizers` entries with `<Character>`; the default value is `csv_output_field_delimiter` from `gam.cfg`.
|
||||||
|
|
||||||
|
The command defaults do not match the script defaults, they are set for the most common use case:
|
||||||
|
* `domainlist` - The workspace primary domain
|
||||||
|
* `includetypes` - user
|
||||||
|
* `oneorganizer` - True
|
||||||
|
* `shownoorganizerdrives` - True
|
||||||
|
* `includefileorganizers` - False
|
||||||
|
|
||||||
|
To select organizers from any domain, use: `domainlist ""`
|
||||||
|
|
||||||
|
For example, to get a single user organizer from your domain for all Shared Drives including no organizer drives:
|
||||||
|
```
|
||||||
|
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers
|
||||||
|
```
|
||||||
|
|
||||||
## Manage Shared Drive access
|
## Manage Shared Drive access
|
||||||
These commands must be issued by a user with Shared Drive permission role organizer.
|
These commands must be issued by a user with Shared Drive permission role organizer.
|
||||||
### Process single ACLs.
|
### Process single ACLs.
|
||||||
@@ -458,14 +507,14 @@ The `quotechar <Character>` option allows you to choose an alternate quote chara
|
|||||||
|
|
||||||
## Display Shared Drive access for selected Shared Drives
|
## Display Shared Drive access for selected Shared Drives
|
||||||
```
|
```
|
||||||
gam <UserTypeEntity> show teamdriveacls
|
gam <UserTypeEntity> show shareddriveacls
|
||||||
adminaccess [teamdriveadminquery|query <QueryTeamDrive>]
|
adminaccess [teamdriveadminquery|query <QueryTeamDrive>]
|
||||||
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
||||||
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
||||||
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
||||||
[formatjson [quotechar <Character>]]
|
[formatjson [quotechar <Character>]]
|
||||||
gam <UserTypeEntity> print teamdriveacls [todrive <ToDriveAttribute>*]
|
gam <UserTypeEntity> print shareddriveacls [todrive <ToDriveAttribute>*]
|
||||||
adminaccess [teamdriveadminquery|query <QueryTeamDrive>]
|
adminaccess [teamdriveadminquery|query <QueryTeamDrive>]
|
||||||
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
||||||
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
||||||
@@ -488,7 +537,7 @@ By default, all ACLS are displayed; use the following options to select a subset
|
|||||||
* `role|roles <SharedDriveACLRoleList>` - Display ACLs for the specified roles only.
|
* `role|roles <SharedDriveACLRoleList>` - Display ACLs for the specified roles only.
|
||||||
* `<PermissionMatch>* [<PermissionMatchAction>]` - Use permission matching to display a subset of the ACLs for each Shared Drive; this only applies when `pmselect` is not specified
|
* `<PermissionMatch>* [<PermissionMatchAction>]` - Use permission matching to display a subset of the ACLs for each Shared Drive; this only applies when `pmselect` is not specified
|
||||||
|
|
||||||
With `print teamdriveacls` or `show teamdrivecls formatjson`, the ACLs selected for display are all output on one row/line as a repeating item with the matching Shared Drive id.
|
With `print shareddriveacls` or `show shareddrivecls formatjson`, the ACLs selected for display are all output on one row/line as a repeating item with the matching Shared Drive id.
|
||||||
When `oneitemperrow` is specified, each ACL is output on a separate row/line with the matching Shared Drive id and name. This simplifies processing the CSV file with subsequent Gam commands.
|
When `oneitemperrow` is specified, each ACL is output on a separate row/line with the matching Shared Drive id and name. This simplifies processing the CSV file with subsequent Gam commands.
|
||||||
|
|
||||||
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
Print the current version of Gam with details
|
Print the current version of Gam with details
|
||||||
```
|
```
|
||||||
gam version
|
gam version
|
||||||
GAM 7.07.17 - https://github.com/GAM-team/GAM - pyinstaller
|
GAM 7.08.02 - https://github.com/GAM-team/GAM - pyinstaller
|
||||||
GAM Team <google-apps-manager@googlegroups.com>
|
GAM Team <google-apps-manager@googlegroups.com>
|
||||||
Python 3.13.3 64-bit final
|
Python 3.13.3 64-bit final
|
||||||
MacOS Sequoia 15.5 x86_64
|
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
|
Print the current version of Gam with details and time offset information
|
||||||
```
|
```
|
||||||
gam version timeoffset
|
gam version timeoffset
|
||||||
GAM 7.07.17 - https://github.com/GAM-team/GAM - pyinstaller
|
GAM 7.08.02 - https://github.com/GAM-team/GAM - pyinstaller
|
||||||
GAM Team <google-apps-manager@googlegroups.com>
|
GAM Team <google-apps-manager@googlegroups.com>
|
||||||
Python 3.13.3 64-bit final
|
Python 3.13.3 64-bit final
|
||||||
MacOS Sequoia 15.5 x86_64
|
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
|
Print the current version of Gam with extended details and SSL information
|
||||||
```
|
```
|
||||||
gam version extended
|
gam version extended
|
||||||
GAM 7.07.17 - https://github.com/GAM-team/GAM - pyinstaller
|
GAM 7.08.02 - https://github.com/GAM-team/GAM - pyinstaller
|
||||||
GAM Team <google-apps-manager@googlegroups.com>
|
GAM Team <google-apps-manager@googlegroups.com>
|
||||||
Python 3.13.3 64-bit final
|
Python 3.13.3 64-bit final
|
||||||
MacOS Sequoia 15.5 x86_64
|
MacOS Sequoia 15.5 x86_64
|
||||||
@@ -64,7 +64,7 @@ MacOS High Sierra 10.13.6 x86_64
|
|||||||
Path: /Users/Admin/bin/gam7
|
Path: /Users/Admin/bin/gam7
|
||||||
Version Check:
|
Version Check:
|
||||||
Current: 5.35.08
|
Current: 5.35.08
|
||||||
Latest: 7.07.17
|
Latest: 7.08.02
|
||||||
echo $?
|
echo $?
|
||||||
1
|
1
|
||||||
```
|
```
|
||||||
@@ -72,7 +72,7 @@ echo $?
|
|||||||
Print the current version number without details
|
Print the current version number without details
|
||||||
```
|
```
|
||||||
gam version simple
|
gam version simple
|
||||||
7.07.17
|
7.08.02
|
||||||
```
|
```
|
||||||
In Linux/MacOS you can do:
|
In Linux/MacOS you can do:
|
||||||
```
|
```
|
||||||
@@ -82,7 +82,7 @@ echo $VER
|
|||||||
Print the current version of Gam and address of this Wiki
|
Print the current version of Gam and address of this Wiki
|
||||||
```
|
```
|
||||||
gam help
|
gam help
|
||||||
GAM 7.07.17 - https://github.com/GAM-team/GAM
|
GAM 7.08.02 - https://github.com/GAM-team/GAM
|
||||||
GAM Team <google-apps-manager@googlegroups.com>
|
GAM Team <google-apps-manager@googlegroups.com>
|
||||||
Python 3.13.3 64-bit final
|
Python 3.13.3 64-bit final
|
||||||
MacOS Sequoia 15.5 x86_64
|
MacOS Sequoia 15.5 x86_64
|
||||||
|
|||||||
Reference in New Issue
Block a user