pylint cleanup; fix broken links

This commit is contained in:
Ross Scroggs
2023-08-18 10:43:13 -07:00
parent 3e85b268a0
commit b79c48718e
9 changed files with 28 additions and 24 deletions

View File

@ -11,7 +11,7 @@
- [Add calendar attendees](#add-calendar-attendees) - [Add calendar attendees](#add-calendar-attendees)
- [Update calendar events](#update-calendar-events) - [Update calendar events](#update-calendar-events)
- [Update calendar attendees](#update-calendar-attendees) - [Update calendar attendees](#update-calendar-attendees)
- [Specify calendar attendees with JSON data](#specify-calendar-attendees-with-JSON-data) - [Specify calendar attendees with JSON data](#specify-calendar-attendees-with-json-data)
- [Delete selected calendar events](#delete-selected-calendar-events) - [Delete selected calendar events](#delete-selected-calendar-events)
- [Delete all calendar events](#delete-all-calendar-events) - [Delete all calendar events](#delete-all-calendar-events)
- [Move calendar events to another calendar](#move-calendar-events-to-another-calendar) - [Move calendar events to another calendar](#move-calendar-events-to-another-calendar)

View File

@ -11,7 +11,7 @@
- [GUI API Group settings mapping](#gui-api-group-settings-mapping) - [GUI API Group settings mapping](#gui-api-group-settings-mapping)
- [GUI API Group access type settings mapping](#gui-api-group-access-type-settings-mapping) - [GUI API Group access type settings mapping](#gui-api-group-access-type-settings-mapping)
- [Manage groups](#manage-groups) - [Manage groups](#manage-groups)
- [Update a group's settings with JSON data](#update-a-groups-settings-with-JSON-data) - [Update a group's settings with JSON data](#update-a-groups-settings-with-json-data)
- [Display information about specific groups](#display-information-about-specific-groups) - [Display information about specific groups](#display-information-about-specific-groups)
- [Display information about selected groups](#display-information-about-selected-groups) - [Display information about selected groups](#display-information-about-selected-groups)
- [Display a group and its parents](#Display-a-group-and-its-parents) - [Display a group and its parents](#Display-a-group-and-its-parents)

View File

@ -1,5 +1,5 @@
# Running GAMADV-XTD3 securely on a Google Compute Engine # Running GAMADV-XTD3 securely on a Google Compute Engine
- [Thanks](#Thanks) - [thanks](#thanks)
- [Introduction](#introduction) - [Introduction](#introduction)
- [Setup Steps](#setup-steps) - [Setup Steps](#setup-steps)

View File

@ -11,7 +11,7 @@
- [Update calendar events](#update-calendar-events) - [Update calendar events](#update-calendar-events)
- [Add calendar attendees](#add-calendar-attendees) - [Add calendar attendees](#add-calendar-attendees)
- [Update calendar attendees](#update-calendar-attendees) - [Update calendar attendees](#update-calendar-attendees)
- [Specify calendar attendees with JSON data](#specify-calendar-attendees-with-JSON-data) - [Specify calendar attendees with JSON data](#specify-calendar-attendees-with-json-data)
- [Delete selected calendar events](#delete-selected-calendar-events) - [Delete selected calendar events](#delete-selected-calendar-events)
- [Delete all calendar events](#delete-all-calendar-events) - [Delete all calendar events](#delete-all-calendar-events)
- [Move calendar events to another calendar](#move-calendar-events-to-another-calendar) - [Move calendar events to another calendar](#move-calendar-events-to-another-calendar)

View File

@ -7,7 +7,7 @@
- [Return Codes](#return-codes) - [Return Codes](#return-codes)
- [Display file information](#display-file-information) - [Display file information](#display-file-information)
- [Display file paths](#display-file-paths) - [Display file paths](#display-file-paths)
- [Select files for Display file counts, list, tree](#select-files-for-Display-file-counts-list-tree) - [Select files for Display file counts, list, tree](#select-files-for-display-file-counts-list-tree)
- [File selection definitions](#file-selection-definitions) - [File selection definitions](#file-selection-definitions)
- [File selection defaults](#file-selection-defaults) - [File selection defaults](#file-selection-defaults)
- [File selection by query](#file-selection-by-query) - [File selection by query](#file-selection-by-query)
@ -634,7 +634,7 @@ By default, print filecounts displays counts of all files owned by the specified
The `showsize` option displays the total size (in bytes) of the files counted. The `showsize` option displays the total size (in bytes) of the files counted.
See [Select files for Display file counts, list, tree](#select-files-for-Display-file-counts-list-tree) See [Select files for Display file counts, list, tree](#select-files-for-display-file-counts-list-tree)
Use the `excludetrashed` option to suppress counting files in the trash. Use the `excludetrashed` option to suppress counting files in the trash.
@ -796,7 +796,7 @@ gam <UserTypeEntity> show filetree
``` ```
By default, the file tree starting at the root and all orphans are shown. By default, the file tree starting at the root and all orphans are shown.
See [Select files for Display file counts, list, tree](#select-files-for-Display-file-counts-list-tree) See [Select files for Display file counts, list, tree](#select-files-for-display-file-counts-list-tree)
## File selection starting point for Display file tree ## File selection starting point for Display file tree
You can specify a specific folder from which to select files. You can specify a specific folder from which to select files.
@ -866,7 +866,7 @@ When `allfields` is specified (or no fields are specified), use `showshareddrive
when shared drives are queried/selected. In this case, the Drive API returns the permission IDs when shared drives are queried/selected. In this case, the Drive API returns the permission IDs
but not the permissions themselves so GAM makes an additional API call per file to get the permissions. but not the permissions themselves so GAM makes an additional API call per file to get the permissions.
See [Select files for Display file counts, list, tree](#select-files-for-Display-file-counts-list-tree) See [Select files for Display file counts, list, tree](#select-files-for-display-file-counts-list-tree)
## File selection by name and entity shortcuts for Display file list ## File selection by name and entity shortcuts for Display file list
Select a subset of files by pre-defined queries. Select a subset of files by pre-defined queries.
@ -1359,7 +1359,7 @@ gam <UserTypeEntity> print diskusage <DriveFileEntity> [todrive <ToDriveAttribut
(addcsvdata <FieldName> <String>)* (addcsvdata <FieldName> <String>)*
[noprogress] [show all|summary|summaryandtrash] [noprogress] [show all|summary|summaryandtrash]
``` ```
For each folder in `<DiskFileEntity>`, the following items are displayed: For each folder in `<DriveFileEntity>`, the following items are displayed:
* `User` - The email address of the user in `<UserTypeEntity>` * `User` - The email address of the user in `<UserTypeEntity>`
* `Owner` - The email address of the owner of the folder; omitted when displaying disk usage on Shared Drives * `Owner` - The email address of the owner of the folder; omitted when displaying disk usage on Shared Drives
* `ownedByMe` - True if the folder is owned by `User`, False otherwise; omitted when displaying disk usage on Shared Drives * `ownedByMe` - True if the folder is owned by `User`, False otherwise; omitted when displaying disk usage on Shared Drives
@ -1411,9 +1411,9 @@ Add additional columns of data from the command line to the output:
By default, progress messages are displayed for each folder, use `noprogress` to suppress these messages. By default, progress messages are displayed for each folder, use `noprogress` to suppress these messages.
Use the `show` option to control the display of data: Use the `show` option to control the display of data:
* `all` - Display a row for every folder in `<DriveFileEntity>` and a row detailing items in the trash when `excludetrashed` is omitted. This is the default. * `show all` - Display a row for every folder in `<DriveFileEntity>` and a row detailing items in the trash when `excludetrashed` is omitted. This is the default.
* `summary` - Display a single row for the first folder in `<DriveFileEntity>` * `show summary` - Display a single row for the first folder in `<DriveFileEntity>`
* `summaryandtrash` - Display a single row for the first folder in `<DriveFileEntity>` and a row detailing items in the trash when `excludetrashed` is omitted. * `show summaryandtrash` - Display a single row for the first folder in `<DriveFileEntity>` and a row detailing items in the trash when `excludetrashed` is omitted.
### Examples ### Examples
``` ```

View File

@ -13,7 +13,7 @@
- [Define schema fields](#define-schema-fields) - [Define schema fields](#define-schema-fields)
- [Clear schema fields](#clear-schema-fields) - [Clear schema fields](#clear-schema-fields)
- [Create a user](#create-a-user) - [Create a user](#create-a-user)
- [Specify a user's attributes with JSON data](#specify-a-users-attributes-with-JSON-data) - [Specify a user's attributes with JSON data](#specify-a-users-attributes-with-json-data)
- [Verify mailbox creation](#verify-mailbox-creation) - [Verify mailbox creation](#verify-mailbox-creation)
- [Update a user](#update-a-user) - [Update a user](#update-a-user)
- [Special case processing for update user](#special-case-processing-for-update-user) - [Special case processing for update user](#special-case-processing-for-update-user)
@ -21,9 +21,9 @@
- [Update a user's name](#update-a-users-name) - [Update a user's name](#update-a-users-name)
- [Update a user's password](#update-a-users-password) - [Update a user's password](#update-a-users-password)
- [Update a user's primary email address](#update-a-users-primary-email-address) - [Update a user's primary email address](#update-a-users-primary-email-address)
- [Update a user's attributes with JSON data](#update-a-users-attributes-with-JSON-data) - [Update a user's attributes with JSON data](#update-a-users-attributes-with-json-data)
- [Update a user's OU based on group membership](#update-a-users-ou-based-on-group-membership) - [Update a user's OU based on group membership](#update-a-users-ou-based-on-group-membership)
- [Do not update a user's OU if currently in a special purpose OU](#do-not-update-a-users-OU-if-currently-in-a-special-purpose-ou) - [Do not update a user's OU if currently in a special purpose OU](#do-not-update-a-users-ou-if-currently-in-a-special-purpose-ou)
- [Delete or suspend users](#delete-or-suspend-users) - [Delete or suspend users](#delete-or-suspend-users)
- [Undelete or unsuspend users](#undelete-or-unsuspend-users) - [Undelete or unsuspend users](#undelete-or-unsuspend-users)
- [Display information about users](#display-information-about-users) - [Display information about users](#display-information-about-users)
@ -34,10 +34,10 @@
- [Print a header row and primaryEmail for all users](#print-a-header-row-and-primaryemail-for-all-users) - [Print a header row and primaryEmail for all users](#print-a-header-row-and-primaryemail-for-all-users)
- [Print user details](#print-user-details) - [Print user details](#print-user-details)
- [Print a header row and fields for selected users](#print-a-header-row-and-fields-for-selected-users) - [Print a header row and fields for selected users](#print-a-header-row-and-fields-for-selected-users)
- [Print a header row and fields for users specified by `<UserTypeEntity>`](#print-a-header-row-and-fields-for-users-specified-by-UserTypeEntity) - [Print a header row and fields for users specified by `<UserTypeEntity>`](#print-a-header-row-and-fields-for-users-specified-by-usertypeentity)
- [Print user domain counts](#print-user-domain-counts) - [Print user domain counts](#print-user-domain-counts)
- [Print domain counts for users in a specific domain and/or selected by a query](#print-domain-counts-for-users-in-a-specific-domain-and-or-selected-by-a-query) - [Print domain counts for users in a specific domain and/or selected by a query](#print-domain-counts-for-users-in-a-specific-domain-and-or-selected-by-a-query)
- [Print domain counts for users specified by `<UserTypeEntity>`](#print-domain-counts-for-users-specified-by-UserTypeEntity) - [Print domain counts for users specified by `<UserTypeEntity>`](#print-domain-counts-for-users-specified-by-usertypeentity)
- [Print user list](#print-user-list) - [Print user list](#print-user-list)
## API documentation ## API documentation

View File

@ -1,5 +1,5 @@
# Using GAMADV-XTD3 with a YubiKey # Using GAMADV-XTD3 with a YubiKey
- [Thanks](#Thanks) - [Thanks](#thanks)
- [Introduction](#introduction) - [Introduction](#introduction)
- [FAQs](#faqs) - [FAQs](#faqs)
- [Setup Steps](#setup-steps) - [Setup Steps](#setup-steps)

View File

@ -1,5 +1,5 @@
# Using GAMADV-XTD3 with a delegated admin service account # Using GAMADV-XTD3 with a delegated admin service account
- [Thanks](#Thanks) - [Thanks](#thanks)
- [Introduction](#introduction) - [Introduction](#introduction)
- [Advantages](#advantages) - [Advantages](#advantages)
- [Disadvantages](#disadvantages) - [Disadvantages](#disadvantages)

View File

@ -40380,8 +40380,9 @@ def createUserAddAliases(cd, user, aliasList, i, count):
# [addnumericsuffixonduplicate <Number>] # [addnumericsuffixonduplicate <Number>]
def doCreateUser(): def doCreateUser():
cd = buildGAPIObject(API.DIRECTORY) cd = buildGAPIObject(API.DIRECTORY)
body, notify, tagReplacements, addGroups, addAliases, PwdOpts, _, _, _, \ body, notify, tagReplacements, addGroups, addAliases, PwdOpts, \
parameters, resolveConflictAccount = getUserAttributes(cd, _, _, _, \
parameters, resolveConflictAccount = getUserAttributes(cd,
False, False,
noUid=True) noUid=True)
suffix = 0 suffix = 0
@ -40483,8 +40484,9 @@ def updateUsers(entityList):
cd = buildGAPIObject(API.DIRECTORY) cd = buildGAPIObject(API.DIRECTORY)
ci = None ci = None
body, notify, tagReplacements, addGroups, addAliases, PwdOpts, \ body, notify, tagReplacements, addGroups, addAliases, PwdOpts, \
updatePrimaryEmail, notFoundBody, groupOrgUnitMap, parameters, \ updatePrimaryEmail, notFoundBody, groupOrgUnitMap, \
_ = getUserAttributes(cd, True) parameters, resolveConflictAccount = getUserAttributes(cd,
True)
vfe = 'primaryEmail' in body and body['primaryEmail'][:4].lower() == 'vfe@' vfe = 'primaryEmail' in body and body['primaryEmail'][:4].lower() == 'vfe@'
if body.get('orgUnitPath', '') and parameters['immutableOUs']: if body.get('orgUnitPath', '') and parameters['immutableOUs']:
ubody = body.copy() ubody = body.copy()
@ -40580,7 +40582,9 @@ def updateUsers(entityList):
throwReasons=[GAPI.DUPLICATE, GAPI.DOMAIN_NOT_FOUND, GAPI.FORBIDDEN, throwReasons=[GAPI.DUPLICATE, GAPI.DOMAIN_NOT_FOUND, GAPI.FORBIDDEN,
GAPI.INVALID, GAPI.INVALID_INPUT, GAPI.INVALID_PARAMETER, GAPI.INVALID, GAPI.INVALID_INPUT, GAPI.INVALID_PARAMETER,
GAPI.INVALID_ORGUNIT, GAPI.INVALID_SCHEMA_VALUE], GAPI.INVALID_ORGUNIT, GAPI.INVALID_SCHEMA_VALUE],
body=body, fields=fields) body=body,
fields=fields,
resolveConflictAccount=resolveConflictAccount)
entityActionPerformed([Ent.USER, body['primaryEmail']], i, count) entityActionPerformed([Ent.USER, body['primaryEmail']], i, count)
if PwdOpts.filename and PwdOpts.notFoundPassword: if PwdOpts.filename and PwdOpts.notFoundPassword:
writeFile(PwdOpts.filename, f'{user},{PwdOpts.notFoundPassword}\n', mode='a', continueOnError=True) writeFile(PwdOpts.filename, f'{user},{PwdOpts.notFoundPassword}\n', mode='a', continueOnError=True)