mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-07 15:51:38 +00:00
Compare commits
53 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f20520b3a7 | ||
|
|
c59398791b | ||
|
|
9349bc413d | ||
|
|
b2dd233dbf | ||
|
|
4142e5c293 | ||
|
|
56acae7c7d | ||
|
|
376c911e58 | ||
|
|
33a9e7e1fa | ||
|
|
360485b3aa | ||
|
|
59e425e41c | ||
|
|
e5f52289d2 | ||
|
|
19aab2b2ad | ||
|
|
6d07329e21 | ||
|
|
2ac6e361f0 | ||
|
|
d8c5d237b9 | ||
|
|
6b64879d56 | ||
|
|
213bf45942 | ||
|
|
158f24917c | ||
|
|
d2378d6e61 | ||
|
|
8ebc76905a | ||
|
|
bd367adc49 | ||
|
|
a9151c7248 | ||
|
|
b61d5f8f5d | ||
|
|
4150bef601 | ||
|
|
3a160874cf | ||
|
|
03ba798658 | ||
|
|
ab83d0204f | ||
|
|
902da7419d | ||
|
|
ff0536dedf | ||
|
|
c8bfee9544 | ||
|
|
625eddd73d | ||
|
|
b89a821252 | ||
|
|
5a45f816e8 | ||
|
|
5ad29b75e7 | ||
|
|
4da394b32a | ||
|
|
6a5052f8a2 | ||
|
|
dd5616ec0e | ||
|
|
46ad942637 | ||
|
|
6db53c6f4c | ||
|
|
87f601dc5e | ||
|
|
e3d940c548 | ||
|
|
90beada55e | ||
|
|
670e3525f0 | ||
|
|
4a4b154d3d | ||
|
|
8b182b7b37 | ||
|
|
e9d911b5cd | ||
|
|
c67a4c9147 | ||
|
|
e583b6e20c | ||
|
|
8c23cd8e06 | ||
|
|
75fa7155a0 | ||
|
|
90e11162a0 | ||
|
|
b11617c1ea | ||
|
|
cf59f9156e |
42
.github/workflows/build.yml
vendored
42
.github/workflows/build.yml
vendored
@@ -71,11 +71,6 @@ jobs:
|
||||
goal: build
|
||||
staticx: yes
|
||||
name: Build Arm StaticX Legacy
|
||||
- os: macos-13
|
||||
jid: 7
|
||||
freethreaded: false
|
||||
goal: build
|
||||
name: Build Intel MacOS
|
||||
- os: macos-14
|
||||
jid: 8
|
||||
freethreaded: false
|
||||
@@ -158,7 +153,7 @@ jobs:
|
||||
with:
|
||||
path: |
|
||||
cache.tar.xz
|
||||
key: gam-${{ matrix.jid }}-20251007
|
||||
key: gam-${{ matrix.jid }}-20251031
|
||||
|
||||
- name: Untar Cache archive
|
||||
if: matrix.goal == 'build' && steps.cache-python-ssl.outputs.cache-hit == 'true'
|
||||
@@ -479,23 +474,15 @@ jobs:
|
||||
"${PYTHON}" -V
|
||||
"${PYTHON}" -c "import ssl; print(f'Using {ssl.OPENSSL_VERSION}')"
|
||||
|
||||
- name: Upgrade pip, wheel, etc
|
||||
run: |
|
||||
curl $curl_retry -O https://bootstrap.pypa.io/get-pip.py
|
||||
"$PYTHON" get-pip.py
|
||||
"$PYTHON" -m pip install --upgrade pip
|
||||
"$PYTHON" -m pip install --upgrade wheel
|
||||
"$PYTHON" -m pip install --upgrade setuptools
|
||||
"$PYTHON" -m pip install --upgrade importlib-metadata
|
||||
"$PYTHON" -m pip install --upgrade setuptools-scm
|
||||
"$PYTHON" -m pip list
|
||||
|
||||
- name: Create and use Python venv
|
||||
run: |
|
||||
cd "$GITHUB_WORKSPACE"
|
||||
curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py
|
||||
"$PYTHON" get-pip.py
|
||||
"$PYTHON" -m venv venv
|
||||
if [[ "$RUNNER_OS" == "Windows" ]]; then
|
||||
# hack till pyscard has a wheel for win arm64
|
||||
# pyscard seems to build outside venv but not in it.
|
||||
# build it so it's cached.
|
||||
"$PYTHON" -m pip install --upgrade --force-reinstall pyscard
|
||||
export PYTHON="${GITHUB_WORKSPACE}/venv/scripts/python.exe"
|
||||
else
|
||||
@@ -507,6 +494,18 @@ jobs:
|
||||
echo "gam=${gam}" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
- name: Upgrade pip, wheel, etc
|
||||
run: |
|
||||
curl $curl_retry -O https://bootstrap.pypa.io/get-pip.py
|
||||
"$PYTHON" get-pip.py
|
||||
"$PYTHON" -m pip install --upgrade pip
|
||||
"$PYTHON" -m pip install --upgrade wheel
|
||||
"$PYTHON" -m pip install --upgrade setuptools
|
||||
"$PYTHON" -m pip install --upgrade importlib-metadata
|
||||
"$PYTHON" -m pip install --upgrade setuptools-scm
|
||||
"$PYTHON" -m pip install --upgrade packaging
|
||||
"$PYTHON" -m pip list
|
||||
|
||||
- name: Install pip requirements
|
||||
run: |
|
||||
echo "before anything..."
|
||||
@@ -515,7 +514,10 @@ jobs:
|
||||
"$PYTHON" -m pip cache info
|
||||
echo "--list--"
|
||||
"$PYTHON" -m pip cache list
|
||||
"$PYTHON" -m pip install --upgrade ..[yubikey]
|
||||
echo "--pip debug verbose--"
|
||||
"$PYTHON" -m pip debug --verbose
|
||||
echo "--------"
|
||||
"$PYTHON" -m pip install -vvv --upgrade ..[yubikey]
|
||||
echo "after everything..."
|
||||
"$PYTHON" -m pip list
|
||||
|
||||
@@ -987,7 +989,7 @@ jobs:
|
||||
$gam report usageparameters customer
|
||||
$gam report usage customer parameters gmail:num_emails_sent,accounts:num_1day_logins
|
||||
$gam report customer todrive tdnobrowser
|
||||
#$gam report users fields accounts:is_less_secure_apps_access_allowed,gmail:last_imap_time,gmail:last_pop_time filters "accounts:last_login_time>2019-01-01T00:00:00.000Z" todrive tdnobrowser
|
||||
#$gam report users fields accounts:is_less_secure_apps_access_allowed,gmail:last_imap_time,gmail:last_pop_time filters "accounts:last_login_time>2025-01-01T00:00:00.000Z" todrive tdnobrowser
|
||||
$gam report users todrive tdnobrowser
|
||||
$gam report admin start -3d todrive tdnobrowser
|
||||
$gam print devices nopersonaldevices nodeviceusers filter "serial:$JID$JID$JID$JID-" | $gam csv - gam delete device id ~name
|
||||
|
||||
@@ -2057,7 +2057,7 @@ gam create chatmessage <ChatSpace>
|
||||
[(thread <ChatThread>)|(threadkey <String>) [replyoption fail|fallbacktonew]]
|
||||
[returnidonly]
|
||||
gam update chatmessage name <ChatMessage>
|
||||
<ChatContent>
|
||||
[<ChatContent>] [clearattachments <String>]
|
||||
gam delete chatmessage name <ChatMessage>
|
||||
|
||||
<ChatMessageFieldName> ::=
|
||||
@@ -3279,6 +3279,7 @@ gam print courses [todrive <ToDriveAttribute>*]
|
||||
[show all|students|teachers] [countsonly]
|
||||
[timefilter creationtime|updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
||||
[fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
[formatjson [quotechar <Character>]]
|
||||
[showitemcountonly]
|
||||
|
||||
@@ -4086,7 +4087,7 @@ gam print group-members [todrive <ToDriveAttribute>*]
|
||||
gam create cigroup <EmailAddress>
|
||||
[copyfrom <GroupItem>] <GroupAttribute>*
|
||||
[makeowner] [alias|aliases <CIGroupAliasList>]
|
||||
[security|makesecuritygroup]
|
||||
[security|makesecuritygroup] [locked]
|
||||
[dynamic <QueryDynamicGroup>]
|
||||
gam update cigroup <GroupEntity> [copyfrom <GroupItem>] <GroupAttribute>
|
||||
[security|makesecuritygroup|
|
||||
@@ -4650,6 +4651,7 @@ gam report customers|customer|domain [todrive <ToDriveAttribute>*]
|
||||
[(nodatechange | limitdatechanges <Integer>) | (fulldatarequired all|<CustomerServiceNameList>)]
|
||||
[(fields|parameters <String>)|(services <CustomerServiceNameList>)] [noauthorizedapps]
|
||||
[convertmbtogb]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
|
||||
<UserServiceName> ::=
|
||||
accounts|
|
||||
@@ -4672,6 +4674,7 @@ gam report users|user [todrive <ToDriveAttribute>*]
|
||||
[aggregatebydate|aggregatebyuser [Boolean]]
|
||||
[maxresults <Number>]
|
||||
[convertmbtogb]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
|
||||
# Reseller
|
||||
|
||||
@@ -5776,10 +5779,9 @@ gam create|add user <EmailAddress> [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAaddress>]
|
||||
[mailbox <EmailAaddress>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAaddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
||||
]
|
||||
@@ -5802,10 +5804,9 @@ gam update user <UserItem> [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAaddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAddress>]
|
||||
[<NotifyMessageContent>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
||||
]
|
||||
@@ -5840,10 +5841,9 @@ gam update users <UserTypeEntity> [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
||||
]
|
||||
@@ -5877,10 +5877,9 @@ gam <UserTypeEntity> update users [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAaddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAddress>]
|
||||
[<NotifyMessageContent>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
||||
]
|
||||
@@ -6428,13 +6427,13 @@ gam <UserTypeEntity> update chatspace <ChatSpace>
|
||||
[type space]
|
||||
[description <String>] [guidelines|rules <String>]
|
||||
[history <Boolean>])
|
||||
[managemembersandgroups managers|members]
|
||||
[modifyspacedetails managers|members]
|
||||
[togglehistory managers|members]
|
||||
[useatmentionall managers|members]
|
||||
[manageapps managers|members]
|
||||
[managewebhooks managers|members]
|
||||
[replymessages managers|members]
|
||||
[managemembersandgroups owners|managers|members]
|
||||
[modifyspacedetails owners|managers|members]
|
||||
[togglehistory owners|managers|members]
|
||||
[useatmentionall owners|managers|members]
|
||||
[manageapps owners|managers|members]
|
||||
[managewebhooks owners|managers|members]
|
||||
[replymessages owners|managers|members]
|
||||
[formatjson]
|
||||
gam <UserTypeEntity> delete chatspace <ChatSpace>
|
||||
|
||||
@@ -6495,28 +6494,28 @@ gam <UserItem> print chatspaces asadmin [todrive <ToDriveAttribute>*]
|
||||
[formatjson [quotechar <Character>]]
|
||||
|
||||
gam <UserTypeEntity> create chatmember <ChatSpace>
|
||||
[type human|bot] [role member|manager]
|
||||
[type human|bot] [role member|manager|owner]
|
||||
(user <UserItem>)* (members <UserTypeEntity>)*
|
||||
(group <GroupItem>)* (groups <GroupEntity>)*
|
||||
[formatjson|returnidonly]
|
||||
gam <UserTypeEntity> delete chatmember <ChatSpace>
|
||||
((user <UserItem>)|(members <UserTypeEntity>)|
|
||||
(group <GroupItem>)|(groups <GroupEntity>))+
|
||||
gam <UserTypeEntity> remove chatmember members <ChatMemberList>
|
||||
`gam <UserTypeEntity> remove chatmember members <ChatMemberList>
|
||||
gam <UserTypeEntity> update chatmember <ChatSpace>
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
((user <UserItem>)|(members <UserTypeEntity>))+
|
||||
gam <UserTypeEntity> modify chatmember
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
members <ChatMemberList>
|
||||
gam <UserTypeEntity> sync chatmembers <ChatSpace>
|
||||
[role member|manager] [type human|bot]
|
||||
[role member|manager|owner] [type human|bot]
|
||||
[addonly|removeonly]
|
||||
[preview [actioncsv]]
|
||||
(users <UserTypeEntity>)* (groups <GroupEntity>)*
|
||||
|
||||
gam <UserItem> create chatmember asadmin <ChatSpace>
|
||||
[type human|bot] [role member|manager]
|
||||
[type human|bot] [role member|manager|owner]
|
||||
(user <UserItem>)* (members <UserTypeEntity>)*
|
||||
(group <GroupItem>)* (groups <GroupEntity>)*
|
||||
[formatjson|returnidonly]
|
||||
@@ -6525,13 +6524,13 @@ gam <UserItem> delete chatmember asadmin <ChatSpace>
|
||||
((user <UserItem>)|(members <UserTypeEntity>)|
|
||||
(group <GroupItem>)|(groups <GroupEntity>))+
|
||||
gam <UserItem> update chatmember asadmin <ChatSpace>
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
((user <UserItem>)|(members <UserTypeEntity>))+
|
||||
gam <UserItem> modify chatmember asadmin
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
members <ChatMemberList>
|
||||
gam <UserItem> sync chatmembers asadmin <ChatSpace>
|
||||
[role member|manager] [type human|bot]
|
||||
[role member|manager|owner`] [type human|bot]
|
||||
[addonly|removeonly]
|
||||
[preview [actioncsv]]
|
||||
(users <UserTypeEntity>)* (groups <GroupEntity>)*
|
||||
@@ -6586,7 +6585,7 @@ gam <UserTypeEntity> create chatmessage <ChatSpace>
|
||||
[replyoption fail|fallback]
|
||||
[returnidonly]
|
||||
gam <UserTypeEntity> update chatmessage name <ChatMessage>
|
||||
<ChatContent>
|
||||
[<ChatContent>] [clearattachments <String>]
|
||||
gam <UserTypeEntity> delete chatmessage name <ChatMessage>
|
||||
|
||||
<ChatMessageFieldName> ::=
|
||||
@@ -7579,7 +7578,19 @@ gam <UserTypeEntity> deprovision|deprov [popimap] [signout] [turnoff2sv]
|
||||
# Users - Gmail - Delegates
|
||||
|
||||
gam <UserTypeEntity> delegate to [convertalias] <UserEntity>
|
||||
[notify [<Boolean>]
|
||||
[subject <String>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
]
|
||||
gam <UserTypeEntity> create|add delegate|delegates [convertalias] <UserEntity>
|
||||
[notify [<Boolean>]
|
||||
[subject <String>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
]
|
||||
gam <UserTypeEntity> delete delegate|delegates [convertalias] <UserEntity>
|
||||
gam <UserTypeEntity> update delegate|delegates [convertalias] [<UserEntity>]
|
||||
gam <UserTypeEntity> show delegates|delegate [shownames] [csv]
|
||||
|
||||
@@ -1,4 +1,68 @@
|
||||
7.26.00
|
||||
7.28.01
|
||||
|
||||
Updated `gam <UserTypeEntity> show fileinfo <DriveFileEntity>` to display `displayName` as the key field
|
||||
of a `permission` not `deleted`.
|
||||
|
||||
7.28.00
|
||||
|
||||
Added option `addcsvdata <FieldName> <String>` to `gam report [usage] customers|users`
|
||||
that adds additional columns of data to the CSV file output. This will be most useful
|
||||
when reading a CSV of user information and you want to include some of the user information,
|
||||
e.g., orgUnitPath, in the output.
|
||||
```
|
||||
gam redirect csv ./Users.csv print users fields ou
|
||||
gam redirect csv ./UserStorageInfo.csv multiprocess csv Users.csv gam report users user "~primaryEmail" parameters accounts:drive_used_quota_in_mb,accounts:gmail_used_quota_in_mb,accounts:gplus_photos_used_quota_in_mb,accounts:total_quota_in_mb,accounts:used_quota_in_mb,accounts:used_quota_in_percentage addcsvdata orgUnitPath "~orgUnitPath"
|
||||
```
|
||||
|
||||
7.27.05
|
||||
|
||||
Added option `addcsvdata <FieldName> <String>` to `gam print courses`
|
||||
that adds additional columns of data to the CSV file output.
|
||||
|
||||
The following scope is no longer necessary: `Cloud Identity API - Groups Beta (Enables group locking/unlocking)`
|
||||
as this scope `Cloud Identity API - Groups` now provides group locking/unlocking.
|
||||
|
||||
7.27.04
|
||||
|
||||
Added options to `gam <UserTypeEntity> create delegate` that support
|
||||
sending email notifications when a user adds a delegate.
|
||||
|
||||
* See: https://github.com/GAM-team/GAM/wiki/Users-Gmail-Delegates#delegation-notification
|
||||
|
||||
7.27.03
|
||||
|
||||
Updated `gam <UserTypeEntity> create|update|sync chatmember` role specification to `role member|manager|owner`.
|
||||
This is the mapping between the Chat UI and Chat API; GAM uses the Chat UI role names.
|
||||
```
|
||||
UI: Member, API: ROLE_MEMBER
|
||||
UI: Manager, API: ROLE_ASSISTANT_MANAGER
|
||||
UI: Owner, API: ROLE_MANAGER
|
||||
```
|
||||
|
||||
Updated `gam <UserTypeEntity> update chatspace` options for permission settings.
|
||||
```
|
||||
[managemembersandgroups owners|managers|members]
|
||||
[modifyspacedetails owners|managers|members]
|
||||
[togglehistory owners|managers|members]
|
||||
[useatmentionall owners|managers|members]
|
||||
[manageapps owners|managers|members]
|
||||
[managewebhooks owners|managers|members]
|
||||
[replymessages owners|managers|members]
|
||||
```
|
||||
|
||||
7.27.02
|
||||
|
||||
Added option `clearattachments <String>` to `gam [<UserTypeMessage>] update chatmessage`
|
||||
that clears all attachments from a Chat message. If `<ChatContent>` is not specified,
|
||||
the current message text is retained and `<String>` is appended; `<String>` must be specified
|
||||
but can be empty in which case the current message test is preserved as-is.
|
||||
|
||||
7.27.01
|
||||
|
||||
Fixed bug in `gam <UserTypeEntity> claim ownership <DriveFileEntity> ... onlyUsers|skipusers <UserTypeEntity>`
|
||||
where the email addresses in `onlyUsers|skipusers <UserTypeEntity>` were not normalized.
|
||||
|
||||
7.27.00
|
||||
|
||||
Added `debug_redaction` Boolean variable to `gam.cfg`. When True, the default,
|
||||
sensitive data like access/refresh tokens, client secret and authorization codes
|
||||
|
||||
@@ -83,13 +83,8 @@ echo -e '\x1B[0m'
|
||||
|
||||
version_gt()
|
||||
{
|
||||
# MacOS < 10.13 doesn't support sort -V
|
||||
echo "" | sort -V > /dev/null 2>&1
|
||||
vsort_failed=$?
|
||||
if [ "${1}" = "${2}" ]; then
|
||||
true
|
||||
elif (( $vsort_failed != 0 )); then
|
||||
false
|
||||
else
|
||||
test "$(printf '%s\n' "$@" | sort -V | head -n 1)" != "$1"
|
||||
fi
|
||||
|
||||
@@ -25,7 +25,7 @@ https://github.com/GAM-team/GAM/wiki
|
||||
"""
|
||||
|
||||
__author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
|
||||
__version__ = '7.26.00'
|
||||
__version__ = '7.28.01'
|
||||
__license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
|
||||
|
||||
#pylint: disable=wrong-import-position
|
||||
@@ -9177,12 +9177,12 @@ def flattenJSON(topStructure, flattened=None,
|
||||
# Show a json object
|
||||
def showJSON(showName, showValue, skipObjects=None, timeObjects=None,
|
||||
simpleLists=None, dictObjectsKey=None, sortDictKeys=True):
|
||||
def _show(objectName, objectValue, subObjectKey, level, subSkipObjects):
|
||||
def _show(objectName, objectValue, subObjectKey, subObjectName, level, subSkipObjects):
|
||||
if objectName in subSkipObjects:
|
||||
return
|
||||
if objectName is not None:
|
||||
printJSONKey(objectName)
|
||||
subObjectKey = dictObjectsKey.get(objectName)
|
||||
subObjectKey = dictObjectsKey.get(objectName)
|
||||
if isinstance(objectValue, list):
|
||||
if objectName in simpleLists:
|
||||
printJSONValue(' '.join(objectValue))
|
||||
@@ -9200,10 +9200,12 @@ def showJSON(showName, showValue, skipObjects=None, timeObjects=None,
|
||||
if isinstance(subValue, (str, bool, float, int)):
|
||||
printKeyValueList([subValue])
|
||||
else:
|
||||
_show(None, subValue, subObjectKey, level+1, DEFAULT_SKIP_OBJECTS)
|
||||
_show(None, subValue, subObjectKey, objectName, level+1, DEFAULT_SKIP_OBJECTS)
|
||||
if objectName is not None:
|
||||
Ind.Decrement()
|
||||
elif isinstance(objectValue, dict):
|
||||
if not subObjectKey:
|
||||
subObjectKey = dictObjectsKey.get(subObjectName)
|
||||
indentAfterFirst = unindentAfterLast = False
|
||||
if objectName is not None:
|
||||
printBlankLine()
|
||||
@@ -9211,13 +9213,23 @@ def showJSON(showName, showValue, skipObjects=None, timeObjects=None,
|
||||
elif level > 0:
|
||||
indentAfterFirst = unindentAfterLast = True
|
||||
subObjects = sorted(objectValue) if sortDictKeys else objectValue.keys()
|
||||
if subObjectKey and (subObjectKey in subObjects):
|
||||
subObjects.remove(subObjectKey)
|
||||
subObjects.insert(0, subObjectKey)
|
||||
subObjectKey = None
|
||||
if subObjectKey:
|
||||
if subObjectKey in subObjects:
|
||||
subObjects.remove(subObjectKey)
|
||||
subObjects.insert(0, subObjectKey)
|
||||
subObjectKey = None
|
||||
elif subObjectName == 'permissions': # subObjectKey in displayName
|
||||
if 'id' in objectValue:
|
||||
if objectValue['id'] == 'anyone':
|
||||
objectValue[subObjectKey] = 'Anyone'
|
||||
elif objectValue['id'] == 'anyoneWithLink':
|
||||
objectValue[subObjectKey] = 'Anyone with Link'
|
||||
else:
|
||||
objectValue[subObjectKey] = objectValue['id']
|
||||
subObjects.insert(0, subObjectKey)
|
||||
for subObject in subObjects:
|
||||
if subObject not in subSkipObjects:
|
||||
_show(subObject, objectValue[subObject], subObjectKey, level+1, DEFAULT_SKIP_OBJECTS)
|
||||
_show(subObject, objectValue[subObject], subObjectKey, None, level+1, DEFAULT_SKIP_OBJECTS)
|
||||
if indentAfterFirst:
|
||||
Ind.Increment()
|
||||
indentAfterFirst = False
|
||||
@@ -9244,7 +9256,7 @@ def showJSON(showName, showValue, skipObjects=None, timeObjects=None,
|
||||
timeObjects = timeObjects or set()
|
||||
simpleLists = simpleLists or set()
|
||||
dictObjectsKey = dictObjectsKey or {}
|
||||
_show(showName, showValue, None, 0, DEFAULT_SKIP_OBJECTS.union(skipObjects or set()))
|
||||
_show(showName, showValue, None, None, 0, DEFAULT_SKIP_OBJECTS.union(skipObjects or set()))
|
||||
|
||||
class FormatJSONQuoteChar():
|
||||
|
||||
@@ -13411,12 +13423,14 @@ REPORTS_PARAMETERS_SIMPLE_TYPES = ['intValue', 'boolValue', 'datetimeValue', 'st
|
||||
# [skipdates <Date>[:<Date>](,<Date>[:<Date>])*] [skipdaysofweek <DayOfWeek>(,<DayOfWeek>)*]
|
||||
# [fields|parameters <String>)]
|
||||
# [convertmbtogb]
|
||||
# (addcsvdata <FieldName> <String>)*
|
||||
# gam report usage customer [todrive <ToDriveAttribute>*]
|
||||
# [([start|startdate <Date>] [end|enddate <Date>])|(range <Date> <Date>)|
|
||||
# thismonth|(previousmonths <Integer>)]
|
||||
# [skipdates <Date>[:<Date>](,<Date>[:<Date>])*] [skipdaysofweek <DayOfWeek>(,<DayOfWeek>)*]
|
||||
# [fields|parameters <String>)]
|
||||
# [convertmbtogb]
|
||||
# (addcsvdata <FieldName> <String>)*
|
||||
def doReportUsage():
|
||||
def usageEntitySelectors():
|
||||
selectorChoices = Cmd.USER_ENTITY_SELECTORS+Cmd.USER_CSVDATA_ENTITY_SELECTORS
|
||||
@@ -13468,6 +13482,7 @@ def doReportUsage():
|
||||
startEndTime = StartEndTime('startdate', 'enddate', 'date')
|
||||
skipDayNumbers = []
|
||||
skipDates = set()
|
||||
addCSVData = {}
|
||||
while Cmd.ArgumentsRemaining():
|
||||
myarg = getArgument()
|
||||
if csvPF and myarg == 'todrive':
|
||||
@@ -13522,6 +13537,9 @@ def doReportUsage():
|
||||
select = True
|
||||
elif myarg == 'convertmbtogb':
|
||||
convertMbToGb = True
|
||||
elif myarg == 'addcsvdata':
|
||||
k = getString(Cmd.OB_STRING)
|
||||
addCSVData[k] = getString(Cmd.OB_STRING, minLen=0)
|
||||
else:
|
||||
unknownArgumentExit()
|
||||
if startEndTime.endDateTime is None:
|
||||
@@ -13555,6 +13573,8 @@ def doReportUsage():
|
||||
titles.append('orgUnitPath')
|
||||
else:
|
||||
pageMessage = None
|
||||
if addCSVData:
|
||||
titles.extend(sorted(addCSVData.keys()))
|
||||
csvPF.SetTitles(titles)
|
||||
csvPF.SetSortAllTitles()
|
||||
parameters = ','.join(parameters) if parameters else None
|
||||
@@ -13589,6 +13609,8 @@ def doReportUsage():
|
||||
row['orgUnitPath'] = userOrgUnits.get(row['user'], UNKNOWN)
|
||||
else:
|
||||
row['user'] = UNKNOWN
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
for item in entity.get('parameters', []):
|
||||
if 'name' not in item:
|
||||
continue
|
||||
@@ -13720,12 +13742,14 @@ REPORT_ACTIVITIES_TIME_OBJECTS = {'time'}
|
||||
# [aggregatebydate|aggregatebyuser [Boolean]]
|
||||
# [maxresults <Number>]
|
||||
# [convertmbtogb]
|
||||
# (addcsvdata <FieldName> <String>)*
|
||||
# gam report customers|customer|domain [todrive <ToDriveAttribute>*]
|
||||
# [(date <Date>)|(range <Date> <Date>)|
|
||||
# yesterday|today|thismonth|(previousmonths <Integer>)]
|
||||
# [nodatechange | (fulldatarequired all|<CustomerServiceNameList>)]
|
||||
# [(fields|parameters <String>)|(services <CustomerServiceNameList>)] [noauthorizedapps]
|
||||
# [convertmbtogb]
|
||||
# (addcsvdata <FieldName> <String>)*
|
||||
def doReport():
|
||||
def processUserUsage(usage, lastDate):
|
||||
if not usage:
|
||||
@@ -13743,6 +13767,8 @@ def doReport():
|
||||
row['orgUnitPath'] = userOrgUnits.get(row['email'], UNKNOWN)
|
||||
else:
|
||||
row['email'] = UNKNOWN
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
for item in user_report.get('parameters', []):
|
||||
if 'name' not in item:
|
||||
continue
|
||||
@@ -13834,6 +13860,8 @@ def doReport():
|
||||
return (False, lastDate)
|
||||
lastDate = usage[0]['date']
|
||||
row = {'date': lastDate}
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
for item in usage[0].get('parameters', []):
|
||||
if 'name' not in item:
|
||||
continue
|
||||
@@ -13908,12 +13936,16 @@ def doReport():
|
||||
continue
|
||||
for ptype in REPORTS_PARAMETERS_SIMPLE_TYPES:
|
||||
if ptype in item:
|
||||
row = {'date': lastDate}
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
if ptype != 'datetimeValue':
|
||||
if convertMbToGb and name.endswith('_in_mb'):
|
||||
name = convertReportMBtoGB(name, item)
|
||||
csvPF.WriteRow({'date': lastDate, 'name': name, 'value': item[ptype]})
|
||||
row.update({'name': name, 'value': item[ptype]})
|
||||
else:
|
||||
csvPF.WriteRow({'date': lastDate, 'name': name, 'value': formatLocalTime(item[ptype])})
|
||||
row.update({'name': name, 'value': formatLocalTime(item[ptype])})
|
||||
csvPF.WriteRow(row)
|
||||
break
|
||||
else:
|
||||
if 'msgValue' in item:
|
||||
@@ -13922,6 +13954,8 @@ def doReport():
|
||||
continue
|
||||
for subitem in item['msgValue']:
|
||||
app = {'date': lastDate}
|
||||
if addCSVData:
|
||||
app.update(addCSVData)
|
||||
for an_item in subitem:
|
||||
if an_item == 'client_name':
|
||||
app['name'] = f'App: {escapeCRsNLs(subitem[an_item])}'
|
||||
@@ -13934,7 +13968,11 @@ def doReport():
|
||||
values = []
|
||||
for subitem in item['msgValue']:
|
||||
values.append(f'{subitem["version_number"]}:{subitem["num_devices"]}')
|
||||
csvPF.WriteRow({'date': lastDate, 'name': name, 'value': ' '.join(sorted(values, reverse=True))})
|
||||
row = {'date': lastDate}
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
row.update({'name': name, 'value': ' '.join(sorted(values, reverse=True))})
|
||||
csvPF.WriteRow(row)
|
||||
else:
|
||||
values = []
|
||||
for subitem in item['msgValue']:
|
||||
@@ -13949,7 +13987,11 @@ def doReport():
|
||||
values.append(f'{myvalue}:{mycount}')
|
||||
else:
|
||||
continue
|
||||
csvPF.WriteRow({'date': lastDate, 'name': name, 'value': ' '.join(sorted(values, reverse=True))})
|
||||
row = {'date': lastDate}
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
row.update({'name': name, 'value': ' '.join(sorted(values, reverse=True))})
|
||||
csvPF.WriteRow(row)
|
||||
csvPF.SortRowsTwoTitles('date', 'name', False)
|
||||
if authorizedApps:
|
||||
csvPF.AddTitle('client_id')
|
||||
@@ -14099,7 +14141,7 @@ def doReport():
|
||||
eventRowFilter = True
|
||||
elif activityReports and myarg == 'groupidfilter':
|
||||
groupIdFilter = getString(Cmd.OB_STRING)
|
||||
elif activityReports and myarg == 'addcsvdata':
|
||||
elif myarg == 'addcsvdata':
|
||||
k = getString(Cmd.OB_STRING)
|
||||
addCSVData[k] = getString(Cmd.OB_STRING, minLen=0)
|
||||
elif activityReports and myarg == 'shownoactivities':
|
||||
@@ -14164,6 +14206,8 @@ def doReport():
|
||||
titles = ['email'] if not showOrgUnit else ['email', 'orgUnitPath']
|
||||
else:
|
||||
titles = ['email', 'date'] if not showOrgUnit else ['email', 'orgUnitPath', 'date']
|
||||
if addCSVData:
|
||||
titles.extend(sorted(addCSVData.keys()))
|
||||
csvPF.SetTitles(titles)
|
||||
csvPF.SetSortAllTitles()
|
||||
i = 0
|
||||
@@ -14250,6 +14294,8 @@ def doReport():
|
||||
if aggregateByDate:
|
||||
for usageDate, events in eventCounts.items():
|
||||
row = {'date': usageDate}
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
for event, count in events.items():
|
||||
if convertMbToGb and event.endswith('_in_gb'):
|
||||
count = f'{count/1024:.2f}'
|
||||
@@ -14262,6 +14308,8 @@ def doReport():
|
||||
row = {'email': email}
|
||||
if showOrgUnit:
|
||||
row['orgUnitPath'] = userOrgUnits.get(email, UNKNOWN)
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
for event, count in events.items():
|
||||
if convertMbToGb and event.endswith('_in_gb'):
|
||||
count = f'{count/1024:.2f}'
|
||||
@@ -14276,6 +14324,8 @@ def doReport():
|
||||
if startEndTime.startDateTime is None:
|
||||
startEndTime.startDateTime = startEndTime.endDateTime = todaysDate()
|
||||
csvPF.SetTitles('date')
|
||||
if addCSVData:
|
||||
csvPF.AddTitles(sorted(addCSVData.keys()))
|
||||
if not userCustomerRange or (startEndTime.startDateTime == startEndTime.endDateTime):
|
||||
csvPF.AddTitles(['name', 'value'])
|
||||
authorizedApps = []
|
||||
@@ -24227,6 +24277,7 @@ CROS_LIST_FIELDS_CHOICE_MAP = {
|
||||
|
||||
CROS_TIME_OBJECTS = {
|
||||
'createTime',
|
||||
'extendedSupportStart',
|
||||
'firstEnrollmentTime',
|
||||
'lastDeprovisionTimestamp',
|
||||
'lastEnrollmentTime',
|
||||
@@ -26506,14 +26557,18 @@ CHAT_TIME_OBJECTS = {'createTime', 'deleteTime', 'eventTime', 'lastActiveTime',
|
||||
def _showChatItem(citem, entityType, FJQC, i=0, count=0):
|
||||
if entityType == Ent.CHAT_SPACE:
|
||||
_cleanChatSpace(citem)
|
||||
dictObjectsKey = {None: 'displayName'}
|
||||
elif entityType == Ent.CHAT_MESSAGE:
|
||||
_cleanChatMessage(citem)
|
||||
dictObjectsKey = {None: 'text'}
|
||||
else:
|
||||
dictObjectsKey={}
|
||||
if FJQC.formatJSON:
|
||||
printLine(json.dumps(cleanJSON(citem, timeObjects=CHAT_TIME_OBJECTS), ensure_ascii=False, sort_keys=True))
|
||||
return
|
||||
printEntity([entityType, citem['name']], i, count)
|
||||
Ind.Increment()
|
||||
showJSON(None, citem, timeObjects=CHAT_TIME_OBJECTS)
|
||||
showJSON(None, citem, timeObjects=CHAT_TIME_OBJECTS, dictObjectsKey=dictObjectsKey)
|
||||
Ind.Decrement()
|
||||
|
||||
def _printChatItem(user, citem, parent, entityType, csvPF, FJQC, addCSVData=None):
|
||||
@@ -26772,14 +26827,14 @@ def getChatSpaceParameters(myarg, body, typeChoicesMap, updateMask):
|
||||
|
||||
CHAT_MEMBER_ROLE_MAP = {
|
||||
'member': 'ROLE_MEMBER',
|
||||
'manager': 'ROLE_MANAGER',
|
||||
'owner': 'ROLE_OWNER',
|
||||
'manager': 'ROLE_ASSISTANT_MANAGER',
|
||||
'owner': 'ROLE_MANAGER',
|
||||
}
|
||||
|
||||
CHAT_ROLE_ENTITY_TYPE_MAP = {
|
||||
'ROLE_MEMBER': Ent.CHAT_MEMBER_USER,
|
||||
'ROLE_MANAGER': Ent.CHAT_MANAGER_USER,
|
||||
'ROLE_OWNER': Ent.CHAT_OWNER_USER,
|
||||
'ROLE_ASSISTANT_MANAGER': Ent.CHAT_MANAGER_USER,
|
||||
'ROLE_MANAGER': Ent.CHAT_OWNER_USER,
|
||||
}
|
||||
|
||||
CHAT_MEMBER_TYPE_MAP = {
|
||||
@@ -26913,7 +26968,8 @@ CHAT_UPDATE_SPACE_TYPE_MAP = {
|
||||
}
|
||||
|
||||
CHAT_SPACE_ROLE_PERMISSIONS_MAP = {
|
||||
'managers': 'managersAllowed',
|
||||
'owners': 'managersAllowed',
|
||||
'managers': 'assistantManagersAllowed',
|
||||
'members': 'membersAllowed',
|
||||
}
|
||||
|
||||
@@ -26933,13 +26989,13 @@ CHAT_UPDATE_SPACE_PERMISSIONS_MAP = {
|
||||
# [type space]
|
||||
# [description <String>] [guidelines|rules <String>]
|
||||
# [history <Boolean>])
|
||||
# managemembersandgroups managers|members
|
||||
# modifyspacedetails managers|members
|
||||
# togglehistory managers|members
|
||||
# useatmentionall managers|members
|
||||
# manageapps managers|members
|
||||
# managewebhooks managers|members
|
||||
# replymessages managers|members
|
||||
# [managemembersandgroups owners|managers|members]
|
||||
# [modifyspacedetails owners|managers|members]
|
||||
# [togglehistory owners|managers|members]
|
||||
# [useatmentionall owners|managers|members]
|
||||
# [manageapps owners|managers|members]
|
||||
# [managewebhooks owners|managers|members]
|
||||
2# [replymessages owners|managers|members]
|
||||
# [formatjson]
|
||||
def updateChatSpace(users):
|
||||
FJQC = FormatJSONQuoteChar()
|
||||
@@ -26957,9 +27013,13 @@ def updateChatSpace(users):
|
||||
body.setdefault('permissionSettings', {})
|
||||
permissionSetting = CHAT_UPDATE_SPACE_PERMISSIONS_MAP[myarg]
|
||||
role = getChoice(CHAT_SPACE_ROLE_PERMISSIONS_MAP, mapChoice=True)
|
||||
body['permissionSettings'][permissionSetting] = {'managersAllowed': True}
|
||||
body['permissionSettings'][permissionSetting] = {}
|
||||
body['permissionSettings'][permissionSetting][role] = True
|
||||
if role == 'membersAllowed':
|
||||
body['permissionSettings'][permissionSetting].update({'membersAllowed': True})
|
||||
body['permissionSettings'][permissionSetting]['assistantManagersAllowed'] = True
|
||||
body['permissionSettings'][permissionSetting]['managersAllowed'] = True
|
||||
elif role == 'assistantManagersAllowed':
|
||||
body['permissionSettings'][permissionSetting]['managersAllowed'] = True
|
||||
updateMask.add(f'permissionSettings.{permissionSetting}')
|
||||
else:
|
||||
FJQC.GetFormatJSON(myarg)
|
||||
@@ -27333,12 +27393,12 @@ def getGroupMemberID(cd, group, groupList):
|
||||
groupList.append(convertEmailAddressToUID(group, cd, emailType='group'))
|
||||
|
||||
# gam <UserTypeEntity> create chatmember <ChatSpace>
|
||||
# [type human|bot] [role member|manager]
|
||||
# [type human|bot] [role member|manager|owner]
|
||||
# (user <UserItem>)* (members <UserTypeEntity>)*
|
||||
# (group <GroupItem>)* (groups <GroupEntity>)*
|
||||
# [formatjson|returnidonly]
|
||||
# gam <UserItem> create chatmember asadmin <ChatSpace>
|
||||
# [type human|bot] [role member|manager]
|
||||
# [type human|bot] [role member|manager|owner]
|
||||
# (user <UserItem>)* (members <UserTypeEntity>)*
|
||||
# (group <GroupItem>)* (groups <GroupEntity>)*
|
||||
# [formatjson|returnidonly]
|
||||
@@ -27467,16 +27527,16 @@ def _deleteChatMembers(chat, kvList, jcount, memberNames, i, count, kwargsUAA):
|
||||
# gam <UserItem> remove chatmember asadmin
|
||||
# members <ChatMemberList>
|
||||
# gam <UserTypeEntity> update chatmember <ChatSpace>
|
||||
# role member|manager
|
||||
# role member|manager|owner
|
||||
# ((user <UserItem>)|(members <UserTypeEntity>))+
|
||||
# gam <UserTypeEntity> modify chatmember
|
||||
# role member|manager
|
||||
# role member|manager|owner
|
||||
# members <ChatMemberList>
|
||||
# gam <UserItem> update chatmember asadmin<ChatSpace>
|
||||
# role member|manager
|
||||
# role member|manager|owner
|
||||
# ((user <UserItem>)|(members <UserTypeEntity>))+
|
||||
# gam <UserItem> modify chatmember asadmin
|
||||
# role member|manager
|
||||
# role member|manager|owner
|
||||
# members <ChatMemberList>
|
||||
def deleteUpdateChatMember(users):
|
||||
cd = buildGAPIObject(API.DIRECTORY)
|
||||
@@ -27570,7 +27630,7 @@ def deleteUpdateChatMember(users):
|
||||
CHAT_SYNC_PREVIEW_TITLES = ['space', 'member', 'role', 'action', 'message']
|
||||
|
||||
# gam <UserTypeEntity> sync chatmembers [asadmin] <ChatSpace>
|
||||
# [role member|manager] [type human|bot]
|
||||
# [role member|manager|owner] [type human|bot]
|
||||
# [addonly|removeonly]
|
||||
# [preview [actioncsv]]
|
||||
# (users <UserTypeEntity>)* (groups <GroupEntity>)*
|
||||
@@ -27986,10 +28046,11 @@ def _getChatSenderEmail(cd, sender):
|
||||
sender['email'], _ = convertUIDtoEmailAddressWithType(f'uid:{senderUid}', cd, None, emailTypes=['user'])
|
||||
|
||||
def trimChatMessageIfRequired(body):
|
||||
msgLen = len(body['text'])
|
||||
if msgLen > 4096:
|
||||
stderrWarningMsg(Msg.TRIMMED_MESSAGE_FROM_LENGTH_TO_MAXIMUM.format(msgLen, 4096))
|
||||
body['text'] = body['text'][:4095]
|
||||
if 'text' in body:
|
||||
msgLen = len(body['text'])
|
||||
if msgLen > 4096:
|
||||
stderrWarningMsg(Msg.TRIMMED_MESSAGE_FROM_LENGTH_TO_MAXIMUM.format(msgLen, 4096))
|
||||
body['text'] = body['text'][:4095]
|
||||
|
||||
CHAT_MESSAGE_REPLY_OPTION_MAP = {
|
||||
'fail': 'REPLY_MESSAGE_OR_FAIL',
|
||||
@@ -28066,22 +28127,29 @@ def doCreateChatMessage():
|
||||
createChatMessage([None])
|
||||
|
||||
# gam [<UserTypeMessage>] update chatmessage name <ChatMessage>
|
||||
# <ChatContent>
|
||||
# [<ChatContent>] [clearattachments <String>]
|
||||
def updateChatMessage(users):
|
||||
name = None
|
||||
body = {}
|
||||
updateMask = []
|
||||
clearMsg = ''
|
||||
while Cmd.ArgumentsRemaining():
|
||||
myarg = getArgument()
|
||||
if myarg == 'name':
|
||||
name = getString(Cmd.OB_CHAT_MESSAGE)
|
||||
elif myarg in SORF_TEXT_ARGUMENTS:
|
||||
body['text'] = getStringOrFile(myarg, minLen=0, unescapeCRLF=True)[0]
|
||||
updateMask.append('text')
|
||||
elif myarg == 'clearattachments':
|
||||
clearMsg = getString(Cmd.OB_STRING, minLen=0)
|
||||
body['attachment'] = []
|
||||
updateMask.append('attachment')
|
||||
else:
|
||||
unknownArgumentExit()
|
||||
if not name:
|
||||
missingArgumentExit('name')
|
||||
if 'text' not in body:
|
||||
missingArgumentExit('text or textfile')
|
||||
if not updateMask:
|
||||
missingArgumentExit('text|textfile|clearattachments')
|
||||
trimChatMessageIfRequired(body)
|
||||
i, count, users = getEntityArgument(users)
|
||||
for user in users:
|
||||
@@ -28090,9 +28158,19 @@ def updateChatMessage(users):
|
||||
if not chat:
|
||||
continue
|
||||
try:
|
||||
if 'attachment' in updateMask and 'text' not in updateMask:
|
||||
resp = callGAPI(chat.spaces().messages(), 'get',
|
||||
throwReasons=[GAPI.NOT_FOUND, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED, GAPI.FAILED_PRECONDITION],
|
||||
name=name, fields='text')
|
||||
body['text'] = resp.get('text', '')
|
||||
if clearMsg:
|
||||
body['text'] += clearMsg
|
||||
elif not body['text']:
|
||||
body['text'] = 'Attachments cleared'
|
||||
updateMask.append('text')
|
||||
resp = callGAPI(chat.spaces().messages(), 'patch',
|
||||
throwReasons=[GAPI.NOT_FOUND, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED, GAPI.FAILED_PRECONDITION],
|
||||
name=name, updateMask='text', body=body)
|
||||
name=name, updateMask=','.join(updateMask), body=body)
|
||||
kvList.extend([Ent.CHAT_THREAD, resp['thread']['name']])
|
||||
entityActionPerformed(kvList, i, count)
|
||||
except (GAPI.notFound, GAPI.invalidArgument, GAPI.permissionDenied) as e:
|
||||
@@ -33001,6 +33079,8 @@ def doCreateGroup(ciGroupsAPI=False):
|
||||
initialGroupConfig = 'WITH_INITIAL_OWNER'
|
||||
elif ciGroupsAPI and myarg in {'security', 'makesecuritygroup'}:
|
||||
body['labels'][CIGROUP_SECURITY_LABEL] = ''
|
||||
elif ciGroupsAPI and myarg in ['locked']:
|
||||
body['labels'][CIGROUP_LOCKED_LABEL] = ''
|
||||
elif myarg == 'verifynotinvitable':
|
||||
verifyNotInvitable = True
|
||||
else:
|
||||
@@ -35892,7 +35972,7 @@ def doPrintShowGroupTree():
|
||||
# gam create cigroup <EmailAddress>
|
||||
# [copyfrom <GroupItem>] <GroupAttribute>
|
||||
# [makeowner] [alias|aliases <CIGroupAliasList>]
|
||||
# [security|makesecuritygroup]
|
||||
# [security|makesecuritygroup] [locked]
|
||||
# [dynamic <QueryDynamicGroup>]
|
||||
def doCreateCIGroup():
|
||||
doCreateGroup(ciGroupsAPI=True)
|
||||
@@ -36076,7 +36156,6 @@ def doUpdateCIGroups():
|
||||
|
||||
cd = buildGAPIObject(API.DIRECTORY)
|
||||
ci = buildGAPIObject(API.CLOUDIDENTITY_GROUPS)
|
||||
cib = None
|
||||
entityType = Ent.CLOUD_IDENTITY_GROUP
|
||||
csvPF = None
|
||||
getBeforeUpdate = preview = False
|
||||
@@ -36185,7 +36264,6 @@ def doUpdateCIGroups():
|
||||
_, name, _ = convertGroupEmailToCloudID(ci, group, i, count)
|
||||
if not name:
|
||||
continue
|
||||
cipl = ci
|
||||
twoUpdates = False
|
||||
if 'labels' in ci_body or lockGroup is not None:
|
||||
try:
|
||||
@@ -36214,20 +36292,16 @@ def doUpdateCIGroups():
|
||||
else:
|
||||
if CIGROUP_LOCKED_LABEL in ci_body['labels']:
|
||||
ci_body['labels'].pop(CIGROUP_LOCKED_LABEL)
|
||||
if CIGROUP_LOCKED_LABEL in ci_body['labels']:
|
||||
if cib is None:
|
||||
cib = buildGAPIObject(API.CLOUDIDENTITY_GROUPS_BETA)
|
||||
cipl = cib
|
||||
if ci_body:
|
||||
try:
|
||||
if twoUpdates:
|
||||
ci_body['labels'].pop(CIGROUP_LOCKED_LABEL)
|
||||
callGAPI(cipl.groups(), 'patch',
|
||||
callGAPI(ci.groups(), 'patch',
|
||||
throwReasons=GAPI.CIGROUP_UPDATE_THROW_REASONS,
|
||||
retryReasons=GAPI.CIGROUP_RETRY_REASONS,
|
||||
name=name, body=ci_body, updateMask=','.join(list(ci_body.keys())))
|
||||
ci_body['labels'][CIGROUP_LOCKED_LABEL] = ''
|
||||
callGAPI(cipl.groups(), 'patch',
|
||||
callGAPI(ci.groups(), 'patch',
|
||||
throwReasons=GAPI.CIGROUP_UPDATE_THROW_REASONS,
|
||||
retryReasons=GAPI.CIGROUP_RETRY_REASONS,
|
||||
name=name, body=ci_body, updateMask=','.join(list(ci_body.keys())))
|
||||
@@ -37211,20 +37285,17 @@ def doPrintCIGroups():
|
||||
else:
|
||||
getFullFieldsList = list(CIGROUP_FULL_FIELDS)
|
||||
getFullFields = ','.join(getFullFieldsList)#
|
||||
cipl = ci
|
||||
if query:
|
||||
method = 'search'
|
||||
if 'parent' not in query:
|
||||
query += f" && parent == '{parent}'"
|
||||
kwargs = {'query': query}
|
||||
if CIGROUP_LOCKED_LABEL in query:
|
||||
cipl = buildGAPIObject(API.CLOUDIDENTITY_GROUPS_BETA)
|
||||
else:
|
||||
method = 'list'
|
||||
kwargs = {'parent': parent}
|
||||
printGettingAllAccountEntities(Ent.CLOUD_IDENTITY_GROUP, query)
|
||||
try:
|
||||
entityList = callGAPIpages(cipl.groups(), method, 'groups',
|
||||
entityList = callGAPIpages(ci.groups(), method, 'groups',
|
||||
pageMessage=getPageMessage(showFirstLastItems=True), messageAttribute=['groupKey', 'id'],
|
||||
throwReasons=GAPI.CIGROUP_LIST_THROW_REASONS, retryReasons=GAPI.CIGROUP_RETRY_REASONS,
|
||||
view='FULL', fields=fieldsnp, pageSize=pageSize, **kwargs)
|
||||
@@ -44207,6 +44278,28 @@ USER_JSON_SKIP_FIELDS = ['agreedToTerms', 'aliases', 'creationTime', 'customerId
|
||||
|
||||
ALLOW_EMPTY_CUSTOM_TYPE = 'allowEmptyCustomType'
|
||||
|
||||
def getNotifyArguments(myarg, notify, userNotification):
|
||||
if myarg == 'notify':
|
||||
if userNotification:
|
||||
notify['recipients'].extend(getNormalizedEmailAddressEntity(shlexSplit=True, noLower=True))
|
||||
else: #delegateNotificatiomn
|
||||
notify['notify'] = getBoolean()
|
||||
elif myarg == 'subject':
|
||||
notify['subject'] = getString(Cmd.OB_STRING)
|
||||
elif myarg in SORF_MSG_FILE_ARGUMENTS:
|
||||
notify['message'], notify['charset'], notify['html'] = getStringOrFile(myarg)
|
||||
elif myarg == 'html':
|
||||
notify['html'] = getBoolean()
|
||||
elif myarg == 'from':
|
||||
notify['from'] = getString(Cmd.OB_EMAIL_ADDRESS)
|
||||
elif myarg == 'mailbox':
|
||||
notify['mailbox'] = getString(Cmd.OB_EMAIL_ADDRESS)
|
||||
elif myarg == 'replyto':
|
||||
notify['replyto'] = getString(Cmd.OB_EMAIL_ADDRESS)
|
||||
else:
|
||||
return False
|
||||
return True
|
||||
|
||||
def getUserAttributes(cd, updateCmd, noUid=False):
|
||||
def getKeywordAttribute(keywords, attrdict, **opts):
|
||||
if Cmd.ArgumentsRemaining():
|
||||
@@ -44322,22 +44415,10 @@ def getUserAttributes(cd, updateCmd, noUid=False):
|
||||
resolveConflictAccount = True
|
||||
while Cmd.ArgumentsRemaining():
|
||||
myarg = getArgument()
|
||||
if myarg == 'notify':
|
||||
notify['recipients'].extend(getNormalizedEmailAddressEntity(shlexSplit=True, noLower=True))
|
||||
if getNotifyArguments(myarg, notify, True):
|
||||
pass
|
||||
elif myarg == 'notifyrecoveryemail':
|
||||
parameters['notifyRecoveryEmail'] = True
|
||||
elif myarg == 'subject':
|
||||
notify['subject'] = getString(Cmd.OB_STRING)
|
||||
elif myarg in SORF_MSG_FILE_ARGUMENTS:
|
||||
notify['message'], notify['charset'], notify['html'] = getStringOrFile(myarg)
|
||||
elif myarg == 'html':
|
||||
notify['html'] = getBoolean()
|
||||
elif myarg == 'from':
|
||||
notify['from'] = getString(Cmd.OB_EMAIL_ADDRESS)
|
||||
elif myarg == 'replyto':
|
||||
notify['replyto'] = getString(Cmd.OB_EMAIL_ADDRESS)
|
||||
elif myarg == 'mailbox':
|
||||
notify['mailbox'] = getString(Cmd.OB_EMAIL_ADDRESS)
|
||||
elif PwdOpts.ProcessArgument(myarg, notify, notFoundBody):
|
||||
pass
|
||||
elif _getTagReplacement(myarg, tagReplacements, True):
|
||||
@@ -44743,12 +44824,12 @@ def createUserAddAliases(cd, user, aliasList, i, count):
|
||||
# [license <SKUID> [product|productid <ProductID>]]
|
||||
# [[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
# [subject <String>]
|
||||
# [notifypassword <String>]
|
||||
# [from <EmailAaddress>]
|
||||
# [from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
# [replyto <EmailAaddress>]
|
||||
# [<NotifyMessageContent>]
|
||||
# (replace <Tag> <UserReplacement>)*
|
||||
# (replaceregex <REMatchPattern> <RESubstitution> <Tag> <UserReplacement>)*]
|
||||
# [notifypassword <String>]
|
||||
# [<NotifyMessageContent>] [html [<Boolean>]]
|
||||
# (replace <Tag> <UserReplacement>)*
|
||||
# (replaceregex <REMatchPattern> <RESubstitution> <Tag> <UserReplacement>)*]
|
||||
# [logpassword <FileName>] [ignorenullpassword]
|
||||
# [addnumericsuffixonduplicate <Number>]
|
||||
def doCreateUser():
|
||||
@@ -44847,12 +44928,12 @@ def verifyUserPrimaryEmail(cd, user, createIfNotFound, i, count):
|
||||
# [alias|aliases <EmailAddressList>]
|
||||
# [[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
# [subject <String>]
|
||||
# [notifypassword <String>]
|
||||
# [from <EmailAaddress>]
|
||||
# [from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
# [replyto <EmailAaddress>]
|
||||
# [<NotifyMessageContent>
|
||||
# [<NotifyMessageContent> [html [<Boolean>]]
|
||||
# (replace <Tag> <UserReplacement>)*
|
||||
# (replaceregex <REMatchPattern> <RESubstitution> <Tag> <UserReplacement>)*]
|
||||
# [notifypassword <String>]]
|
||||
# [notifyonupdate [<Boolean>]]
|
||||
# [logpassword <FileName>] [ignorenullpassword]
|
||||
def updateUsers(entityList):
|
||||
@@ -49127,6 +49208,7 @@ def _getCoursesInfo(croom, courseSelectionParameters, courseShowProperties, getO
|
||||
# [show none|all|students|teachers] [countsonly]
|
||||
# [fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>]
|
||||
# [timefilter creationtime|updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
||||
# (addcsvdata <FieldName> <String>)*
|
||||
# [showitemcountonly] [formatjson [quotechar <Character>]]
|
||||
def doPrintCourses():
|
||||
def _saveParticipants(course, participants, role, rtitles):
|
||||
@@ -49170,6 +49252,7 @@ def doPrintCourses():
|
||||
delimiter = GC.Values[GC.CSV_OUTPUT_FIELD_DELIMITER]
|
||||
showItemCountOnly = False
|
||||
useOwnerAccess = GC.Values[GC.USE_COURSE_OWNER_ACCESS]
|
||||
addCSVData = {}
|
||||
while Cmd.ArgumentsRemaining():
|
||||
myarg = getArgument()
|
||||
if myarg == 'todrive':
|
||||
@@ -49184,6 +49267,9 @@ def doPrintCourses():
|
||||
pass
|
||||
elif myarg == 'showitemcountonly':
|
||||
showItemCountOnly = True
|
||||
elif myarg == 'addcsvdata':
|
||||
k = getString(Cmd.OB_STRING)
|
||||
addCSVData[k] = getString(Cmd.OB_STRING, minLen=0)
|
||||
else:
|
||||
FJQC.GetFormatJSONQuoteChar(myarg, True)
|
||||
applyCourseItemFilter = _setApplyCourseItemFilter(courseItemFilter, None)
|
||||
@@ -49195,6 +49281,11 @@ def doPrintCourses():
|
||||
if showItemCountOnly:
|
||||
writeStdout('0\n')
|
||||
return
|
||||
if addCSVData:
|
||||
csvPF.AddTitles(sorted(addCSVData.keys()))
|
||||
if FJQC.formatJSON:
|
||||
csvPF.AddJSONTitles(sorted(addCSVData.keys()))
|
||||
csvPF.MoveJSONTitlesToEnd(['JSON'])
|
||||
if courseShowProperties['aliases']:
|
||||
if FJQC.formatJSON:
|
||||
csvPF.AddJSONTitles('JSON-aliases')
|
||||
@@ -49252,11 +49343,15 @@ def doPrintCourses():
|
||||
if courseShowProperties['members'] != 'teachers':
|
||||
_saveParticipants(course, students, 'students', stitles)
|
||||
row = flattenJSON(course, timeObjects=COURSE_TIME_OBJECTS, noLenObjects=COURSE_NOLEN_OBJECTS)
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
if not FJQC.formatJSON:
|
||||
csvPF.WriteRowTitles(row)
|
||||
elif csvPF.CheckRowTitles(row):
|
||||
row = {'id': courseId, 'JSON': json.dumps(cleanJSON(course, timeObjects=COURSE_TIME_OBJECTS),
|
||||
ensure_ascii=False, sort_keys=True)}
|
||||
if addCSVData:
|
||||
row.update(addCSVData)
|
||||
if courseShowProperties['aliases']:
|
||||
row['JSON-aliases'] = json.dumps(list(aliases))
|
||||
if courseShowProperties['members'] != 'none':
|
||||
@@ -64917,11 +65012,11 @@ def claimOwnership(users):
|
||||
elif myarg == 'onlyusers':
|
||||
_, userList = getEntityToModify(defaultEntityType=Cmd.ENTITY_USERS)
|
||||
checkOnly = True
|
||||
onlyOwners = set(userList)
|
||||
onlyOwners = {normalizeEmailAddressOrUID(user, noUid=True) for user in userList}
|
||||
elif myarg == 'skipusers':
|
||||
_, userList = getEntityToModify(defaultEntityType=Cmd.ENTITY_USERS)
|
||||
checkSkip = len(userList) > 0
|
||||
skipOwners = set(userList)
|
||||
skipOwners = {normalizeEmailAddressOrUID(user, noUid=True) for user in userList}
|
||||
elif myarg == 'subdomains':
|
||||
subdomains = getEntityList(Cmd.OB_DOMAIN_NAME_ENTITY)
|
||||
elif myarg == 'includetrashed':
|
||||
@@ -73894,14 +73989,58 @@ def printShowMessages(users):
|
||||
def printShowThreads(users):
|
||||
printShowMessagesThreads(users, Ent.THREAD)
|
||||
|
||||
def sendCreateDelegateNotification(user, delegate, basenotify, i=0, count=0, msgFrom=None):
|
||||
# Substitute for #user#, #delegate#
|
||||
def _substituteForPattern(field, pattern, value):
|
||||
if field.find('#') == -1:
|
||||
return field
|
||||
return field.replace(pattern, value)
|
||||
|
||||
def _makeSubstitutions(field):
|
||||
notify[field] = _substituteForPattern(notify[field], '#user#', user)
|
||||
notify[field] = _substituteForPattern(notify[field], '#delegate#', delegate)
|
||||
|
||||
notify = basenotify.copy()
|
||||
if not notify['subject']:
|
||||
notify['subject'] = Msg.CREATE_DELEGATE_NOTIFY_SUBJECT
|
||||
_makeSubstitutions('subject')
|
||||
if not notify['message']:
|
||||
notify['message'] = Msg.CREATE_DELEGATE_NOTIFY_MESSAGE
|
||||
elif notify['html']:
|
||||
notify['message'] = notify['message'].replace('\r', '').replace('\\n', '<br/>')
|
||||
else:
|
||||
notify['message'] = notify['message'].replace('\r', '').replace('\\n', '\n')
|
||||
_makeSubstitutions('message')
|
||||
if 'from' in notify:
|
||||
msgFrom = notify['from']
|
||||
msgReplyTo = notify.get('replyto', None)
|
||||
mailBox = notify.get('mailbox', None)
|
||||
send_email(notify['subject'], notify['message'], delegate, i, count,
|
||||
msgFrom=msgFrom, msgReplyTo=msgReplyTo, html=notify['html'], charset=notify['charset'], mailBox=mailBox)
|
||||
|
||||
# gam <UserTypeEntity> create delegate|delegates [convertalias] <UserEntity>
|
||||
# [notify [<Boolean>]
|
||||
# [subject <String>]
|
||||
# [from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
# [replyto <EmailAaddress>]
|
||||
# [<NotifyMessageContent>] [html [<Boolean>]]
|
||||
# ]
|
||||
# gam <UserTypeEntity> delete delegate|delegates [convertalias] <UserEntity>
|
||||
def processDelegates(users):
|
||||
cd = buildGAPIObject(API.DIRECTORY)
|
||||
function = 'delete' if Act.Get() == Act.DELETE else 'create'
|
||||
createCmd = Act.Get() != Act.DELETE
|
||||
aliasAllowed = not checkArgumentPresent(['convertalias'])
|
||||
delegateEntity = getUserObjectEntity(Cmd.OB_USER_ENTITY, Ent.DELEGATE)
|
||||
checkForExtraneousArguments()
|
||||
notify = {'notify': False, 'subject': '', 'message': '', 'html': False, 'charset': UTF8}
|
||||
if createCmd:
|
||||
while Cmd.ArgumentsRemaining():
|
||||
myarg = getArgument()
|
||||
if getNotifyArguments(myarg, notify, False):
|
||||
pass
|
||||
else:
|
||||
unknownArgumentExit()
|
||||
else:
|
||||
checkForExtraneousArguments()
|
||||
i, count, users = getEntityArgument(users)
|
||||
for user in users:
|
||||
i += 1
|
||||
@@ -73913,25 +74052,37 @@ def processDelegates(users):
|
||||
for delegate in delegates:
|
||||
j += 1
|
||||
delegateEmail = convertUIDtoEmailAddress(delegate, cd=cd, emailTypes=['user', 'group'], aliasAllowed=aliasAllowed)
|
||||
kvList = [Ent.USER, user, Ent.DELEGATE, delegateEmail]
|
||||
try:
|
||||
if function == 'create':
|
||||
callGAPI(gmail.users().settings().delegates(), function,
|
||||
if createCmd:
|
||||
callGAPI(gmail.users().settings().delegates(), 'create',
|
||||
throwReasons=GAPI.GMAIL_THROW_REASONS+[GAPI.ALREADY_EXISTS, GAPI.FAILED_PRECONDITION, GAPI.INVALID,
|
||||
GAPI.NOT_FOUND, GAPI.INVALID_ARGUMENT, GAPI.PERMISSION_DENIED],
|
||||
userId='me', body={'delegateEmail': delegateEmail})
|
||||
entityActionPerformed(kvList, j, jcount)
|
||||
if notify['notify']:
|
||||
Ind.Increment()
|
||||
sendCreateDelegateNotification(user, delegateEmail, notify, j, jcount)
|
||||
Ind.Decrement()
|
||||
else:
|
||||
callGAPI(gmail.users().settings().delegates(), function,
|
||||
callGAPI(gmail.users().settings().delegates(), 'delete',
|
||||
throwReasons=GAPI.GMAIL_THROW_REASONS+[GAPI.NOT_FOUND, GAPI.INVALID_INPUT, GAPI.PERMISSION_DENIED],
|
||||
userId='me', delegateEmail=delegateEmail)
|
||||
entityActionPerformed([Ent.USER, user, Ent.DELEGATE, delegateEmail], j, jcount)
|
||||
entityActionPerformed(kvList, j, jcount)
|
||||
except (GAPI.alreadyExists, GAPI.failedPrecondition, GAPI.invalid,
|
||||
GAPI.notFound, GAPI.invalidArgument, GAPI.permissionDenied) as e:
|
||||
entityActionFailedWarning([Ent.USER, user, Ent.DELEGATE, delegateEmail], str(e), j, jcount)
|
||||
entityActionFailedWarning(kvList, str(e), j, jcount)
|
||||
except GAPI.serviceNotAvailable:
|
||||
userGmailServiceNotEnabledWarning(user, i, count)
|
||||
Ind.Decrement()
|
||||
|
||||
# gam <UserTypeEntity> delegate to [convertalias] <UserEntity>
|
||||
# [notify [<Boolean>]
|
||||
# [subject <String>]
|
||||
# [from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
# [replyto <EmailAaddress>]
|
||||
# [<NotifyMessageContent>] [html [<Boolean>]]
|
||||
# ]
|
||||
def delegateTo(users):
|
||||
checkArgumentPresent('to', required=True)
|
||||
processDelegates(users)
|
||||
|
||||
@@ -46,7 +46,6 @@ CLASSROOM = 'classroom'
|
||||
CLOUDCHANNEL = 'cloudchannel'
|
||||
CLOUDIDENTITY_DEVICES = 'cloudidentitydevices'
|
||||
CLOUDIDENTITY_GROUPS = 'cloudidentitygroups'
|
||||
CLOUDIDENTITY_GROUPS_BETA = 'cloudidentitygroupsbeta'
|
||||
CLOUDIDENTITY_INBOUND_SSO = 'cloudidentityinboundsso'
|
||||
CLOUDIDENTITY_ORGUNITS = 'cloudidentityorgunits'
|
||||
CLOUDIDENTITY_ORGUNITS_BETA = 'cloudidentityorgunitsbeta'
|
||||
@@ -242,7 +241,6 @@ _INFO = {
|
||||
CLOUDCHANNEL: {'name': 'Cloud Channel API', 'version': 'v1', 'v2discovery': True},
|
||||
CLOUDIDENTITY_DEVICES: {'name': 'Cloud Identity API - Devices', 'version': 'v1', 'v2discovery': True, 'mappedAPI': 'cloudidentity'},
|
||||
CLOUDIDENTITY_GROUPS: {'name': 'Cloud Identity API - Groups', 'version': 'v1', 'v2discovery': True, 'mappedAPI': 'cloudidentity'},
|
||||
CLOUDIDENTITY_GROUPS_BETA: {'name': 'Cloud Identity API - Groups Beta', 'version': 'v1beta1', 'v2discovery': True, 'mappedAPI': 'cloudidentity'},
|
||||
CLOUDIDENTITY_INBOUND_SSO: {'name': 'Cloud Identity API - Inbound SSO Settings', 'version': 'v1', 'v2discovery': True, 'mappedAPI': 'cloudidentity'},
|
||||
CLOUDIDENTITY_ORGUNITS: {'name': 'Cloud Identity API - OrgUnits', 'version': 'v1', 'v2discovery': True, 'mappedAPI': 'cloudidentity'},
|
||||
CLOUDIDENTITY_ORGUNITS_BETA: {'name': 'Cloud Identity API - OrgUnits Beta', 'version': 'v1beta1', 'v2discovery': True, 'mappedAPI': 'cloudidentity'},
|
||||
@@ -387,10 +385,6 @@ _CLIENT_SCOPES = [
|
||||
'api': CLOUDIDENTITY_GROUPS,
|
||||
'subscopes': READONLY,
|
||||
'scope': 'https://www.googleapis.com/auth/cloud-identity.groups'},
|
||||
{'name': 'Cloud Identity API - Groups Beta (Enables group locking/unlocking)',
|
||||
'api': CLOUDIDENTITY_GROUPS_BETA,
|
||||
'subscopes': [],
|
||||
'scope': 'https://www.googleapis.com/auth/cloud-identity.groups'},
|
||||
{'name': 'Cloud Identity API - Inbound SSO Settings',
|
||||
'api': CLOUDIDENTITY_INBOUND_SSO,
|
||||
'subscopes': READONLY,
|
||||
|
||||
@@ -224,6 +224,8 @@ COUNT_N_EXCEEDS_MAX_TO_PROCESS_M = 'Count {0} exceeds maximum to {1} {2}'
|
||||
CORRUPT_FILE = 'Corrupt file'
|
||||
COULD_NOT_FIND_ANY_YUBIKEY = 'Could not find any YubiKey\n'
|
||||
COULD_NOT_FIND_YUBIKEY_WITH_SERIAL = 'Could not find YubiKey with serial number {0}\n'
|
||||
CREATE_DELEGATE_NOTIFY_MESSAGE = '#user# has granted you #delegate# access to read, delete and send mail on their behalf.'
|
||||
CREATE_DELEGATE_NOTIFY_SUBJECT = '#user# mail delegation to #delegate#'
|
||||
CREATE_USER_NOTIFY_MESSAGE = 'Hello #givenname# #familyname#,\n\nYou have a new account at #domain#\nAccount details:\nUsername: #user#\nPassword: #password#\nStart using your new account by signing in at\nhttps://www.google.com/accounts/AccountChooser?Email=#user#&continue=https://workspace.google.com/dashboard\n'
|
||||
CREATE_USER_NOTIFY_SUBJECT = 'Welcome to #domain#'
|
||||
CSV_DATA_ALREADY_SAVED = 'CSV data already saved'
|
||||
@@ -516,7 +518,7 @@ To set up Google Chat for your current project, please go to:
|
||||
|
||||
and follow the instructions at:
|
||||
|
||||
https://github.com/GAM-team/GAM/wiki/Chat-Bot#set-up-a-chat-bot
|
||||
https://github.com/GAM-team/GAM/wiki/Chat-Bot-Setup-Use#set-up-a-chat-bot
|
||||
|
||||
You'll use projects/{1}/topics/no-topic in Connection settings Cloud Pub/Sub Topic Name
|
||||
"""
|
||||
|
||||
@@ -1524,9 +1524,7 @@ gam config csv_input_row_filter "scopeType:regex:ORG_UNIT" redirect stdout ./Upd
|
||||
```
|
||||
|
||||
## Copy non-system admin roles from a source workspace to a target workspace
|
||||
This requires GAM version 7.18.01 or higher.
|
||||
|
||||
In the source workspace to the following:
|
||||
In the source workspace do the following:
|
||||
```
|
||||
gam redirect csv ./SourceNonSystemRoles.csv print adminroles privileges nosystemroles formatjson quotechar "'"
|
||||
```
|
||||
|
||||
@@ -9,8 +9,6 @@
|
||||
|
||||
|
||||
## Introduction
|
||||
These features were added in version 7.18.00.
|
||||
|
||||
To use these commands you add the 'Business Account Management API' to your project and update client authorization.
|
||||
```
|
||||
gam update project
|
||||
|
||||
@@ -43,7 +43,7 @@ Even if you're not going to use GAM as a Chat Bot, you have to configure a Chat
|
||||
* Uncheck "Build this Chat app as a Workspace add-on."
|
||||
* Enter an App name and Description of your choosing.
|
||||
* For the Avatar URL you can use `https://dummyimage.com/384x256/4d4d4d/0011ff.png&text=+GAM` or a public URL to an image of your own choosing.
|
||||
* In Functionality, uncheck both "Receive 1:1 messages" and "Join spaces and group conversations"
|
||||
* Inƒ Functionality, uncheck both "Receive 1:1 messages" and "Join spaces and group conversations" if present
|
||||
* In Connection settings, choose "Cloud Pub/Sub" and enter `projects/<ProjectID>/topics/no-topic` for the Topic Name. Replace `<ProjectID>` with your GAM project ID. GAM doesn't yet listen to pub/sub so this option is not used.
|
||||
* In Visibility, uncheck "Make this Chat app available to specific people and groups in Domain Workspace".
|
||||
* Click Save.
|
||||
@@ -288,7 +288,7 @@ gam create chatmessage spaces spaces/AAAADi-pvqc gdoc announcements@domain.com n
|
||||
Updates and rewrites an existing Chat message. Message will show as edited and no notification will be sent to members.
|
||||
```
|
||||
gam update chatmessage name <ChatMessage>
|
||||
<ChatContent>
|
||||
[<ChatContent>] [clearattachments <String>]
|
||||
```
|
||||
Specify the source of the message:
|
||||
* `text <String>` - The message is `<String>`
|
||||
@@ -296,12 +296,22 @@ Specify the source of the message:
|
||||
* `gdoc <UserGoogleDoc>` - The message is read from a Google Doc.
|
||||
* `gcsdoc <StorageBucketObjectName>` - The message is read from a Google Cloud Storage file.
|
||||
|
||||
The option `clearattachments <String>` can be used to clear all attachments from a Chat message.
|
||||
If `<ChatContent>` is not specified, the current message text is retained and `<String>` is appended;
|
||||
`<String>` must be specified but can be empty in which case the current message test is preserved as-is.
|
||||
|
||||
### Example
|
||||
|
||||
This example updates an existing chat message with new text.
|
||||
```
|
||||
gam update chatmessage name spaces/AAAADi-pvqc/messages/PKJrx90ooIU.PKJrx90ooIU text "HELLO CHAT?"
|
||||
```
|
||||
|
||||
This example clears attachments from a chat message and appends ` - Attachments cleared`
|
||||
to the current message text.
|
||||
```
|
||||
gam update chatmessage name spaces/AAAADi-pvqc/messages/PKJrx90ooIU.PKJrx90ooIU clearattachments " - Attachments cleared"
|
||||
```
|
||||
----
|
||||
|
||||
## Delete a Chat Message
|
||||
|
||||
@@ -10,8 +10,6 @@
|
||||
- [Display Chrome Profile commands](#display-chrome-profile-commands)
|
||||
|
||||
## Introduction
|
||||
These features were added in version 7.01.00.
|
||||
|
||||
To use these commands you must update your client authorization.
|
||||
```
|
||||
gam oauth create
|
||||
|
||||
@@ -410,7 +410,7 @@ gam update ou csvkmd cros.csv keyfield OU datafield deviceId add croscsvdata dev
|
||||
gam <CrOSTypeEntity> update action <CrOSAction> [acknowledge_device_touch_requirement]
|
||||
[actionbatchsize <Integer>]
|
||||
```
|
||||
As of GAM version `6.67.00`, the new API function `batchChangeStatus` replaces the old API function `action`; ChromeOS devices are now processed in batches.
|
||||
ChromeOS devices are now processed in batches.
|
||||
The batch size defaults to 10, the `actionbatchsize <Integer>` option can be used to set a batch size between 10 and 250.
|
||||
|
||||
As deprovisioning ChromeOS devices is not reversible, you must enter `acknowledge_device_touch_requirement`
|
||||
@@ -711,7 +711,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print cros query "sync:..2020-01-01" showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print cros query "sync:..2020-01-01" showitemcountonly
|
||||
$count = & gam print cros query "sync:..2020-01-01" showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print cros query "sync:..2020-01-01" showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Print ChromeOS device activity
|
||||
|
||||
@@ -441,8 +441,10 @@ gam print courses [todrive <ToDriveAttribute>*]
|
||||
[owneremail] [owneremailmatchpattern <REMatchPattern>]
|
||||
[alias|aliases|aliasesincolumns [delimiter <Character>]]
|
||||
[show all|students|teachers] [countsonly]
|
||||
[fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>] [formatjson [quotechar <Character>]]
|
||||
[timefilter creationtime|updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
||||
[fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>] [formatjson [quotechar <Character>]]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
[formatjson [quotechar <Character>]]
|
||||
```
|
||||
By default, the `print courses` command displays information about all courses.
|
||||
|
||||
@@ -477,6 +479,7 @@ By default, all basic course fields are displayed; use the following options to
|
||||
* `countsonly` - Eliminates the student/teacher profile information and outputs only the student/teacher counts.
|
||||
* `fields <CourseFieldNameList>` - Select specific basic fields to display.
|
||||
* `skipfields <CourseFieldNameList>` - Select specific basic fields to eliminate from display; typically used with `coursematerialsets`.
|
||||
* `addcsvdata <FieldName> <String>` - Add additional columns of data from the command line to the output
|
||||
|
||||
By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,
|
||||
* `formatjson` - Display the fields in JSON format.
|
||||
@@ -511,7 +514,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print courses states active showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print courses states active showitemcountonly
|
||||
$count = & gam print courses states active showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print courses states active showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Display course announcements
|
||||
|
||||
@@ -163,5 +163,7 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print course-participants teacher asmith states active show students showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print course-participants teacher asmith states active show students showitemcountonly
|
||||
$count = & gam print course-participants teacher asmith states active show students showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print course-participants teacher asmith states active show students showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
@@ -269,5 +269,7 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print course-participants teacher asmith states active show students showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print course-participants teacher asmith states active show students showitemcountonly
|
||||
$count = & gam print course-participants teacher asmith states active show students showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print course-participants teacher asmith states active show students showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
@@ -272,7 +272,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print devices queries "'model:Mac'" showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print devices queries "'model:Mac'" showitemcountonly
|
||||
$count = & gam print devices queries "'model:Mac'" showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print devices queries "'model:Mac'" showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Approve or block device users
|
||||
@@ -363,7 +365,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print deviceusers queries "'model:Mac'" showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print deviceusers queries "'model:Mac'" showitemcountonly
|
||||
$count = & gam print deviceusers queries "'model:Mac'" showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print deviceusers queries "'model:Mac'" showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
## API documentation
|
||||
* [Cloud Identity Groups Overview](https://cloud.google.com/identity/docs/groups)
|
||||
* [Create and Manage Groups uning API](https://support.google.com/a/answer/10427204)
|
||||
* [Create and Manage Groups using API](https://support.google.com/a/answer/10427204)
|
||||
* [Cloud Identity Groups API - Groups](https://cloud.google.com/identity/docs/reference/rest/v1/groups)
|
||||
* [Restrict Group Membership](https://support.google.com/a/answer/11192679)
|
||||
* [Lock Groups Beta](https://workspaceupdates.googleblog.com/2024/12/locked-groups-open-beta.html)
|
||||
@@ -26,15 +26,6 @@
|
||||
|
||||
## Notes
|
||||
|
||||
In version 7.02.01 options `locked` and `unlocked` wre added to `gam update cigroups` that allow locking groups.
|
||||
|
||||
* See: https://workspaceupdates.googleblog.com/2024/12/locked-groups-open-beta.html
|
||||
|
||||
You'll have to do a `gam oauth create` and enable the following scope to use these options:
|
||||
```
|
||||
[*] 22) Cloud Identity Groups API Beta (Enables group locking/unlocking)
|
||||
```
|
||||
|
||||
In the Admin Directory API a group has the following characteristics:
|
||||
* `id` - The unique ID of a group
|
||||
* `email` - The group's email address
|
||||
@@ -245,7 +236,7 @@ to set `<GroupAttribute>`.
|
||||
gam create cigroup <EmailAddress>
|
||||
[copyfrom <GroupItem>] <GroupAttribute>*
|
||||
[makeowner] [alias|aliases <CIGroupAliasList>]
|
||||
[security|makesecuritygroup]
|
||||
[security|makesecuritygroup] [locked]
|
||||
[dynamic <QueryDynamicGroup>]
|
||||
gam update cigroup <GroupEntity> [copyfrom <GroupItem>] <GroupAttribute>
|
||||
[security|makesecuritygroup|
|
||||
@@ -467,5 +458,7 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print cigroups showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print cidgroups showitemcountonly
|
||||
$count = & gam print cigroups showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print cigroups showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
- [Windows PowerShell](#windows-powershell)
|
||||
- [List quoting rules](#list-quoting-rules)
|
||||
- [Queries example](#queries-example)
|
||||
- [Capture command output](#capture-command-output)
|
||||
|
||||
## Linux and MacOS
|
||||
|
||||
@@ -79,3 +80,25 @@ gam print users queries "\"orgUnitPath='/Students/Lower School/2027'\",\"orgUnit
|
||||
```
|
||||
gam print users queries "`"orgUnitPath=\'/Students/Lower\ School/2027\'`",`"orgUnitPath=\'/Students/Lower\ School/2028\'`""
|
||||
```
|
||||
|
||||
## Capture command output
|
||||
|
||||
To retrieve an item count with `showitemcountonly`:
|
||||
```
|
||||
Linux/MacOS
|
||||
count=$(gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly)
|
||||
Windows PowerShell
|
||||
$count = & gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
To retrieve a File/Shared Drive ID with `returnidonly`:
|
||||
```
|
||||
Linux/MacOS
|
||||
itemId=$(gam user user@domain.com create shareddrive|drivefile ... returnidonly)
|
||||
Windows PowerShell
|
||||
$itemId = & gam user user@domain.com create shareddrive|drivefile ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com create shareddrive|drivefile ... returnidonly') do set itemId=%a
|
||||
```
|
||||
|
||||
@@ -13,10 +13,6 @@
|
||||
- [CAA Region Codes](#caa-region-codes)
|
||||
|
||||
## Notes
|
||||
This Wiki page was built directly from Jay Lee's Wiki page; my sincere thanks for his efforts.
|
||||
|
||||
GAM 6.20.00 and newer can create and manage access levels which can be assigned to Workspace services for your users.
|
||||
|
||||
To use these features you must update your project.
|
||||
```
|
||||
gam update project
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
- [Delete duplicate email addresses from contacts](#delete-duplicate-email-addresses-from-contacts)
|
||||
- [Manage domain contact photos](#manage-domain-contact-photos)
|
||||
- [Display domain shared contacts](#display-domain-shared-contacts)
|
||||
- [Display global address list](#Global-Address-List)
|
||||
- [Display global address list](Global-Address-List)
|
||||
|
||||
## API documentation
|
||||
* [Domain Shared Contacts API](https://developers.google.com/admin-sdk/domain-shared-contacts)
|
||||
|
||||
@@ -60,6 +60,15 @@ Display the number of domains.
|
||||
gam print|show domains
|
||||
showitemcountonly
|
||||
```
|
||||
To retrieve the count with `showitemcountonly`:
|
||||
```
|
||||
Linux/MacOS
|
||||
count=$(gam print domains showitemcountonly)
|
||||
Windows PowerShell
|
||||
$count = & gam print domains showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print domains showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Create and delete domain aliases
|
||||
```
|
||||
@@ -94,3 +103,12 @@ Display the number of domain aliases.
|
||||
gam print|show domainaliases|aliasdomains
|
||||
showitemcountonly
|
||||
```
|
||||
To retrieve the count with `showitemcountonly`:
|
||||
```
|
||||
Linux/MacOS
|
||||
count=$(gam print domainaliases showitemcountonly)
|
||||
Windows PowerShell
|
||||
$count = & gam print domainaliases showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print domainaliases showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
@@ -10,6 +10,73 @@ 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.28.00
|
||||
|
||||
Added option `addcsvdata <FieldName> <String>` to `gam report [usage] customers|users`
|
||||
that adds additional columns of data to the CSV file output. This will be most useful
|
||||
when reading a CSV of user information and you want to include some of the user information,
|
||||
e.g., orgUnitPath, in the output.
|
||||
```
|
||||
gam redirect csv ./Users.csv print users fields ou
|
||||
gam redirect csv ./UserStorageInfo.csv multiprocess csv Users.csv gam report users user "~primaryEmail" parameters accounts:drive_used_quota_in_mb,accounts:gmail_used_quota_in_mb,accounts:gplus_photos_used_quota_in_mb,accounts:total_quota_in_mb,accounts:used_quota_in_mb,accounts:used_quota_in_percentage addcsvdata orgUnitPath "~orgUnitPath"
|
||||
```
|
||||
|
||||
### 7.27.05
|
||||
|
||||
Added option `addcsvdata <FieldName> <String>` to `gam print courses`
|
||||
that adds additional columns of data to the CSV file output.
|
||||
|
||||
The following scope is no longer necessary: `Cloud Identity API - Groups Beta (Enables group locking/unlocking)`
|
||||
as this scope `Cloud Identity API - Groups` now provides group locking/unlocking.
|
||||
|
||||
### 7.27.04
|
||||
|
||||
Added options to `gam <UserTypeEntity> create delegate` that support
|
||||
sending email notifications when a user adds a delegate.
|
||||
|
||||
* See: https://github.com/GAM-team/GAM/wiki/Users-Gmail-Delegates#delegation-notification
|
||||
|
||||
### 7.27.03
|
||||
|
||||
Updated `gam <UserTypeEntity> create|update|sync chatmember` role specification to `role member|manager|owner`.
|
||||
This is the mapping between the Chat UI and Chat API; GAM uses the Chat UI role names.
|
||||
```
|
||||
UI: Member, API: ROLE_MEMBER
|
||||
UI: Manager, API: ROLE_ASSISTANT_MANAGER
|
||||
UI: Owner, API: ROLE_MANAGER
|
||||
```
|
||||
|
||||
Updated `gam <UserTypeEntity> update chatspace` options for permission settings.
|
||||
```
|
||||
[managemembersandgroups owners|managers|members]
|
||||
[modifyspacedetails owners|managers|members]
|
||||
[togglehistory owners|managers|members]
|
||||
[useatmentionall owners|managers|members]
|
||||
[manageapps owners|managers|members]
|
||||
[managewebhooks owners|managers|members]
|
||||
[replymessages owners|managers|members]
|
||||
```
|
||||
|
||||
### 7.27.02
|
||||
|
||||
Added option `clearattachments <String>` to `gam [<UserTypeMessage>] update chatmessage`
|
||||
that clears all attachments from a Chat message. If `<ChatContent>` is not specified,
|
||||
the current message text is retained and `<String>` is appended; `<String>` must be specified
|
||||
but can be empty in which case the current message test is preserved as-is.
|
||||
|
||||
### 7.27.01
|
||||
|
||||
Fixed bug in `gam <UserTypeEntity> claim ownership <DriveFileEntity> ... onlyUsers|skipusers <UserTypeEntity>`
|
||||
where the email addresses in `onlyUsers|skipusers <UserTypeEntity>` were not normalized.
|
||||
|
||||
### 7.27.00
|
||||
|
||||
Added `debug_redaction` Boolean variable to `gam.cfg`. When True, the default,
|
||||
sensitive data like access/refresh tokens, client secret and authorization codes
|
||||
are redacted from debug output. This allows you to post debug output without
|
||||
compromising your account information. Even with debug redaction,
|
||||
anything shared publicly should be double-checked for sensitive content.
|
||||
|
||||
### 7.25.01
|
||||
|
||||
Fixed bug in `gam config timezone <String>` to handle timezone abbreviations correctly;
|
||||
|
||||
@@ -49,7 +49,7 @@ For calendars, there is an option to indicate whether to release resources for f
|
||||
A `<TransferID>` is returned which can be used to monitor the progress of the transfer.
|
||||
|
||||
NOTE: For calendars, the behaviour is not sufficiently defined in the API documentation.
|
||||
As of 2020-06-10, background transfers only transfer future non-private events with at least one guest/resource.
|
||||
Background transfers only transfer future non-private events with at least one guest/resource.
|
||||
|
||||
The option `<ParameterKey> <ParameterValue>` is for future expansion.
|
||||
|
||||
|
||||
@@ -680,5 +680,7 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print groups showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print groups showitemcountonly
|
||||
```
|
||||
$count = & gam print groups showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print groups showitemcountonly') do set count=%a
|
||||
|
||||
|
||||
@@ -252,10 +252,10 @@ 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.25.01 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.28.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.0 64-bit final
|
||||
macOS Tahoe 26.0.1 x86_64
|
||||
macOS Tahoe 26.1 x86_64
|
||||
Path: /Users/admin/bin/gam7
|
||||
Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
|
||||
@@ -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.25.01 - https://github.com/GAM-team/GAM - pythonsource
|
||||
GAM 7.28.00 - https://github.com/GAM-team/GAM - pythonsource
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.0 64-bit final
|
||||
Windows-10-10.0.17134 AMD64
|
||||
|
||||
@@ -235,10 +235,6 @@ nv:<String>:<String>
|
||||
The first `<String>` is a Product and the second `<String>` is a SKU.
|
||||
|
||||
## Info User Performance
|
||||
|
||||
In GAM versions prior 7.18.05, when you did `gam info user`, GAM would make one attempt to get the user's licenses.
|
||||
If something went wrong, you might not get the complete list.
|
||||
|
||||
The License Manager API doesn't have a call that returns the list of licenses that a user has; you have to ask:
|
||||
```
|
||||
Does user have license SKU 1?
|
||||
|
||||
@@ -173,5 +173,7 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print mobile showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print mobile showitemcountonly
|
||||
$count = & gam print mobile showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print mobile showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
@@ -266,7 +266,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print orgs showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print orgs showitemcountonly
|
||||
$count = & gam print orgs showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print orgs showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Display indented organizational unit tree
|
||||
|
||||
@@ -12,6 +12,10 @@
|
||||
- [User reports](#user-reports)
|
||||
|
||||
## API documentation
|
||||
Changes starting 2025-10-29.
|
||||
|
||||
* [Reports API - Admin log event changes](https://support.google.com/a/answer/16601511)
|
||||
|
||||
These pages show event/parameter names; scroll down in the left column to: Reports.
|
||||
|
||||
* [Reports API - Activities](https://developers.google.com/admin-sdk/reports/v1/reference/activities)
|
||||
@@ -209,6 +213,7 @@ gam report usage customer [todrive <ToDriveAttribute>*]
|
||||
[skipdates <Date>[:<Date>](,<Date>[:<Date>])*] [skipdaysofweek <DayOfWeek>(,<DayOfWeek>)*]
|
||||
[fields|parameters <String>]
|
||||
[convertmbtogb]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
```
|
||||
Limit the time period.
|
||||
* `start <Date>` - Default value is 30 days prior to `end <Date>`
|
||||
@@ -220,8 +225,10 @@ Limit the time period.
|
||||
Option `convertmbtogb` causes GAM to convert parameters expressed in megabytes
|
||||
(name ends with _in_mb) to gigabytes (name converted to _in_gb) with two decimal places.
|
||||
|
||||
Add additional columns of data from the command line to the output.
|
||||
* `addcsvdata <FieldName> <String>`
|
||||
|
||||
### Example
|
||||
Jay provided this example.
|
||||
```
|
||||
gam report usage customer parameters meet:total_call_minutes,meet:total_meeting_minutes start_date 2020-03-01 skipdaysofweek sat,sun todrive
|
||||
```
|
||||
@@ -263,6 +270,7 @@ gam report customers|customer|domain [todrive <ToDriveAttribute>*]
|
||||
[(fields|parameters <String>)|(services <CustomerServiceNameList>)]
|
||||
[noauthorizedapps]
|
||||
[convertmbtogb]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
```
|
||||
Specify the report date; the default is today's date.
|
||||
* `date <Date>` - A single date; there is one API call
|
||||
@@ -275,6 +283,9 @@ Specify the report date; the default is today's date.
|
||||
Option `convertmbtogb` causes GAM to convert parameters expressed in megabytes
|
||||
(name ends with _in_mb) to gigabytes (name converted to _in_gb) with two decimal places.
|
||||
|
||||
Add additional columns of data from the command line to the output.
|
||||
* `addcsvdata <FieldName> <String>`
|
||||
|
||||
If no report is available for the specified date, can an earlier date be used?
|
||||
* `limitdatechanges -1' - Back up to earlier dates to find report data; this is the default.
|
||||
* `limitdatechanges 0 | nodatechange' - Do not report on an earlier date if no report data is available for the specified date.
|
||||
@@ -328,6 +339,7 @@ gam report usage user [todrive]
|
||||
[skipdates <Date>[:<Date>](,<Date>[:<Date>])*] [skipdaysofweek <DayOfWeek>(,<DayOfWeek>)*]
|
||||
[fields|parameters <String>]
|
||||
[convertmbtogb]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
```
|
||||
Select the users for whom information is desired.
|
||||
* `user all` - All users, the default; there is one API call
|
||||
@@ -346,6 +358,9 @@ Limit the time period.
|
||||
Option `convertmbtogb` causes GAM to convert parameters expressed in megabytes
|
||||
(name ends with _in_mb) to gigabytes (name converted to _in_gb) with two decimal places.
|
||||
|
||||
Add additional columns of data from the command line to the output.
|
||||
* `addcsvdata <FieldName> <String>`
|
||||
|
||||
## User reports
|
||||
User reports are generally available up to four days before the current date.
|
||||
```
|
||||
@@ -370,6 +385,7 @@ gam report users|user [todrive <ToDriveAttribute>*]
|
||||
[aggregatebydate|aggregatebyuser [Boolean]]
|
||||
[maxresults <Number>]
|
||||
[convertmbtogb]
|
||||
(addcsvdata <FieldName> <String>)*
|
||||
```
|
||||
Select the users for whom information is desired.
|
||||
* `user all` - All users, the default; there is one API call
|
||||
@@ -392,6 +408,16 @@ Specify the report date; the default is today's date.
|
||||
Option `convertmbtogb` causes GAM to convert parameters expressed in megabytes
|
||||
(name ends with _in_mb) to gigabytes (name converted to _in_gb) with two decimal places.
|
||||
|
||||
Add additional columns of data from the command line to the output.
|
||||
* `addcsvdata <FieldName> <String>`
|
||||
|
||||
This will be most useful when reading a CSV of user information and you want to include some of the user information,
|
||||
e.g., orgUnitPath, in the output.
|
||||
```
|
||||
gam redirect csv ./Users.csv print users fields ou
|
||||
gam redirect csv ./UserStorageInfo.csv multiprocess csv Users.csv gam report users user "~primaryEmail" parameters accounts:drive_used_quota_in_mb,accounts:gmail_used_quota_in_mb,accounts:gplus_photos_used_quota_in_mb,accounts:total_quota_in_mb,accounts:used_quota_in_mb,accounts:used_quota_in_percentage addcsvdata orgUnitPath "~orgUnitPath"
|
||||
```
|
||||
|
||||
If no report is available for the specified date, can an earlier date be used?
|
||||
* `limitdatechanges -1' - Back up to earlier dates to find report data; this is the default.
|
||||
* `limitdatechanges 0 | nodatechange' - Do not report on an earlier date if no report data is available for the specified date.
|
||||
@@ -448,6 +474,11 @@ Report on users total storage usage.
|
||||
```
|
||||
gam report users parameters accounts:drive_used_quota_in_mb,accounts:gmail_used_quota_in_mb,accounts:gplus_photos_used_quota_in_mb,accounts:total_quota_in_mb,accounts:used_quota_in_mb,accounts:used_quota_in_percentage
|
||||
```
|
||||
Report on users total storage usage, include OrgUnitPath
|
||||
```
|
||||
gam redirect csv ./Users.csv print users fields ou
|
||||
gam redirect csv ./UserStorageInfo.csv multiprocess csv Users.csv gam report users user "~primaryEmail" parameters accounts:drive_used_quota_in_mb,accounts:gmail_used_quota_in_mb,accounts:gplus_photos_used_quota_in_mb,accounts:total_quota_in_mb,accounts:used_quota_in_mb,accounts:used_quota_in_percentage addcsvdata orgUnitPath "~orgUnitPath"
|
||||
```
|
||||
Report on email activity for individual users.
|
||||
```
|
||||
$ gam report users select users testuser1,testuser2,testuser3 fields gmail:num_emails_received,gmail:num_emails_sent range 2025-07-01 2025-07-07
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
# Reseller
|
||||
- [API documentation](#api-documentation)
|
||||
- [Notes](#notes)
|
||||
- [Manage Multiple Domains](#manage-multiple-domains)
|
||||
- [Definitions](#definitions)
|
||||
- [Manage Resold Customers](#manage-resold-customers)
|
||||
@@ -12,20 +11,6 @@
|
||||
* [Reseller API - Customers](https://developers.google.com/admin-sdk/reseller/v1/reference/customers)
|
||||
* [Reseller API - Subscriptions](https://developers.google.com/admin-sdk/reseller/v1/reference/subscriptions)
|
||||
|
||||
## Notes
|
||||
|
||||
Updated handling of `seats` option in `gam create|update resoldsubscription` to properly assign
|
||||
the API fields `numberOfSeats` and `maximumNumberOfSeats`.
|
||||
Prior to version 6.50.00, this is how the `seats <NumberOfSeats> <MaximumNumberOfSeats>` option was processed:
|
||||
* Plan name `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY`
|
||||
* `seats <NumberOfSeats>` - `<NumberOfSeats>` was properly passed to the API
|
||||
* `seats <NumberOfSeats> <MaximumNumberOfSeats>` - `<NumberOfSeats>` was properly passed to the API; `<MaximumNumberOfSeats>` was passed to the API which ignored it
|
||||
* Plan name `FLEXIBLE` or `TRIAL`
|
||||
* `seats <NumberOfSeats>` - `<NumberOfSeats>` was improperly passed to the API; an API error was generated
|
||||
* `seats <NumberOfSeats> <MaximumNumberOfSeats>` - `<MaximumNumberOfSeats>` was properly passed to the API; `<NumberOfSeats>` was passed to the API which ignored it
|
||||
|
||||
Now, you can still use the above option which has been corrected or you can specify `seats <Number>` which will be properly passed in the correct form to the API based on plan name.
|
||||
|
||||
## Manage Multiple Domains
|
||||
Thanks to Duncan Isaksen-Loxton for a script to help manage multiple domains.
|
||||
|
||||
|
||||
@@ -512,7 +512,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print resources showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print resources showitemcountonly
|
||||
$count = & gam print resources showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print resources showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Manage resource calendar ACLs
|
||||
|
||||
@@ -315,6 +315,8 @@ Linux/MacOS
|
||||
teamDriveId=$(gam create shareddrive ... returnidonly)
|
||||
Windows PowerShell
|
||||
$teamDriveId = & gam create shareddrive ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam create shareddrive ... returnidonly') do set teamDriveId=%a
|
||||
```
|
||||
|
||||
## Bulk Create Shared Drives
|
||||
@@ -537,7 +539,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print shareddrives showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print shareddrives showitemcountonly
|
||||
$count = & gam print shareddrives showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print shareddrives showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Display all Shared Drives with a specific organizer
|
||||
@@ -590,7 +594,9 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print oushareddrives showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print oushareddrives showitemcountonly
|
||||
$count = & gam print oushareddrives showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print oushareddrives showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Manage Shared Drive access
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- [Chat Space Permissions](#chat-space-permissions)
|
||||
- [Manage Chat Spaces](#manage-chat-spaces)
|
||||
- [Display Chat Spaces](#display-chat-spaces)
|
||||
- [UI API member role mapping](#ui-api-mwmber-role-mapping)
|
||||
- [Manage Chat Members](#manage-chat-members)
|
||||
- [Display Chat Members](#display-chat-members)
|
||||
- [Manage Chat Messages](#manage-chat-messages)
|
||||
@@ -211,7 +212,7 @@ For `type space`, the following apply:
|
||||
* `description <String>` - Optional
|
||||
* `guidelines <String>` - Optional
|
||||
* `history <Boolean>` - Optional
|
||||
* `announcement|collaboration` - Initial permission settings; default is `collaboration`; this is in Developer Preview
|
||||
* `announcement|collaboration` - Initial permission settings; default is `collaboration`
|
||||
|
||||
For `type groupchat`, the following apply:
|
||||
* `members <UserTypeEntity>` - Required, must specify between 2 and 20 users
|
||||
@@ -244,30 +245,19 @@ gam <UserTypeEntity> update chatspace <ChatSpace>
|
||||
[type space]
|
||||
[description <String>] [guidelines|rules <String>]
|
||||
[history <Boolean>])
|
||||
[managemembersandgroups managers|members]
|
||||
[modifyspacedetails managers|members]
|
||||
[togglehistory managers|members]
|
||||
[useatmentionall managers|members]
|
||||
[manageapps managers|members]
|
||||
[managewebhooks managers|members]
|
||||
[replymessages managers|members]
|
||||
[managemembersandgroups owners|managers|members]
|
||||
[modifyspacedetails owners|managers|members]
|
||||
[togglehistory owners|managers|members]
|
||||
[useatmentionall owners|managers|members]
|
||||
[manageapps owners|managers|members]
|
||||
[managewebhooks owners|managers|members]
|
||||
[replymessages owners|managers|members]
|
||||
[formatjson]
|
||||
```
|
||||
A groupchat space can be upgraded to a space by specifying `type space` and `displayname <String>`.
|
||||
|
||||
The `restricted|audience` options can not be combined with options `displayname,type,description,guidelines,history`.
|
||||
|
||||
You can manage permissions for chat spaces with the following options that are available with Developer Preview.
|
||||
[managemembersandgroups managers|members]
|
||||
[modifyspacedetails managers|members]
|
||||
[togglehistory managers|members]
|
||||
[useatmentionall managers|members]
|
||||
[manageapps managers|members]
|
||||
[managewebhooks managers|members]
|
||||
[postmessages managers|members]
|
||||
[replymessages managers|members]
|
||||
|
||||
|
||||
By default, Gam displays the information about the created chatspace as an indented list of keys and values.
|
||||
* `formatjson` - Display the fields in JSON format.
|
||||
|
||||
@@ -432,11 +422,20 @@ When using the `formatjson` option, double quotes are used extensively in the da
|
||||
The `quotechar <Character>` option allows you to choose an alternate quote character, single quote for instance, that makes for readable/processable output.
|
||||
`quotechar` defaults to `gam.cfg/csv_output_quote_char`. When uploading CSV files to Google, double quote `"` should be used.
|
||||
|
||||
## UI API member role mapping
|
||||
GAM uses the Chat UI role names.
|
||||
|
||||
| UI setting | API setting |
|
||||
|------------|------------|
|
||||
| Member | ROLE_MEMBER |
|
||||
| Manager | ROLE_ASSISTANT_MANAGER |
|
||||
| Owner | ROLE_MANAGER |
|
||||
|
||||
## Manage Chat Members
|
||||
### Add members to a user's chat space
|
||||
```
|
||||
gam <UserTypeEntity> create chatmember <ChatSpace>
|
||||
[type human|bot] [role member|manager]
|
||||
[type human|bot] [role member|manager|owner]
|
||||
(user <UserItem>)* (members <UserTypeEntity>)*
|
||||
(group <GroupItem>)* (groups <GroupEntity>)*
|
||||
[formatjson|returnidonly]
|
||||
@@ -462,7 +461,7 @@ gam <UserTypeEntity> remove chatmember members <ChatMemberList>
|
||||
Creating memberships for users outside the administrator's Google Workspace organization isn't supported using asadmin.
|
||||
```
|
||||
gam <UserItem> create chatmember asadmin <ChatSpace>
|
||||
[type human|bot] [role member|manager]
|
||||
[type human|bot] [role member|manager|owner]
|
||||
(user <UserItem>)* (members <UserTypeEntity>)*
|
||||
(group <GroupItem>)* (groups <GroupEntity>)*
|
||||
[formatjson|returnidonly]
|
||||
@@ -488,13 +487,13 @@ gam <UserItem> remove chatmember asadmin members <ChatMemberList>
|
||||
Update members by specifying a chat space, user/group email addresses and role.
|
||||
```
|
||||
gam <UserTypeEntity> update chatmember <ChatSpace>
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
((user <UserItem>)|(members <UserTypeEntity>))+
|
||||
```
|
||||
Update members by specifying chatmember names and role.
|
||||
```
|
||||
gam <UserTypeEntity> modify chatmember
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
members <ChatMemberList>
|
||||
```
|
||||
|
||||
@@ -502,13 +501,13 @@ gam <UserTypeEntity> modify chatmember
|
||||
Update members by specifying a chat space, user/group email addresses and role.
|
||||
```
|
||||
gam <UserItem> update chatmember asadmin <ChatSpace>
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
((user <UserItem>)|(members <UserTypeEntity>))+
|
||||
```
|
||||
Update members by specifying chatmember names and role.
|
||||
```
|
||||
gam <UserItem> modify chatmember asadmin
|
||||
role member|manager
|
||||
role member|manager|owner
|
||||
members <ChatMemberList>
|
||||
```
|
||||
|
||||
@@ -751,7 +750,7 @@ gam user user@domain.com create chatmessage spaces spaces/AAAADi-pvqc gdoc annou
|
||||
Updates and rewrites an existing Chat message. Message will show as edited and no notification will be sent to members.
|
||||
```
|
||||
gam <UserTypeEntity> update chatmessage name <ChatMessage>
|
||||
<ChatContent>
|
||||
[<ChatContent>] [clearattachments <String>]
|
||||
```
|
||||
Specify the text of the message: `<ChatContent>`
|
||||
* `text <String>` - The message is `<String>`
|
||||
@@ -759,12 +758,22 @@ Specify the text of the message: `<ChatContent>`
|
||||
* `gdoc <UserGoogleDoc>` - The message is read from a Google Doc.
|
||||
* `gcsdoc <StorageBucketObjectName>` - The message is read from a Google Cloud Storage file.
|
||||
|
||||
The option `clearattachments <String>` can be used to clear all attachments from a Chat message.
|
||||
If `<ChatContent>` is not specified, the current message text is retained and `<String>` is appended;
|
||||
`<String>` must be specified but can be empty in which case the current message test is preserved as-is.
|
||||
|
||||
### Example
|
||||
This example updates an existing chat message with new text.
|
||||
```
|
||||
gam user user@domain.com update chatmessage name spaces/AAAADi-pvqc/messages/PKJrx90ooIU.PKJrx90ooIU text "HELLO CHAT?"
|
||||
```
|
||||
|
||||
This example clears attachments from a chat message and appends ` - Attachments cleared`
|
||||
to the current message text.
|
||||
```
|
||||
gam user user@domain.com update chatmessage name spaces/AAAADi-pvqc/messages/PKJrx90ooIU.PKJrx90ooIU clearattachments " - Attachments cleared"
|
||||
```
|
||||
|
||||
### Delete a Chat Message
|
||||
Deletes the given Chat message. Members will no longer see the message.
|
||||
|
||||
|
||||
@@ -17,18 +17,9 @@
|
||||
- [Display user contact groups](#display-user-contact-groups)
|
||||
|
||||
## Notes
|
||||
As of version `6.08.00`, GAM uses the People API to manage user contacts rather than the Contacts API.
|
||||
GAM uses the People API to manage user contacts rather than the Contacts API.
|
||||
|
||||
Most commands will work unchanged but Google has completely changed how the data is presented. If you
|
||||
have scripts that process the output from `print contacts` for example, they will have to be changed.
|
||||
|
||||
You might want to keep an older version of GAM available so you can compare the output from the two
|
||||
versions and make adjustments as necessary.
|
||||
|
||||
If you manage contacts in the contact group "Other Contacts", you will need to use an older version,
|
||||
as the People API has very little support for this.
|
||||
|
||||
As of version `6.14.04`, There is now support for managing "Other Contacts".
|
||||
The People API has very little support for managing contacts in the contact group "Other Contacts".
|
||||
|
||||
[Users - People - Contacts & Profiles](Users-People-Contacts-Profiles)
|
||||
|
||||
|
||||
@@ -94,19 +94,10 @@ Show current drive usage.
|
||||
gam redirect stdout ./DrivefileUsage.txt user user@domain.com show drivesettings
|
||||
```
|
||||
Get list of top level files/folders.
|
||||
|
||||
GAM version `6.22.14` and higher:
|
||||
```
|
||||
gam redirect csv ./TopLevelFilesFolders.csv user user@domain.com print filelist select rootid fields id,name,mimetype depth 0
|
||||
```
|
||||
GAM version `6.22.13` and lower.
|
||||
```
|
||||
gam user user@domain.com show fileinfo root fields id
|
||||
User: user@domain.com, Show 1 Drive File/Folder
|
||||
Drive Folder: My Drive (0AENlVEBUkz-hUkWXYZ)
|
||||
id: 0AENlVEBUkz-hUkWXYZ
|
||||
gam redirect csv ./TopLevelFilesFolders.csv user user@domain.com print filelist select 0AENlVEBUkz-hUkWXYZ fields id,name,mimetype depth 0
|
||||
```
|
||||
|
||||
Purge top level files/folders.
|
||||
```
|
||||
gam redirect stdout ./PurgeTopLevelFilesFolders.txt multiprocess redirect stderr stdout csv ./TopLevelFilesFolders.csv gam user "~Owner" purge drivefile "~id"
|
||||
@@ -128,7 +119,6 @@ Show updated drive usage.
|
||||
gam redirect stdout ./DrivefileUsage.txt append user user@domain.com show drivesettings
|
||||
```
|
||||
### Method 3
|
||||
* GAM version `6.30.09` and higher
|
||||
* Generate a list of top level files/folders that a user owns.
|
||||
* Delete them; orphans are not included
|
||||
* Generate a list of remaining file/folders (orphans).
|
||||
|
||||
@@ -226,8 +226,6 @@ When a file appears more that once in the copy, the first time the file is proce
|
||||
If it is processed again (because of multiple parents within the source folder structure), a shortcut is created that points to the first copy.
|
||||
|
||||
### Shortcuts
|
||||
In previous versions, copying shortcuts caused an error because shortcuts can't be copied, they must be re-created.
|
||||
|
||||
If a shortcut in the source structure points to a file/folder that is not in the source structure:
|
||||
* The shortcut is re-created to point to the original file/folder.
|
||||
|
||||
@@ -263,7 +261,6 @@ When a folder is copied, its permissions are not copied; these options control c
|
||||
of the form `option [<Boolean>]`; if `<Boolean>` is omitted, `true` is assumed.
|
||||
|
||||
When copied, a target folder inherits the permissions of its parent folder; these options control whether/how GAM copies the existing source folder permissions.
|
||||
The default values of options introduced in version 6.14.00 are set to match the behavior of earlier versions.
|
||||
|
||||
When `mergewithparent` is `true`:
|
||||
* `copymergewithparentfolderpermissions false` - The permissions of the source top folder are not not copied to the target folder; this is the default action.
|
||||
@@ -352,6 +349,8 @@ Linux/MacOS
|
||||
fileId=$(gam user user@domain.com copy drivefile <DriveFileEntity> ... returnidonly)
|
||||
Windows PowerShell
|
||||
$fileId = & gam user user@domain.com copy drivefile <DriveFileEntity> ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com copy drivefile <DriveFileEntity> ... returnidonly') do set fileId=%a
|
||||
```
|
||||
The file ID will only be valid when the return code of the command is 0; program accordingly.
|
||||
|
||||
@@ -388,7 +387,7 @@ gam user user@domain.com copy drivefile root recursive teamdriveparentid <Shared
|
||||
```
|
||||
|
||||
### Copy content of a Shared Drive to another Shared Drive
|
||||
Suppose you have a source Shared Drive called 0AC_1AB with multiple files and folders, and want to copy all of its content to the target Shared Drive 0AE_9ZX.
|
||||
Suppose you have a source Shared Drive with ID 0AC_1AB with multiple files and folders, and want to copy all of its content to the target Shared Drive with ID 0AE_9ZX.
|
||||
|
||||
The following command will copy the content, files and folders inside the source drive recursively, and put them in the target drive.
|
||||
|
||||
@@ -431,6 +430,52 @@ gam user user@domain.com copy drivefile teamdriveid 0AC_1AB teamdriveparentid 0A
|
||||
copyfilenoninheritedpermissions true
|
||||
```
|
||||
|
||||
### Copy content of a source Shared Drive to a target Shared Drive with parallel Processing
|
||||
Suppose you have a source Shared Drive with ID 0AC_1AB with multiple files and folders, and want to copy all of its content to the target Shared Drive with ID 0AE_9ZX.
|
||||
|
||||
Get top level items on source Shared Drive
|
||||
```
|
||||
gam redirect csv ./TopSDItems.csv user user@domain.com print filelist select 0AC_1AB fields id,name,mimetype depth 0
|
||||
```
|
||||
Copy the top level items to target Shared Drive; append desired permission options
|
||||
```
|
||||
gam redirect stdout ./CopySharedDrive.txt multiprocess redirect stderr stdout csv TopSDItems.csv gam user user@domain.com copy drivefile "~id" recursive teamdriveparentid 0AE_9ZX
|
||||
```
|
||||
|
||||
### Copy content of a source Shared Drive folder to a target Shared Drive with parallel Processing
|
||||
Get top level items on source Shared Drive folder with ID 1BX-8W3
|
||||
```
|
||||
gam redirect csv ./TopSDItems.csv user user@domain.com print filelist select 1Bx-8W3 fields id,name,mimetype depth 0
|
||||
```
|
||||
Create a folder on target Shared Drive with ID 0AE_9ZX, replace "New Folder Name" as desired.
|
||||
```
|
||||
gam user user@domain.com create drivefile mimetype gfolder teamdriveparentid 0AE-9ZX drivefilename "New Folder Name" returnidonly
|
||||
```
|
||||
Copy the folder top level items to target Shared Drive folder, assume ID 2CY-45G was returned in previous step
|
||||
```
|
||||
gam redirect stdout ./CopySharedDrive.txt multiprocess redirect stderr stdout csv TopSDItems.csv gam user user@domain.com copy drivefile "~id" recursive teamdriveparentid 2CY-45G
|
||||
```
|
||||
You can script the steps:
|
||||
|
||||
Linux/MacOS
|
||||
```
|
||||
gam redirect csv ./TopSDItems.csv user user@domain.com print filelist select 1Bx-8W3 fields id,name,mimetype depth 0
|
||||
targetFolderId=$(gam user user@domain.com create drivefile mimetype gfolder teamdriveparentid 0AE-9ZX drivefilename "New Folder Name" returnidonly)
|
||||
gam redirect stdout ./CopySharedDrive.txt multiprocess redirect stderr stdout csv TopSDItems.csv gam user user@domain.com copy drivefile "~id" recursive teamdriveparentid $targetFolderId
|
||||
```
|
||||
Windows PowerShell
|
||||
```
|
||||
gam redirect csv ./TopSDItems.csv user user@domain.com print filelist select 1Bx-8W3 fields id,name,mimetype depth 0
|
||||
$targetFolderId = & gam user user@domain.com create drivefile mimetype gfolder teamdriveparentid 0AE-9ZX drivefilename "New Folder Name" returnidonly
|
||||
gam redirect stdout ./CopySharedDrive.txt multiprocess redirect stderr stdout csv TopSDItems.csv gam user user@domain.com copy drivefile "~id" recursive teamdriveparentid $targetFolderId
|
||||
```
|
||||
Windows Command Prompt
|
||||
```
|
||||
gam redirect csv ./TopSDItems.csv user user@domain.com print filelist select 1Bx-8W3 fields id,name,mimetype depth 0
|
||||
for /f "delims=" %a in ('gam user user@domain.com create drivefile mimetype gfolder teamdriveparentid 0AE-9ZX drivefilename "New Folder Name" returnidonly') do set taregtFolderId=%a
|
||||
gam redirect stdout ./CopySharedDrive.txt multiprocess redirect stderr stdout csv TopSDItems.csv gam user user@domain.com copy drivefile "~id" recursive teamdriveparentid %targetFolderId%
|
||||
```
|
||||
|
||||
## Move files and folders
|
||||
## Move My Drive folder to Shared Drive
|
||||
There are two methods for moving a folder from a My Drive to a Shared Drive:
|
||||
|
||||
@@ -494,9 +494,8 @@ an API call per file is required to get the information.
|
||||
labelsIds: <ClassificationLabelID> <ClassificationLabelID> ...
|
||||
```
|
||||
|
||||
Starting in version 6.27.02, you can get Drive label information without an extra API call
|
||||
if you know the `<ClassificationLabelID>`s. Add `labelinfo` to your `fields` list and use `includelabels <ClassificationLabelIDList>`
|
||||
to specify the Drive labels.
|
||||
You can get Drive label information without an extra API call if you know the `<ClassificationLabelID>`s.
|
||||
Add `labelinfo` to your `fields` list and use `includelabels <ClassificationLabelIDList>` to specify the Drive labels.
|
||||
```
|
||||
gam user user@domain.com show fileinfo <DriveFileEntity> fields id,name,mimetype,labelinfo includelabels "mRoha85IbwCRl490E00xGLvBsSbkwIiuZ6PRNNEbbFcb"
|
||||
```
|
||||
@@ -504,7 +503,7 @@ gam user user@domain.com show fileinfo <DriveFileEntity> fields id,name,mimetype
|
||||
The `stripcrsfromname` option strips nulls, carriage returns and linefeeds from drive file names.
|
||||
Use this option if you discover filenames containing these special characters; it is not common.
|
||||
|
||||
Starting in version 6.80.10, the option `followshortcuts [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
The option `followshortcuts [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
causes GAM to display information about the target of the shortcut rather than the shortcut itself.
|
||||
|
||||
By default, Gam displays the information as an indented list of keys and values.
|
||||
@@ -540,7 +539,7 @@ Use this option if you discover filenames containing these special characters; i
|
||||
By default, when printing file paths, all paths for a file are displayed on the same row; use `oneitemperrow` to
|
||||
have each file path displayed on a separate row.
|
||||
|
||||
Starting in version 6.80.10, the option `followshortcuts [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
The option `followshortcuts [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
causes GAM to display path information for the target of the shortcut rather than the shortcut itself.
|
||||
|
||||
## Select files for Display file counts, list, tree
|
||||
@@ -1197,7 +1196,7 @@ These options can be used instead of the query options to select a specific fold
|
||||
* `select <DriveFileEntity>` - All files in the selected folder and below are shown.
|
||||
* To select the root folder of My Drive, use its `<DriveFolderID>` obtained by `gam user <UserItem> show fileinfo root id`
|
||||
* `select <IDfrom Above>`
|
||||
* Starting in version 6.22.14, you can select the root folder of My Drive with `rootid`.
|
||||
* You can select the root folder of My Drive with `rootid`.
|
||||
* `select rootid`
|
||||
* `selectsubquery <QueryDriveFile>` - Only the files in the selected folder that match the query are shown.
|
||||
|
||||
@@ -1669,7 +1668,7 @@ There is a final row detailing files and folders in the trash; it is omitted if
|
||||
* `depth` - Always -1
|
||||
* `path` - Trash
|
||||
|
||||
GAM version `6.71.17` added the `depth` column that can be used to filter the depth of the folders displayed.
|
||||
The `depth` column that can be used to filter the depth of the folders displayed.
|
||||
Depth `-1` is the top level folder, depth `0` are its immediate children, depth `2` are the children of depth `1` and so forth.
|
||||
For example to limit the display to the top folder and its immediate children, use `config csv_output_row_filter depth:count<1`.
|
||||
|
||||
@@ -1738,8 +1737,6 @@ user@domain.com,Trash,Trash,True,True,1,1024,0,1,1024,0,-1,Trash
|
||||
```
|
||||
|
||||
## Display files published to the web
|
||||
Ths requires version 6.80.13 or later.
|
||||
|
||||
You can display files published to the web.
|
||||
```
|
||||
# Get the published files
|
||||
|
||||
@@ -225,10 +225,7 @@ If `noduplicate` is specfied, GAM will issue a warning and not perform the creat
|
||||
exists in the parent folder.
|
||||
|
||||
By default, when files are uploaded from local content, they are created with `binary` format, i.e., the data is uploaded
|
||||
without any conversion. Legacy GAM had an option `convert` that was passed to the Drive API v2 that it used.
|
||||
* convert - Whether to convert this file to the corresponding Docs Editors format
|
||||
|
||||
Advanced GAM uses Drive API v3 that doesn't support the `convert` option; it uses the `mimetype` argument to cause conversions.
|
||||
without any conversion; use the `mimetype` argument to cause conversions.
|
||||
* `mimetype gdoc` - Convert the uploaded content to a Google Doc; e.g., convert a Word (.docx) or text (.txt) file to a Google Doc
|
||||
* `mimetype gsheet` - Convert the uploaded content to a Google Sheet; e.g., convert an Excel (.xlsx) or CSV (.csv) file to a Google Sheet
|
||||
* `mimetype gpresentation` - Convert the uploaded content to a Google Slides; e.g., convert a PowerPoint (.pptx) file to a Google Slides
|
||||
@@ -249,6 +246,8 @@ Linux/MacOS
|
||||
fileId=$(gam user user@domain.com create drivefile ... returnidonly)
|
||||
Windows PowerShell
|
||||
$fileId = & gam user user@domain.com create drivefile ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com create drivefile ... returnidonly') do set fileId=%a
|
||||
```
|
||||
The file ID will only be valid when the return code of the command is 0; program accordingly.
|
||||
|
||||
@@ -555,6 +554,8 @@ Linux/MacOS
|
||||
fileId=$(gam user user@domain.com update drivefile <DriveFileEntity> copy ... returnidonly)
|
||||
Windows PowerShell
|
||||
$fileId = & gam user user@domain.com update drivefile <DriveFileEntity> copy ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com update drivefile <DriveFileEntity> copy ... returnidonly') do set fileId=%a
|
||||
```
|
||||
The file ID will only be valid when the return code of the command is 0; program accordingly.
|
||||
|
||||
@@ -662,7 +663,7 @@ gam <UserTypeEntity> trash drivefile <DriveFileEntity> [shortcutandtarget [<Bool
|
||||
gam <UserTypeEntity> delete|del drivefile <DriveFileEntity> trash [shortcutandtarget [<Boolean>]]
|
||||
```
|
||||
|
||||
Starting in version 6.80.10, the option `shortcutandtarget [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
The option `shortcutandtarget [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
causes GAM to process the shortcut and the target of the shortcut.
|
||||
|
||||
## Untrash files
|
||||
@@ -672,7 +673,7 @@ gam <UserTypeEntity> untrash drivefile <DriveFileEntity> [shortcutandtarget [<Bo
|
||||
gam <UserTypeEntity> delete|del drivefile <DriveFileEntity> untrash [shortcutandtarget [<Boolean>]]
|
||||
```
|
||||
|
||||
Starting in version 6.80.10, the option `shortcutandtarget [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
The option `shortcutandtarget [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
causes GAM to process the shortcut and the target of the shortcut.
|
||||
|
||||
## Purge files
|
||||
@@ -682,7 +683,7 @@ gam <UserTypeEntity> purge drivefile <DriveFileEntity> [shortcutandtarget [<Bool
|
||||
gam <UserTypeEntity> delete|del drivefile <DriveFileEntity> purge [shortcutandtarget [<Boolean>]]
|
||||
```
|
||||
|
||||
Starting in version 6.80.10, the option `shortcutandtarget [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
The option `shortcutandtarget [<Boolean>]` that when true and `<DriveFileEntity` is a shortcut,
|
||||
causes GAM to process the shortcut and the target of the shortcut.
|
||||
|
||||
## Download Google Documents as JSON
|
||||
|
||||
@@ -117,25 +117,28 @@ specify `basicpermissions` and additional permission fields, e.g., `permissions.
|
||||
<DriveFileACLRoleList> ::= "<DriveFileACLRole>(,<DriveFileACLRole>)*"
|
||||
<DriveFileACLType> ::= anyone|domain|group|user
|
||||
<DriveFileACLTypeList> ::= "<DriveFileACLType>(,<DriveFileACLType>)*"
|
||||
<DriveFilePermission> ::=
|
||||
anyone|anyonewithlink|
|
||||
user:<EmailAddress>|group:<EmailAddress>|
|
||||
domain:<DomainName>|domainwithlink:<DomainName>;<DriveFileACLRole>
|
||||
<DriveFilePermissionID> ::=
|
||||
anyone|anyonewithlink|id:<String>
|
||||
<DriveFilePermissionIDorEmail> ::=
|
||||
<DriveFilePermissionID>|<EmailAddress>
|
||||
<DriveFilePermissionList> ::=
|
||||
"<DriveFilePermission>(,<DriveFilePermission)*"
|
||||
<DriveFilePermissionIDList> ::=
|
||||
"<DriveFilePermissionID>(,<DriveFilePermissionID>)*"
|
||||
<DriveFilePermissionEntity> ::=
|
||||
<DriveFilePermissionList> |
|
||||
<DriveFilePermissionIDEntity> ::=
|
||||
<DriveFilePermissionIDList> |
|
||||
(json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) |
|
||||
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||
See: https://github.com/GAM-team/GAM/wiki/Collections-of-Items
|
||||
<DriveFilePermissionIDEntity> ::=
|
||||
<DriveFilePermissionIDList> |
|
||||
<DriveFilePermission> ::=
|
||||
anyone;<DriveFileACLRole> |
|
||||
anyonewithlink;<DriveFileACLRole> |
|
||||
domain:<DomainName>;<DriveFileACLRole> |
|
||||
domainwithlink:<DomainName>;<DriveFileACLRole> |
|
||||
group:<EmailAddress>;<DriveFileACLRole> |
|
||||
user:<EmailAddress>;<DriveFileACLRole>
|
||||
<DriveFilePermissionList> ::=
|
||||
"<DriveFilePermission>(,<DriveFilePermission)*"
|
||||
<DriveFilePermissionEntity> ::=
|
||||
<DriveFilePermissionList> |
|
||||
(json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) |
|
||||
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||
See: https://github.com/GAM-team/GAM/wiki/Collections-of-Items
|
||||
|
||||
@@ -72,6 +72,8 @@ Linux/MacOS
|
||||
fileId=$(gam user user@domain.com create drivefileshortcut ... returnidonly)
|
||||
Windows PowerShell
|
||||
$fileId = & gam user user@domain.com create drivefileshortcut ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com create drivefileshortcut ... returnidonly') do set fileId=%a
|
||||
```
|
||||
The shortcut ID will only be valid when the return code of the command is 0; program accordingly.
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
- [API documentation](#api-documentation)
|
||||
- [Definitions](#definitions)
|
||||
- [Aliases](#aliases)
|
||||
- [Delegation Notification](#delegation-notification)
|
||||
- [Create Gmail delegates](#create-gmail-delegates)
|
||||
- [Delete Gmail delegates](#delete-gmail-delegates)
|
||||
- [Update Gmail delegates](#update-gmail-delegates)
|
||||
@@ -31,6 +32,23 @@ mail delegation is enabled. In the admin console, go to Apps/Google Workspace/Gm
|
||||
<UserEntity> ::=
|
||||
<UserList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||
See: https://github.com/GAM-team/GAM/wiki/Collections-of-Users
|
||||
|
||||
<StorageBucketName> ::= <String>
|
||||
<StorageObjectName> ::= <String>
|
||||
<StorageBucketObjectName> ::=
|
||||
https://storage.cloud.google.com/<StorageBucketName>/<StorageObjectName>|
|
||||
https://storage.googleapis.com/<StorageBucketName>/<StorageObjectName>|
|
||||
gs://<StorageBucketName>/<StorageObjectName>|
|
||||
<StorageBucketName>/<StorageObjectName>
|
||||
|
||||
<UserGoogleDoc> ::=
|
||||
<EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>|(<SharedDriveEntity> <SharedDriveFileNameEntity>)
|
||||
|
||||
<NotifyMessageContent> ::=
|
||||
(message|textmessage|htmlmessage <String>)|
|
||||
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
||||
(gdoc|ghtml <UserGoogleDoc>)|
|
||||
(gcsdoc|gcshtml <StorageBucketObjectName>)
|
||||
```
|
||||
## Aliases
|
||||
|
||||
@@ -39,11 +57,61 @@ The `convertalias` option causes GAM to make an extra API call per user in `<Use
|
||||
to convert aliases to primary email addresses. If you know that all of the email addresses
|
||||
in `<UserEntity>` are primary, you can omit `convertalias` and avoid the extra API calls.
|
||||
|
||||
## Delegation Notification
|
||||
When creating a delegate, you can send a message to the delegate.
|
||||
```
|
||||
[notify [<Boolean>]
|
||||
[subject <String>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAddress>]
|
||||
[<NotifyMessageContent>] [html [<Boolean>]]
|
||||
]
|
||||
```
|
||||
* `notify [<Boolean>]` - Should notification be sent
|
||||
|
||||
In the subject and message, these strings will be replaced with the specified values:
|
||||
* `#user#` - user's email address
|
||||
* `#delegate#` - delegate's email address
|
||||
|
||||
If subject is not specified, the following value will be used:
|
||||
* `#user# mail delegation to #delegate#`
|
||||
|
||||
`<NotifyMessageContent>` is the message, there are four ways to specify it:
|
||||
* `message|textmessage|htmlmessage <String>` - Use `<String>` as the message
|
||||
* `file|htmlfile <FileName> [charset <Charset>]` - Read the message from `<FileName>`
|
||||
* `gdoc|ghtml <UserGoogleDoc>` - Read the message from `<UserGoogleDoc>`
|
||||
* `gcsdoc|gcshtml <StorageBucketObjectName>` - Read the message from the Google Cloud Storage file `<StorageBucketObjectName>`
|
||||
|
||||
If `<NotifyMessageContent>`is not specified, the following value will be used:
|
||||
* `#user# has granted you #delegate# access to read, delete and send mail on their behalf.`
|
||||
|
||||
Unless specified in `<NotifyMessageContent>`, messages are sent as plain text,
|
||||
use `html` or `html true` to indicate that the message is HTML.
|
||||
|
||||
Use `\n` in `message <String>` to indicate a line break; no other special characters are recognized.
|
||||
|
||||
By default, the email is sent from the admin user identified in oauth2.txt, `gam oauth info` will show the value.
|
||||
Use `from <EmailAddress>` to specify an alternate from address.
|
||||
Use `mailbox <EmailAddress>` if `from <EmailAddress>` specifies a group; GAM has to login as a user to be able to send a message.
|
||||
Gam gets no indication as to the status of the message delivery; the from user will get a non-delivery receipt if the message could not be sent to the delegate.
|
||||
|
||||
## Create Gmail delegates
|
||||
These two commands are equivalent.
|
||||
```
|
||||
gam <UserTypeEntity> add delegate|delegates [convertalias] <UserEntity>
|
||||
[[notify <EmailAddressList>]
|
||||
[subject <String>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>]
|
||||
]
|
||||
gam <UserTypeEntity> delegate|delegates to [convertalias] <UserEntity>
|
||||
[[notify <EmailAddressList>]
|
||||
[subject <String>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>]
|
||||
]
|
||||
```
|
||||
### Example
|
||||
|
||||
@@ -51,6 +119,7 @@ To give Bob access to Fred's mailbox as a delegate:
|
||||
|
||||
```
|
||||
gam user fred@domain.com add delegate bob@domain.com
|
||||
gam user fred@domain.com delegate to bob@domain.com
|
||||
```
|
||||
|
||||
## Delete Gmail delegates
|
||||
|
||||
@@ -22,8 +22,6 @@
|
||||
* [Search Conference Participants](https://developers.google.com/meet/api/reference/rest/v2/conferenceRecords.participants/list)
|
||||
|
||||
## Introduction
|
||||
These features were added in version 6.81.00.
|
||||
|
||||
To use these commands you must add the 'Meet API' to your project and update your service account authorization.
|
||||
```
|
||||
gam update project
|
||||
|
||||
@@ -24,16 +24,9 @@
|
||||
- [Copy User Contacts to another User](#copy-user-contacts-to-another-user)
|
||||
|
||||
## Notes
|
||||
As of version `6.08.00`, GAM uses the People API to manage user contacts rather than the Contacts API.
|
||||
GAM uses the People API to manage user contacts rather than the Contacts API.
|
||||
|
||||
Most commands will work unchanged but Google has completely changed how the data is presented. If you
|
||||
have scripts that process the output from `print contacts` for example, they will have to be changed.
|
||||
|
||||
You might want to keep an older version of GAM available so you can compare the output from the two
|
||||
versions and make adjustments as necessary.
|
||||
|
||||
If you manage contacts in the contact group "Other Contacts", you will need to use an older version,
|
||||
as the People API has very little support for this.
|
||||
The People API has very little support for managing contacts in the contact group "Other Contacts".
|
||||
|
||||
To use these commands you must add the `People API` to your project and authorize the appropriate scopes:
|
||||
* `Client Access`
|
||||
|
||||
@@ -283,6 +283,8 @@ Linux/MacOS
|
||||
teamDriveId=$(gam user user@domain.com create shareddrive ... returnidonly)
|
||||
Windows PowerShell
|
||||
$teamDriveId = & gam user user@domain.com create shareddrive ... returnidonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com create shareddrive ... returnidonly') do set teamDriveId=%a
|
||||
```
|
||||
|
||||
## Bulk Create Shared Drives
|
||||
@@ -425,9 +427,11 @@ The `Getting` and `Got` messages are written to stderr, the count is writtem to
|
||||
To retrieve the count with `showitemcountonly`:
|
||||
```
|
||||
Linux/MacOS
|
||||
count=$(gam user user@domain.com print shareddrives showitemcountonly)
|
||||
count=$(gam user user@domain.com print shareddrives ... showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam user user@domain.com print shareddrives showitemcountonly
|
||||
$count = & gam user user@domain.com print shareddrives ... showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam user user@domain.com print shareddrives ... showitemcountonly') do set count=%a
|
||||
```
|
||||
## Display Shared Drive Organizers
|
||||
The following command can be used instead of the `GetTeamDriveOrganizers.py` script.
|
||||
@@ -603,8 +607,6 @@ gam redirect stdout ./AddU2SharedDriveAccess.txt multiprocess redirect stderr st
|
||||
```
|
||||
|
||||
## Bulk change User1 Shared Drive access to User2
|
||||
This requires GAM version 6.79.09 or higher.
|
||||
|
||||
Make a CSV file Users.csv with two email address columns: User,Replace
|
||||
```
|
||||
# Get Shared Drives for all Users in CSV file
|
||||
|
||||
@@ -401,14 +401,13 @@ password "helloworld" nohash
|
||||
```
|
||||
|
||||
## Password Notification
|
||||
When creating a user or updating a user's password, you can send a message with details to an email address;'
|
||||
this might be the user's secondary email address or their recovery email address.
|
||||
When creating a user or updating a user's password, you can send a message with details to an email address
|
||||
or addresses; these might be the user's secondary email address, their recovery email address or a help desk user.
|
||||
```
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAaddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAddress>]
|
||||
[<NotifyMessageContent>]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
@@ -419,6 +418,15 @@ this might be the user's secondary email address or their recovery email address
|
||||
* `notify <EmailAddressList>` - Specify recipients
|
||||
* `notifyrecoveryemail` - Use the user's recovery email address (if defined) as a recipient
|
||||
|
||||
In the subject and message, these strings will be replaced with the specified values:
|
||||
* `#givenname#` - first/given name
|
||||
* `#familyname#` - last/family name
|
||||
* `#email#` - user's email address
|
||||
* `#user#` - user's email address
|
||||
* `#username#` - portion of user's email address before @
|
||||
* `#domain#` - portion of user's email after after @
|
||||
* `#password#` - password
|
||||
|
||||
If subject is not specified, the following value will be used:
|
||||
* create - `Welcome to #domain#`
|
||||
* update - `Account #user# password has been changed`
|
||||
@@ -434,14 +442,8 @@ If `<NotifyMessageContent>`is not specified, the following value will be used:
|
||||
Start using your new account by signing in at\nhttps://www.google.com/accounts/AccountChooser?Email=#user#&continue=https://workspace.google.com/dashboard\n`
|
||||
* update - `The account password for #givenname# #familyname#, #user# has been changed to: #password#\n`
|
||||
|
||||
In the subject and message, these strings will be replaced with the specified values:
|
||||
* `#givenname#` - first/given name
|
||||
* `#familyname#` - last/family name
|
||||
* `#email#` - user's email address
|
||||
* `#user#` - user's email address
|
||||
* `#username#` - portion of user's email address before @
|
||||
* `#domain#` - portion of user's email after after @
|
||||
* `#password#` - password
|
||||
Unless specified in `<NotifyMessageContent>`, messages are sent as plain text,
|
||||
use `html` or `html true` to indicate that the message is HTML.
|
||||
|
||||
Use `\n` in `message <String>` to indicate a line break; no other special characters are recognized.
|
||||
|
||||
@@ -464,8 +466,6 @@ Use `from <EmailAddress>` to specify an alternate from address.
|
||||
Use `mailbox <EmailAddress>` if `from <EmailAddress>` specifies a group; GAM has to login as a user to be able to send a message.
|
||||
Gam gets no indication as to the status of the message delivery; the from user will get a non-delivery receipt if the message could not be sent to the `notify <EmailAddressList>`.
|
||||
|
||||
By default, messages are sent as plain text, use `html` or `html true` to indicate that the message is HTML.
|
||||
|
||||
## Define schema fields
|
||||
You can set custom schema field values for users; schema fields can be scalar, a single value, or can be multivalued.
|
||||
* https://developers.google.com/admin-sdk/directory/reference/rest/v1/schemas
|
||||
@@ -658,8 +658,7 @@ gam update user <UserItem> [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAaddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAddress>]
|
||||
[<NotifyMessageContent>]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
@@ -680,8 +679,7 @@ gam update users <UserTypeEntity> [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAaddress>]
|
||||
[<NotifyMessageContent>]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
@@ -702,8 +700,7 @@ gam <UserTypeEntity> update users [ignorenullpassword] <UserAttribute>*
|
||||
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
||||
[subject <String>]
|
||||
[notifypassword <String>]
|
||||
[from <EmailAaddress>]
|
||||
[mailbox <EmailAddress>]
|
||||
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
||||
[replyto <EmailAddress>]
|
||||
[<NotifyMessageContent>]
|
||||
(replace <Tag> <UserReplacement>)*
|
||||
@@ -996,11 +993,9 @@ gam <UserTypeEntity> info users
|
||||
For `info users`, unlike all other GAM commands, a `<UserTypeEntity>` value of `all users` is actually `all users_ns_susp` not `all users_ns`.
|
||||
This is a backwards compatibility issue.
|
||||
|
||||
Starting in version `5.23.01`, the variable `quick_info_user` was added to `gam.cfg` to control how much information requiring additional API calls is displayed.
|
||||
(Prior to version `5.23.01`, assume `quick_info_user = False`.)
|
||||
The variable `quick_info_user` was added to `gam.cfg` controls how much information requiring additional API calls is displayed.
|
||||
|
||||
`quick_info_user = False`: Gam makes additional API calls to get more information; you can selectively eliminate these calls to improve performance.
|
||||
|
||||
* `noaliases` - Do not get alias information
|
||||
* `nobuildingnames` - Do not get building names for locations
|
||||
* `nogroups` - Do not get group membership information
|
||||
@@ -1344,8 +1339,11 @@ To retrieve the count with `showitemcountonly`:
|
||||
Linux/MacOS
|
||||
count=$(gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly)
|
||||
Windows PowerShell
|
||||
count = & gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly
|
||||
$count = & gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly
|
||||
Windows Command Prompt
|
||||
for /f "delims=" %a in ('gam print users query "orgUnitPath='/Students/Middle School'" showitemcountonly') do set count=%a
|
||||
```
|
||||
|
||||
## Verify domain membership
|
||||
You have a CSV file of email addresses and want to verify of the addresses are valid users in your domain.
|
||||
```
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
# Using GAM7 with a YubiKey
|
||||
- [Thanks](#thanks)
|
||||
- [Yubikey ykman PIV Commands](https://docs.yubico.com/software/yubikey/tools/ykman/PIV_Commands.html)
|
||||
- [Introduction](#introduction)
|
||||
- [FAQs](#faqs)
|
||||
@@ -7,15 +6,9 @@
|
||||
|
||||
**Alternative Approach**: For enhanced security and simplified operations when running GAM outside Google Cloud, consider [Workload Identity Federation](https://github.com/GAM-team/GAM/wiki/Using-GAM7-with-keyless-authentication-Workload-Identity-Federation) - Google's recommended keyless authentication method that eliminates the need for managing any long-lived credentials. If running GAM in Google Cloud, use [attached service accounts on GCE](https://github.com/GAM-team/GAM/wiki/Running-GAM7-securely-on-a-Google-Compute-Engine) instead.
|
||||
|
||||
## Thanks
|
||||
|
||||
Thanks to Jay Lee for the original version of this document.
|
||||
|
||||
## Introduction
|
||||
GAM7 supports using a [YubiKey](https://www.yubico.com/products/yubikey-5-overview/) to generate and store the service account's private RSA key. Private keys generated by the YubiKey cannot be exported even to the computer running GAM7. When compared to the plain text oauth2service.json file with the private key stored in text, the YubiKey offers a more secure option that prevents digital theft and copying of the private key. Instead of reading the private key from the oauth2service.json file and signing requests itself, GAM7 will simply send signing requests to the YubiKey and get back the signature.
|
||||
|
||||
GAM7 version 6.50.01 or higher is required. Best practice is to always use the [latest version of GAM7](https://github.com/GAM-team/GAM/wiki/How-to-Update-Advanced-GAM).
|
||||
|
||||
## FAQs
|
||||
### Can I use a Google Titan or other brand security key?
|
||||
No, while Titan keys are great as security keys / U2F / 2SV, that is not the protocol being used by GAM7 here. GAM7 uses the PIV app of YubiKeys to work with service accounts. You need to use [a genuine Yubikey.](https://yubico.com/genuine/).
|
||||
@@ -36,7 +29,7 @@ No, because the YubiKey generated the private key it cannot be digitally exporte
|
||||
When using domain-wide delegation with GAM7, the service account and anyone possessing the service account private key oauth2service.json file has access to the Gmail, Drive and Calendar data of ALL Workspace users in your domain. For this reason, whether using a YubiKey or not, you should take strong measures to protect the service account private key.
|
||||
|
||||
## Setup Steps
|
||||
1. Upgrade to at least GAM7 6.50.01.
|
||||
1 .Upgrade to the [latest version of GAM7](https://github.com/GAM-team/GAM/wiki/How-to-Update-GAM7).
|
||||
2. **If you are using a new YubiKey or don't care about the PIV app data on the YubiKey**
|
||||
1. Tell GAM7 to reset and configure the PIV app data on the YubiKey. This wipes all existing keys and configuration and then configures a private key and PIN for GAM7.
|
||||
* Single YubiKey - `gam yubikey reset_piv`
|
||||
|
||||
@@ -24,7 +24,7 @@ Not all Google Admin APIs work with DASA right no:
|
||||
* GAM7 support for DASA is still experimental and some things may fail. Please report your findings to the [GAM group](https://groups.google.com/g/google-apps-manager).
|
||||
|
||||
## Setup Steps
|
||||
1. Upgrade to at least GAM7 6.50.00. Best practice is to always use the [latest version of GAM7](https://github.com/GAM-team/GAM/wiki/How-to-Update-Advanced-GAM).
|
||||
1. Upgrade to the [latest version of GAM7](https://github.com/GAM-team/GAM/wiki/How-to-Update-GAM7).
|
||||
|
||||
2. Follow the steps in `gam create project` up to the point where you are presented with a URL to the Cloud console to create a Client ID and secret. You don’t need to enter anything those, just press CTRL+C to quit the project creation.
|
||||
|
||||
|
||||
@@ -487,10 +487,8 @@ Alternatively, `<FileName>` can contain the strings `#objectname#`, `#filename#`
|
||||
and `#extension#` which will be replaced by the values from the original object names to construct a complete top level name.
|
||||
For example, `targetname "#filename#.#extension#"` strips the long matter name from the original name.
|
||||
|
||||
**In versions prior to 6.07.14, If `<FileName>` does not contain `#filename#` and there are multiple top level files with the same extension, only the
|
||||
last file with a given extension will be saved as the earlier files will be overwritten.**
|
||||
|
||||
This is fixed in 6.07.14: the files will be named `FileName-N.ext` where `N` is `1,2,3,...`.
|
||||
If `<FileName>` does not contain `#filename#` and there are multiple top level files with the same extension,
|
||||
the files will be named `FileName-N.ext` where `N` is `1,2,3,...`.
|
||||
|
||||
Zip files extracted from the top level Zip file will still have their long names.
|
||||
|
||||
@@ -584,7 +582,6 @@ done < user1@domain.com-vault-files.csv
|
||||
Why would you want to download files one by one when GAM can download all Cloud Storage objects in one go? Because all of the files combined **might** take up a lot of space (think Terabytes in case of a Drive export of many years) whereas individually, each file will be in a much more manageable ~10 Gigabyte range.
|
||||
|
||||
## Copy Vault Exports
|
||||
Many thanks to Jay for this command and documentation.
|
||||
```
|
||||
gam copy vaultexport|export <ExportItem> matter <MatterItem>
|
||||
[targetbucket <String>] [targetprefix <String>]
|
||||
@@ -929,9 +926,8 @@ Select fields to display:
|
||||
The `shownames` argument controls whether org unit and shared drive names are displayed in queries; additional API calls are required to get the names.
|
||||
|
||||
## Takeout
|
||||
Many thanks to Jay for these commands and documentation.
|
||||
|
||||
GAM 6.42.00 and newer support copying and downloading Google Cloud Storage (GCS) buckets generated by [organization-wide Takeout](https://support.google.com/a/answer/100458?hl=en).
|
||||
GAM supports copying and downloading Google Cloud Storage (GCS) buckets generated by [organization-wide Takeout](https://support.google.com/a/answer/100458?hl=en).
|
||||
Once the Takeout completes you need to copy the name of the GCS bucket and provide it to GAM.
|
||||
|
||||
## Copy a Takeout Bucket
|
||||
|
||||
@@ -3,10 +3,10 @@
|
||||
Print the current version of Gam with details
|
||||
```
|
||||
gam version
|
||||
GAM 7.25.01 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.28.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.0 64-bit final
|
||||
macOS Tahoe 26.0.1 x86_64
|
||||
macOS Tahoe 26.1 x86_64
|
||||
Path: /Users/Admin/bin/gam7
|
||||
Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
Time: 2023-06-02T21:10:00-07:00
|
||||
@@ -15,10 +15,10 @@ 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.25.01 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.28.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.0 64-bit final
|
||||
macOS Tahoe 26.0.1 x86_64
|
||||
macOS Tahoe 26.1 x86_64
|
||||
Path: /Users/Admin/bin/gam7
|
||||
Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
Your system time differs from www.googleapis.com by less than 1 second
|
||||
@@ -27,10 +27,10 @@ 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.25.01 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.28.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.0 64-bit final
|
||||
macOS Tahoe 26.0.1 x86_64
|
||||
macOS Tahoe 26.1 x86_64
|
||||
Path: /Users/Admin/bin/gam7
|
||||
Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
Time: 2023-06-02T21:10:00-07:00
|
||||
@@ -68,7 +68,7 @@ MacOS High Sierra 10.13.6 x86_64
|
||||
Path: /Users/Admin/bin/gam7
|
||||
Version Check:
|
||||
Current: 5.35.08
|
||||
Latest: 7.25.01
|
||||
Latest: 7.28.00
|
||||
echo $?
|
||||
1
|
||||
```
|
||||
@@ -76,7 +76,7 @@ echo $?
|
||||
Print the current version number without details
|
||||
```
|
||||
gam version simple
|
||||
7.25.01
|
||||
7.28.00
|
||||
```
|
||||
In Linux/MacOS you can do:
|
||||
```
|
||||
@@ -86,10 +86,10 @@ echo $VER
|
||||
Print the current version of Gam and address of this Wiki
|
||||
```
|
||||
gam help
|
||||
GAM 7.25.01 - https://github.com/GAM-team/GAM
|
||||
GAM 7.28.00 - https://github.com/GAM-team/GAM
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.0 64-bit final
|
||||
macOS Tahoe 26.0.1 x86_64
|
||||
macOS Tahoe 26.1 x86_64
|
||||
Path: /Users/Admin/bin/gam7
|
||||
Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
Time: 2023-06-02T21:10:00-07:00
|
||||
|
||||
1
wiki/foo.lst
Normal file
1
wiki/foo.lst
Normal file
@@ -0,0 +1 @@
|
||||
ChromeOS-Devices.md Classroom-Courses.md Classroom-Membership.md Classroom-StudentGroups.md Cloud-Identity-Devices.md Cloud-Identity-Groups.md Domains.md GamUpdates.md Groups.md Mobile-Devices.md Organizational-Units.md Resources.md Shared-Drives.md Users-Shared-Drives.md Users.md
|
||||
@@ -303,6 +303,9 @@ debug_level
|
||||
If debug_level > 0, turn on API debugging output.
|
||||
Default: 0
|
||||
Signal file: OldGamPath/debug.gam
|
||||
debug_redaction
|
||||
Enable/disable redaction of sensitive data from API debugging output
|
||||
Default: True
|
||||
device_max_results
|
||||
When retrieving lists of ChromeOS devices from API,
|
||||
how many should be retrieved in each API call
|
||||
|
||||
Reference in New Issue
Block a user