deepblue/GoogleDriveManagement
1
0
Fork 0
mirror of https://github.com/GAM-team/GAM.git synced 2026-07-03 12:21:35 +00:00
Code Issues Actions 17 Packages Projects Releases Wiki Activity

Update documentation (#454)

Browse Source 
* Fix create project to handle Google change

* Handle newlines in app name

Don’t output name/value for
name == u'accounts:authorized_apps’, apps are listed later

* Cleanup

My typos: 614, 813
Pylint: 887, 3618/4184, 8657, 8751
Your typo: 6794

* Update documentation
This commit is contained in:
Ross Scroggs
2017-03-22 19:05:57 -07:00
committed by Jay Lee
parent 81c2e425ef
commit de3be6ba52
1 changed files with 47 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
src/GamCommands.txt
View File

@@ -1,6 +1,8 @@
This document describes the GAM command line syntax in modified BNF, see https://en.wikipedia.org/wiki/Backus-Naur_Form This document describes the GAM command line syntax in modified BNF, see https://en.wikipedia.org/wiki/Backus-Naur_Form
Skip the History section and start reading at Introduction.
Items on the command line are space separated, when an actual space character is required, it will be indicated by <Space>. Items on the command line are space separated, when an actual space character is required, it will be indicated by <Space>.
If an item contains spaces, it should be surrounded by " or '. If an item contains spaces, it should be surrounded by ".
[] optional item [] optional item
() group items () group items
@@ -13,7 +15,7 @@ Primitives
<Number> ::= <Digit>+ <Number> ::= <Digit>+
<Hex> ::= <Digit>|a|b|c|d|e|f|A|B|C|D|E|F <Hex> ::= <Digit>|a|b|c|d|e|f|A|B|C|D|E|F
<Space> ::= an actual space character <Space> ::= an actual space character
<String> ::= a string of characters, surrounded by " or ' if it contains spaces <String> ::= a string of characters, surrounded by " if it contains spaces
<TrueValues> ::= true|on|yes|enabled|1 <TrueValues> ::= true|on|yes|enabled|1
<FalseValues>= false|off|no|disabled|0 <FalseValues>= false|off|no|disabled|0
<DataTransferService> ::= googledrive|gdrive|drive|"drive and docs" <DataTransferService> ::= googledrive|gdrive|drive|"drive and docs"
@@ -138,6 +140,7 @@ Named items
<Section> ::= <String> <Section> ::= <String>
<S/MIMEID> ::= <String> <S/MIMEID> ::= <String>
<StudentItem> ::= <EmailAddress>|<UniqueID>|<String> <StudentItem> ::= <EmailAddress>|<UniqueID>|<String>
<TeamDriveID> ::= <String>
<Timezone> ::= <String> <Timezone> ::= <String>
<Title> ::= <String> <Title> ::= <String>
<URI> ::= <String> <URI> ::= <String>
@@ -162,7 +165,7 @@ Named items
teacherfolder| teacherfolder|
teachergroupemail| teachergroupemail|
updatetime updatetime
<CourseFieldNameList> ::= '<CourseFieldName>(,<CourseFieldName>)*' <CourseFieldNameList> ::= "<CourseFieldName>(,<CourseFieldName>)*"
<CrOSFieldName> ::= <CrOSFieldName> ::=
activetimeranges|timeranges| activetimeranges|timeranges|
@@ -266,6 +269,7 @@ Named items
customreplyto| customreplyto|
defaultmessagedenynotificationtext| defaultmessagedenynotificationtext|
description| description|
directmemberscount|
email| email|
id| id|
includeinglobaladdresslist|gal| includeinglobaladdresslist|gal|
@@ -345,35 +349,35 @@ Named Lists
Lists can be in the following formats Lists can be in the following formats
Items, separated by commas, without spaces or commas in the items themselves: item(,item)* Items, separated by commas, without spaces or commas in the items themselves: item(,item)*
Items, separated by spaces, without spaces or commas in the items themselves: "item( item)*" Items, separated by spaces, without spaces or commas in the items themselves: "item( item)*"
Items, separated by commas, with spaces or commas in the items themselves: "'it em'(,'it em')*" Items, separated by commas, with spaces or commas in the items themselves: "'it em'(,'it,em')*"
Items, separated by spaces, with spaces or commas in the items themselves: "'it em'( 'it em')*" Items, separated by spaces, with spaces or commas in the items themselves: "'it em'( 'it,em')*"
<ACLList> ::== '<ACLScope>(,<ACLScope>)*' <ACLList> ::== "<ACLScope>(,<ACLScope>)*"
<CalendarList> ::= '<CalendarItem>(,<CalendarItem>)*' <CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
<CourseAliasList> ::= '<CourseAlias>(,<CourseAlias>)*' <CourseAliasList> ::= "<CourseAlias>(,<CourseAlias>)*"
<CourseIDList> ::= '<CourseID>(,<CourseID>)*' <CourseIDList> ::= "<CourseID>(,<CourseID>)*"
<CrOSFieldNameList> ::= '<CrOSFieldName>(,<CrOSFieldName>)*' <CrOSFieldNameList> ::= "<CrOSFieldName>(,<CrOSFieldName>)*"
<CrOSList> ::= '<CrOSID>(,<CrOSID>)*' <CrOSList> ::= "<CrOSID>(,<CrOSID>)*"
<DriveFileList> ::= '<DriveFileItem>(,<DriveFileItem>)*' <DriveFileList> ::= "<DriveFileItem>(,<DriveFileItem>)*"
<EmailAddressList> ::= '<EmailAddress>(,<EmailAddress>)*' <EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
<EventIDList> ::= '<EventID>(,<EventID>)*' <EventIDList> ::= "<EventID>(,<EventID>)*"
<FileFormatList> ::= '<FileFormat>(,<FileFormat)*' <FileFormatList> ::= "<FileFormat>(,<FileFormat)*"
<FilterIDList> ::= '<FilterID>(,<FilterID>)*' <FilterIDList> ::= "<FilterID>(,<FilterID>)*"
<GroupFieldNameList> ::= '<GroupFieldName>(,<GroupFieldName>)*' <GroupFieldNameList> ::= "<GroupFieldName>(,<GroupFieldName>)*"
<GroupList> ::= '<GroupItem>(,<GroupItem>)*' <GroupList> ::= "<GroupItem>(,<GroupItem>)*"
<GuardianStateList> ::= '<GuardianState>(,<GuardianState>)*' <GuardianStateList> ::= "<GuardianState>(,<GuardianState>)*"
<LabelNameList> ::= '<LabelName>(,<LabelName)*' <LabelNameList> ::= "<LabelName>(,<LabelName)*"
<MembersFieldNameList> ::= '<MembersFieldName>(,<MembersFieldName>)*' <MembersFieldNameList> ::= "<MembersFieldName>(,<MembersFieldName>)*"
<MobileList> ::= '<MobileId>(,<MobileId>)*' <MobileList> ::= "<MobileId>(,<MobileId>)*"
<OrgUnitList> ::== '<OrgUnitPath>(,<OrgUnitPath>)*' <OrgUnitList> ::== "<OrgUnitPath>(,<OrgUnitPath>)*"
<PrinterIDList> ::= '<PrinterID>(,<PrinterID>)*' <PrinterIDList> ::= "<PrinterID>(,<PrinterID>)*"
<ProductIDList> ::= '(<ProductID>|SKUID>)(,<ProductID>|SKUID>)*' <ProductIDList> ::= "(<ProductID>|SKUID>)(,<ProductID>|SKUID>)*"
<PrintJobIDList> ::= '<PrintJobID>(,<PrintJobID>)*' <PrintJobIDList> ::= "<PrintJobID>(,<PrintJobID>)*"
<ResourceIDList> ::= '<ResourceID>(,<ResourceID>)*' <ResourceIDList> ::= "<ResourceID>(,<ResourceID>)*"
<SKUIDList> ='<SKUID>(,<SKUID>)*' <SKUIDList> ="<SKUID>(,<SKUID>)*"
<SchemaNameList> ::= '<SchemaName>(,<SchemaName>)*' <SchemaNameList> ::= "<SchemaName>(,<SchemaName>)*"
<UserFieldNameList> ::= '<UserFieldName>(,<UserFieldName>)*' <UserFieldNameList> ::= "<UserFieldName>(,<UserFieldName>)*"
<UserList> ::= '<UserItem>(,<UserItem>)*' <UserList> ::= "<UserItem>(,<UserItem>)*"
Specify a collection of ChromeOS devices by directly specifying them Specify a collection of ChromeOS devices by directly specifying them
<CrOSTypeEntity> ::= <CrOSTypeEntity> ::=
@@ -506,7 +510,7 @@ Item attributes
(relation|relations clear|(spouse|child|mother|father|parent|brother|sister|friend|relative|domestic_partner|manager|assistant|referred_by|partner|<String> <String>))| (relation|relations clear|(spouse|child|mother|father|parent|brother|sister|friend|relative|domestic_partner|manager|assistant|referred_by|partner|<String> <String>))|
(suspended <Boolean>)| (suspended <Boolean>)|
(website|websites clear|(home_page|blog|profile|work|home|other|ftp|reservations|app_install_page|<String> <URL> [notprimary|primary]))| (website|websites clear|(home_page|blog|profile|work|home|other|ftp|reservations|app_install_page|<String> <URL> [notprimary|primary]))|
(<SchemaName>.<FieldName> [multivalued|multivalue|value [type work|home|other|(custom <String>)]] <String>) (<SchemaName>.<FieldName> [multivalued|multivalue|value|multinonempty [type work|home|other|(custom <String>)]] <String>)
gam version [check] [simple] gam version [check] [simple]
gam help gam help
@@ -518,7 +522,7 @@ You can make substitutions in <GAMArgumentList> with values from the CSV file.
An argument containing exactly ~xxx is replaced by the value of field xxx from the CSV file An argument containing exactly ~xxx is replaced by the value of field xxx from the CSV file
An argument containing instances of ~~xxx~~ has xxx replaced by the value of field xxx from the CSV file An argument containing instances of ~~xxx~~ has xxx replaced by the value of field xxx from the CSV file
Example: gam csv Users.csv gam update user '~primaryEmail' address type work unstructured '~~Street~~, ~~City~~, ~~State~~ ~~ZIP~~' Example: gam csv Users.csv gam update user "~primaryEmail" address type work unstructured "~~Street~~, ~~City~~, ~~State~~ ~~ZIP~~"
Each user (~primaryEmail, e.g. foo@bar.com) would have their work address updated Each user (~primaryEmail, e.g. foo@bar.com) would have their work address updated
gam create project [<EmailAddress>] gam create project [<EmailAddress>]
@@ -541,9 +545,9 @@ gam update resoldcustomer <CustomerID> [customer_auth_token <String>]
[locality|city <String>] [region|state <String>] [postal|postal_code <String>] [country|country_code <String>] [locality|city <String>] [region|state <String>] [postal|postal_code <String>] [country|country_code <String>]
gam info resoldcustomer <CustomerID> gam info resoldcustomer <CustomerID>
gam create resoldsubscription <CustomerID> gam create resoldsubscription <CustomerID> (sku <SKUID>)
[customer_auth_token <String>] [plan annual_monthly_pay|annual_yearly_pay|flexible|trial] (plan annual_monthly_pay|annual_yearly_pay|flexible|trial) (seats <NumberOfSeats> <MaximumNumberOfSeats>)
[deal <String>] [purchaseorderid <String>] [seats <NumberOfSeats> <MaximumNumberOfSeats>] [sku <SKUID>] [customer_auth_token <String>] [deal <String>] [purchaseorderid <String>]
gam update resoldsubscription <CustomerID> <SKUID> gam update resoldsubscription <CustomerID> <SKUID>
activate|suspend|startpaidservice| activate|suspend|startpaidservice|
(renewal auto_renew_monthly_pay|auto_renew_yearly_pay|cancel|renew_current_users_monthly_pay|renew_current_users_yearly_pay|switch_to_pay_as_you_go)| (renewal auto_renew_monthly_pay|auto_renew_yearly_pay|cancel|renew_current_users_monthly_pay|renew_current_users_yearly_pay|switch_to_pay_as_you_go)|
@@ -684,7 +688,7 @@ gam info user [<UserItem>] [noaliases] [nogroups] [nolicenses|nolicences] [nosch
gam print users [todrive] ([domain <DomainName>] [query <QueryUser>] [deleted_only|only_deleted]) gam print users [todrive] ([domain <DomainName>] [query <QueryUser>] [deleted_only|only_deleted])
[groups] [license|licenses|licence|licences] [emailpart|emailparts|username] [groups] [license|licenses|licence|licences] [emailpart|emailparts|username]
[orderby <UserOrderByFieldName> [ascending|descending]] [userview] [orderby <UserOrderByFieldName> [ascending|descending]] [userview]
[basic|full|allfields | <UserFieldName>* | fields <UserFieldNameList>] [schemas|custom all|<SchemaNameList>] [allfields|basic|full | ((<UserFieldName>* | fields <UserFieldNameList>) [schemas|custom all|<SchemaNameList>])]
gam <UserTypeEntity> print gam <UserTypeEntity> print
Summary of printing: Summary of printing:
@@ -870,6 +874,12 @@ gam <UserTypeEntity> print smime [todrive] [primaryonly]
gam <UserTypeEntity> signature|sig <String>|(file <FileName> [charset <Charset>]) (replace <Tag> <String>)* [html] [name <String>] [replyto <EmailAddress>] [default] [treatasalias <Boolean>] gam <UserTypeEntity> signature|sig <String>|(file <FileName> [charset <Charset>]) (replace <Tag> <String>)* [html] [name <String>] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
gam <UserTypeEntity> show signature|sig [format] gam <UserTypeEntity> show signature|sig [format]
gam <UserTypeEntity> add teamdrive <Name>
gam <UserTypeEntity> update teamdrive <TeamDriveID> [name <Name>]
gam <UserTypeEntity> delete teamdrive <TeamDriveID>
gam <UserTypeEntity> show teamdrives
gam <UserTypeEntity> print teamdrives [todrive]
gam <UserTypeEntity> vacation <FalseValues> gam <UserTypeEntity> vacation <FalseValues>
gam <UserTypeEntity> vacation <TrueValues> subject <String> (message <String>)|(file <FileName> [charset <CharSet>]) (replace <Tag> <String>)* [html] gam <UserTypeEntity> vacation <TrueValues> subject <String> (message <String>)|(file <FileName> [charset <CharSet>]) (replace <Tag> <String>)* [html]
[contactsonly] [domainonly] [startdate <Date>] [enddate <Date>] [contactsonly] [domainonly] [startdate <Date>] [enddate <Date>]