mirror of
https://github.com/GAM-team/GAM.git
synced 2026-07-03 12:21:35 +00:00
Documentation updates
This commit is contained in:
@@ -26,6 +26,7 @@
|
|||||||
<EmailAddress> ::= <String>@<DomainName>
|
<EmailAddress> ::= <String>@<DomainName>
|
||||||
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
||||||
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
```
|
```
|
||||||
## Create an alias for a target
|
## Create an alias for a target
|
||||||
|
|||||||
@@ -161,6 +161,7 @@ gam oauth update
|
|||||||
<ProjectIDEntity> ::=
|
<ProjectIDEntity> ::=
|
||||||
current | gam | <ProjectID> | (filter <String>) |
|
current | gam | <ProjectID> | (filter <String>) |
|
||||||
(select <ProjectIDList> | <FileSelector> | <CSVFileSelector>)
|
(select <ProjectIDList> | <FileSelector> | <CSVFileSelector>)
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<ProjectName> ::= <String>
|
<ProjectName> ::= <String>
|
||||||
Must match this Python Regular Expression: [a-zA-Z0-9 '"!-]{4,30}
|
Must match this Python Regular Expression: [a-zA-Z0-9 '"!-]{4,30}
|
||||||
<ServiceAccountName> ::= <String>
|
<ServiceAccountName> ::= <String>
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ Calendar ACL roles (as seen in Calendar GUI):
|
|||||||
<CalendarItem> ::= <EmailAddress>
|
<CalendarItem> ::= <EmailAddress>
|
||||||
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
||||||
<CalendarEntity> ::= <CalendarList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<CalendarEntity> ::= <CalendarList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<CalendarACLRole> ::= editor|freebusy|freebusyreader|owner|reader|writer
|
<CalendarACLRole> ::= editor|freebusy|freebusyreader|owner|reader|writer
|
||||||
<CalendarACLScope> ::= <EmailAddress>|user:<EmailAdress>|group:<EmailAddress>|domain:<DomainName>|domain|default
|
<CalendarACLScope> ::= <EmailAddress>|user:<EmailAdress>|group:<EmailAddress>|domain:<DomainName>|domain|default
|
||||||
|
|||||||
@@ -63,10 +63,12 @@ Client access works when accessing Resource calendars.
|
|||||||
<CalendarItem> ::= <EmailAddress>
|
<CalendarItem> ::= <EmailAddress>
|
||||||
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
||||||
<CalendarEntity> ::= <CalendarList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<CalendarEntity> ::= <CalendarList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<DomainName> ::= <String>(.<String>)+
|
<DomainName> ::= <String>(.<String>)+
|
||||||
<EmailAddress> ::= <String>@<DomainName>
|
<EmailAddress> ::= <String>@<DomainName>
|
||||||
<EmailAddressList> ::= "<EmailAddess>(,<EmailAddress>)*"
|
<EmailAddressList> ::= "<EmailAddess>(,<EmailAddress>)*"
|
||||||
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<EventAttachmentsSubfieldName> ::=
|
<EventAttachmentsSubfieldName> ::=
|
||||||
attachments.fileid|
|
attachments.fileid|
|
||||||
@@ -192,6 +194,7 @@ Client access works when accessing Resource calendars.
|
|||||||
(id|eventid <EventId>) |
|
(id|eventid <EventId>) |
|
||||||
(event|events <EventIdList> |
|
(event|events <EventIdList> |
|
||||||
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<EventSelectEntity> ::=
|
<EventSelectEntity> ::=
|
||||||
(<EventSelectProperty>+ <EventMatchProperty>*)
|
(<EventSelectProperty>+ <EventMatchProperty>*)
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ Client access works when accessing Resource calendars.
|
|||||||
<CalendarItem> ::= <EmailAddress>
|
<CalendarItem> ::= <EmailAddress>
|
||||||
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
||||||
<CalendarEntity> ::= <CalendarList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<CalendarEntity> ::= <CalendarList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<TimeZone> ::= <String>
|
<TimeZone> ::= <String>
|
||||||
See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||||
|
|||||||
@@ -41,6 +41,7 @@
|
|||||||
(query:<QueryBrowser>)|(query:orgunitpath:<OrgUnitPath>)|(query <QueryBrowser>) |
|
(query:<QueryBrowser>)|(query:orgunitpath:<OrgUnitPath>)|(query <QueryBrowser>) |
|
||||||
(browserou <OrgUnitItem>) | (browserous <OrgUnitList>) |
|
(browserou <OrgUnitItem>) | (browserous <OrgUnitList>) |
|
||||||
<FileSelector> | <CSVFileSelector>
|
<FileSelector> | <CSVFileSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<BrowserAttribute> ::=
|
<BrowserAttribute> ::=
|
||||||
(annotatedassetid|asset|assetid <String>)|
|
(annotatedassetid|asset|assetid <String>)|
|
||||||
|
|||||||
@@ -85,6 +85,7 @@ The second form is backwards compatible with Standard GAM and selection with `<C
|
|||||||
<SerialNumberList> ::= "<SerialNumber>(,<SerialNumber>)*"
|
<SerialNumberList> ::= "<SerialNumber>(,<SerialNumber>)*"
|
||||||
<SerialNumberEntity> ::=
|
<SerialNumberEntity> ::=
|
||||||
<SerialNumberList> | <FileSelector> | <CSVFileSelector>
|
<SerialNumberList> | <FileSelector> | <CSVFileSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<CrOSEntity> ::=
|
<CrOSEntity> ::=
|
||||||
<CrOSIDList> | (cros_sn <SerialNumberList>) |
|
<CrOSIDList> | (cros_sn <SerialNumberList>) |
|
||||||
|
|||||||
@@ -47,40 +47,50 @@ gam user user@domain.com check|update serviceaccount
|
|||||||
<CourseAliasList> ::= "<CourseAlias>(,<CourseAlias>)*"
|
<CourseAliasList> ::= "<CourseAlias>(,<CourseAlias>)*"
|
||||||
<CourseAliasEntity> ::=
|
<CourseAliasEntity> ::=
|
||||||
<CourseAliasList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<CourseAliasList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseAnnouncementID> ::= <Number>
|
<CourseAnnouncementID> ::= <Number>
|
||||||
<CourseAnnouncementIDList> ::= "<CourseAnnouncementID>(,<CourseAnnouncementID>)*"
|
<CourseAnnouncementIDList> ::= "<CourseAnnouncementID>(,<CourseAnnouncementID>)*"
|
||||||
<CourseAnnouncementIDEntity> ::=
|
<CourseAnnouncementIDEntity> ::=
|
||||||
<CourseAnnouncementIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVSubkeySelector>|<CSVDataSelector>
|
<CourseAnnouncementIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVSubkeySelector>|<CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseAnnouncementState> ::= draft|published|deleted
|
<CourseAnnouncementState> ::= draft|published|deleted
|
||||||
<CourseAnnouncementStateList> ::= all|"<CourseAnnouncementState>(,<CourseAnnouncementState>)*"
|
<CourseAnnouncementStateList> ::= all|"<CourseAnnouncementState>(,<CourseAnnouncementState>)*"
|
||||||
<CourseID> ::= <Number>|d:<CourseAlias>
|
<CourseID> ::= <Number>|d:<CourseAlias>
|
||||||
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
||||||
<CourseEntity> ::=
|
<CourseEntity> ::=
|
||||||
<CourseIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>
|
<CourseIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseMaterialID> ::= <Number>
|
<CourseMaterialID> ::= <Number>
|
||||||
<CourseMaterialIDList> ::= "<CourseMaterialID>(,<CourseMaterialID>)*"
|
<CourseMaterialIDList> ::= "<CourseMaterialID>(,<CourseMaterialID>)*"
|
||||||
<CourseMaterialState> ::= draft|published|deleted
|
<CourseMaterialState> ::= draft|published|deleted
|
||||||
<CourseMaterialStateList> ::= all|"<CourseMaterialState>(,<CourseMaterialState>)*"
|
<CourseMaterialStateList> ::= all|"<CourseMaterialState>(,<CourseMaterialState>)*"
|
||||||
<CourseMaterialIDEntity> ::= <CourseMaterialIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>
|
<CourseMaterialIDEntity> ::=
|
||||||
|
<CourseMaterialIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseState> ::= active|archived|provisioned|declined|suspended
|
<CourseState> ::= active|archived|provisioned|declined|suspended
|
||||||
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
||||||
<CourseSubmissionID> ::= <Number>
|
<CourseSubmissionID> ::= <Number>
|
||||||
<CourseSubmissionIDList> ::= "<CourseSubmissionID>(,<CourseSubmissionID>)*"
|
<CourseSubmissionIDList> ::= "<CourseSubmissionID>(,<CourseSubmissionID>)*"
|
||||||
<CourseSubmissionIDEntity> ::=
|
<CourseSubmissionIDEntity> ::=
|
||||||
<CourseSubmissionIDList>|<FileSelector>|<CSVFileSelector>|<CSVDataSelector>
|
<CourseSubmissionIDList>|<FileSelector>|<CSVFileSelector>|<CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseSubmissionState> ::= new|created|turned_in|returned|reclaimed_by_student
|
<CourseSubmissionState> ::= new|created|turned_in|returned|reclaimed_by_student
|
||||||
<CourseSubmissionStateList> ::= all|"<CourseSubmissionState>(,<CourseSubmissionState>)*"
|
<CourseSubmissionStateList> ::= all|"<CourseSubmissionState>(,<CourseSubmissionState>)*"
|
||||||
<CourseTopic> ::= <String>
|
<CourseTopic> ::= <String>
|
||||||
<CourseTopicList> ::= "<CourseTopic>(,<CourseTopic>)*"
|
<CourseTopicList> ::= "<CourseTopic>(,<CourseTopic>)*"
|
||||||
<CourseTopicEntity> ::= <CourseTopicList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<CourseTopicEntity> ::=
|
||||||
|
<CourseTopicList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseTopicID> ::= <Number>
|
<CourseTopicID> ::= <Number>
|
||||||
<CourseTopicIDList> ::= "<CourseTopicID>(,<CourseTopicID>)*"
|
<CourseTopicIDList> ::= "<CourseTopicID>(,<CourseTopicID>)*"
|
||||||
<CourseTopicIDEntity> ::=
|
<CourseTopicIDEntity> ::=
|
||||||
<CourseTopicIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVSubkeySelector>|<CSVDataSelector>
|
<CourseTopicIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVSubkeySelector>|<CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseWorkID> ::= <Number>
|
<CourseWorkID> ::= <Number>
|
||||||
<CourseWorkIDList> ::= "<CourseWorkID>(,<CourseWorkID>)*"
|
<CourseWorkIDList> ::= "<CourseWorkID>(,<CourseWorkID>)*"
|
||||||
<CourseWorkIDEntity> ::=
|
<CourseWorkIDEntity> ::=
|
||||||
<CourseWorkIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVSubkeySelector>|<CSVDataSelector>
|
<CourseWorkIDList>|<FileSelector>|<CSVFileSelector>|<CSVkmdSelector>|<CSVSubkeySelector>|<CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseWorkState> ::= draft|published|deleted
|
<CourseWorkState> ::= draft|published|deleted
|
||||||
<CourseWorkStateList> ::= all|"<CourseWorkState>(,<CourseWorkState>)*"
|
<CourseWorkStateList> ::= all|"<CourseWorkState>(,<CourseWorkState>)*"
|
||||||
|
|
||||||
|
|||||||
@@ -20,11 +20,15 @@
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<GuardianItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<GuardianItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GuardianItemList> ::= "<GuardianItem>(,<GuardianItem>)*"
|
<GuardianItemList> ::= "<GuardianItem>(,<GuardianItem>)*"
|
||||||
<GuardianEntity> ::= <GuardianList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<GuardianEntity> ::=
|
||||||
|
<GuardianList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<StudentItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<StudentItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GuardianInvitationID> ::= <String>
|
<GuardianInvitationID> ::= <String>
|
||||||
<GuardianInvitationIDList> ::= "<GuardianInvitationId>(,<GuardianInvitationID>)*"
|
<GuardianInvitationIDList> ::= "<GuardianInvitationId>(,<GuardianInvitationID>)*"
|
||||||
<GuardianInvitationIDEntity> ::= <GuardianInvitationIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<GuardianInvitationIDEntity> ::=
|
||||||
|
<GuardianInvitationIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GuardianState> ::= complete|pending
|
<GuardianState> ::= complete|pending
|
||||||
<GuardianStateList> ::= "<GuardianState>(,<GuardianState>)*"
|
<GuardianStateList> ::= "<GuardianState>(,<GuardianState>)*"
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -33,11 +33,15 @@ The Classroom API does not support inviting users from outside your domain.
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<ClassroomInvitationID> ::= <String>
|
<ClassroomInvitationID> ::= <String>
|
||||||
<ClassroomInvitationIDList> ::= "<ClassroomInvitationID>(,<ClassroomInvitationID>)*"
|
<ClassroomInvitationIDList> ::= "<ClassroomInvitationID>(,<ClassroomInvitationID>)*"
|
||||||
<ClassroomInvitationIDEntity> ::= <ClassroomInvitationIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<ClassroomInvitationIDEntity> ::=
|
||||||
|
<ClassroomInvitationIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseAlias> ::= <String>
|
<CourseAlias> ::= <String>
|
||||||
<CourseID> ::= <Number>|d:<CourseAlias>
|
<CourseID> ::= <Number>|d:<CourseAlias>
|
||||||
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
||||||
<CourseEntity> ::= <CourseIDList> | <FileSelector> | <CSVFileSelector | <CSVkmdSelector>
|
<CourseEntity> ::=
|
||||||
|
<CourseIDList> | <FileSelector> | <CSVFileSelector | <CSVkmdSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseState> ::= active|archived|provisioned|declined|suspended
|
<CourseState> ::= active|archived|provisioned|declined|suspended
|
||||||
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -22,7 +22,9 @@
|
|||||||
<CourseAlias> ::= <String>
|
<CourseAlias> ::= <String>
|
||||||
<CourseID> ::= <Number>|d:<CourseAlias>
|
<CourseID> ::= <Number>|d:<CourseAlias>
|
||||||
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
||||||
<CourseEntity> ::= <CourseIDList> | <FileSelector> | <CSVFileSelector | <CSVkmdSelector>
|
<CourseEntity> ::=
|
||||||
|
<CourseIDList> | <FileSelector> | <CSVFileSelector | <CSVkmdSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CourseState> ::= active|archived|provisioned|declined|suspended
|
<CourseState> ::= active|archived|provisioned|declined|suspended
|
||||||
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -61,7 +61,9 @@ and Cloud Identity Premium accounts. Unfortunately, even if you have the require
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<GroupItem> ::= <EmailAddress>|<UniqueID>|groups/<String>
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|groups/<String>
|
||||||
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
||||||
<GroupEntity> ::= <GroupList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<GroupEntity> ::=
|
||||||
|
<GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GroupRole> ::= owner|manager|member
|
<GroupRole> ::= owner|manager|member
|
||||||
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
||||||
<CIGroupType> ::= customer|group|other|serviceaccount|user
|
<CIGroupType> ::= customer|group|other|serviceaccount|user
|
||||||
|
|||||||
@@ -57,7 +57,9 @@ and Cloud Identity Premium accounts. Unfortunately, even if you have the require
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
||||||
<GroupEntity> ::= <GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<GroupEntity> ::=
|
||||||
|
<GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GroupRole> ::= owner|manager|member
|
<GroupRole> ::= owner|manager|member
|
||||||
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
||||||
<CIGroupType> ::= customer|group|other|serviceaccount|user
|
<CIGroupType> ::= customer|group|other|serviceaccount|user
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<PeopleResourceNameList> ::= "<PeopleResourceName>(,<PeopleResourceName>)*"
|
<PeopleResourceNameList> ::= "<PeopleResourceName>(,<PeopleResourceName>)*"
|
||||||
<PeopleResourceNameEntity> ::=
|
<PeopleResourceNameEntity> ::=
|
||||||
<PeopleResourceNameNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
<PeopleResourceNameNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<PeopleSourceName> ::=
|
<PeopleSourceName> ::=
|
||||||
contact|contacts|
|
contact|contacts|
|
||||||
|
|||||||
@@ -55,6 +55,7 @@
|
|||||||
<ContactIDList> ::= "<ContactID>(,<ContactID>)*"
|
<ContactIDList> ::= "<ContactID>(,<ContactID>)*"
|
||||||
<ContactEntity> ::=
|
<ContactEntity> ::=
|
||||||
<ContactIDList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<ContactIDList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<ContactSelection> ::=
|
<ContactSelection> ::=
|
||||||
[query <QueryContact>]
|
[query <QueryContact>]
|
||||||
[emailmatchpattern <RegularExpression> [emailmatchtype work|home|other|<String>]]
|
[emailmatchpattern <RegularExpression> [emailmatchtype work|home|other|<String>]]
|
||||||
@@ -207,6 +208,7 @@ You specify contacts by ID or by selection qualifiers.
|
|||||||
<ContactIDList> ::= "<ContactID>(,<ContactID>)*"
|
<ContactIDList> ::= "<ContactID>(,<ContactID>)*"
|
||||||
<ContactEntity> ::=
|
<ContactEntity> ::=
|
||||||
<ContactIDList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<ContactIDList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<ContactSelection> ::=
|
<ContactSelection> ::=
|
||||||
[query <QueryContact>]
|
[query <QueryContact>]
|
||||||
[emailmatchpattern <RegularExpression> [emailmatchtype work|home|other|<String>]]
|
[emailmatchpattern <RegularExpression> [emailmatchtype work|home|other|<String>]]
|
||||||
|
|||||||
@@ -304,6 +304,7 @@ You can select a list of file IDs by referencing files that contain file IDs.
|
|||||||
```
|
```
|
||||||
<DriveFileEntity> ::=
|
<DriveFileEntity> ::=
|
||||||
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector>) | <CSVDataSelector>)
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector>) | <CSVDataSelector>)
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
```
|
```
|
||||||
* [Collections of Items](Collections-of-Items)
|
* [Collections of Items](Collections-of-Items)
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Groups - Membership
|
Groups - Membership
|
||||||
- [API documentation](#api-documentation)
|
- [API documentation](#api-documentation)
|
||||||
- [Python Regular Expressions](Python-Regular-Expressions) Match function
|
- [Python Regular Expressions](Python-Regular-Expressions) Match function
|
||||||
- [Definitions](#definitions)
|
- [Definitions](#definitions)
|
||||||
@@ -32,7 +32,9 @@
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
||||||
<GroupEntity> ::= <GroupList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<GroupEntity> ::=
|
||||||
|
<GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GroupRole> ::= owner|manager|member
|
<GroupRole> ::= owner|manager|member
|
||||||
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
||||||
<GroupType> ::= customer|group|user
|
<GroupType> ::= customer|group|user
|
||||||
|
|||||||
@@ -51,7 +51,9 @@
|
|||||||
<EmailItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<EmailItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
||||||
<GroupEntity> ::= <GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<GroupEntity> ::=
|
||||||
|
<GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GroupRole> ::= owner|manager|member
|
<GroupRole> ::= owner|manager|member
|
||||||
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
||||||
<GroupType> ::= customer|group|user
|
<GroupType> ::= customer|group|user
|
||||||
|
|||||||
70
docs/Home.md
Normal file
70
docs/Home.md
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
- [Introduction](#introduction)
|
||||||
|
- [Requirements](#requirements)
|
||||||
|
- [Installation - First time GAM installation](#installation---first-time-gam-installation)
|
||||||
|
- [Installation - Upgrading from a GAM version other than a prior version of GAMADV-X or GAMADV-XTD or GAMADV-XTD3](#installation---upgrading-from-a-gam-version-other-than-a-prior-version-of-gamadv-x-or-gamadv-xtd-or-gamadv-xtd3)
|
||||||
|
- [Installation - Upgrading from a prior version of GAMADV-X or GAMADV-XTD or GAMADV-XTD3](#installation---upgrading-from-a-prior-version-of-gamadv-x-or-gamadv-xtd-or-gamadv-xtd3)
|
||||||
|
|
||||||
|
# Introduction
|
||||||
|
GAMADV-XTD3 is a free, open source command line tool for Google Workspace Administrators to manage domain and user settings quickly and easily.
|
||||||
|
|
||||||
|
GAMADV-XTD3 is built with Python 3; as Python 2 support ends on 2020-01-01, this is the version of Advanced GAM that new/existing users should install.
|
||||||
|
|
||||||
|
This page provides simple instructions for downloading, installing and starting to use GAMADV-XTD3.
|
||||||
|
|
||||||
|
GAMADV-XTD3 requires paid, or Education/Non-profit, editions of Google Workspace. G Suite Legacy Free Edition has limited API support and not all GAM commands work.
|
||||||
|
|
||||||
|
GAMADV-XTD3 is a rewrite/extension of Jay Lee's [GAM], without his efforts, this version wouldn't exist.
|
||||||
|
|
||||||
|
GAMADV-XTD3 is backwards compatible with [GAM], meaning that if your command works with regular GAM, it will also work with GAMADV-XTD3. There may be differences in output, but the syntax is compatible.
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
Basic GAM documentation is hosted in the [GitHub Wiki]. Documentation specifically for GAMADV-XTD3 is hosted in the [GitHub GAMADV-XTD3 Wiki] and in Gam*.txt files.
|
||||||
|
|
||||||
|
# Mailing List / Discussion group
|
||||||
|
The GAM mailing list / discussion group is hosted on [Google Groups]. You can join the list and interact via email, or just post from the web itself.
|
||||||
|
|
||||||
|
# Source Repository
|
||||||
|
The official GAMADV-XTD3 source repository is on [GitHub] in the master branch.
|
||||||
|
|
||||||
|
# Author
|
||||||
|
GAMADV-XTD3 is maintained by <a href="mailto:ross.scroggs@gmail.com">Ross Scroggs</a>.
|
||||||
|
|
||||||
|
# Requirements
|
||||||
|
To run all commands properly, GAMADV-XTD3 requires three things:
|
||||||
|
* An API project which identifies your install of GAMADV-XTD3 to Google and keeps track of API quotas.
|
||||||
|
* Authorization to act as your Google Workspace Administrator in order to perform management functions like add users, modify group settings and membership and pull domain reports.
|
||||||
|
* A special service account that is authorized to act on behalf of your users in order to modify user-specific settings and data such as Drive files, Calendars and Gmail messages and settings like signatures.
|
||||||
|
|
||||||
|
# Installation - First time GAM installation
|
||||||
|
Use these steps if you have never used any version of GAM in your domain. They will create a GAM project
|
||||||
|
and all necessary authentications.
|
||||||
|
|
||||||
|
* Download: [Downloads](Downloads)
|
||||||
|
* Configuration: [GAM Configuration](gam.cfg)
|
||||||
|
* Install: [How to Install Advanced GAM](How-to-Install-Advanced-GAM)
|
||||||
|
|
||||||
|
# Installation - Upgrading from a GAM version other than a prior version of GAMADV-X or GAMADV-XTD or GAMADV-XTD3
|
||||||
|
Use these steps if you have used any version of GAM in your domain. They will update your GAM project
|
||||||
|
and all necessary authentications.
|
||||||
|
|
||||||
|
* Download: [Downloads](Downloads)
|
||||||
|
* Configuration: [GAM Configuration](gam.cfg)
|
||||||
|
* Upgrade: [How to Upgrade from Standard GAM](How-to-Upgrade-from-Standard-GAM)
|
||||||
|
|
||||||
|
# Installation - Upgrading from a prior version of GAMADV-X or GAMADV-XTD or GAMADV-XTD3
|
||||||
|
Use these steps if you already use GAMADV-X or GAMADV-XTD or GAMADV-XTD3. The updates may tell you to update your GAM project
|
||||||
|
or authentications because new features have been included.
|
||||||
|
|
||||||
|
* Updates: [GAM Updates]
|
||||||
|
* Download: [Downloads](Downloads)
|
||||||
|
|
||||||
|
You can install multiple versions of GAM and GAMADV-XTD3 in different parallel directories.
|
||||||
|
|
||||||
|
[GAM]: https://github.com/GAM-team/GAM
|
||||||
|
[GitHub Releases]: https://github.com/taers232c/GAMADV-XTD3/releases
|
||||||
|
[GitHub]: https://github.com/taers232c/GAMADV-XTD3/tree/master
|
||||||
|
[GitHub Wiki]: https://github.com/GAM-team/GAM/wiki/
|
||||||
|
[GitHub GAMADV-XTD3 Wiki]: https://github.com/taers232c/GAMADV-XTD3/wiki/
|
||||||
|
[Google Groups]: https://groups.google.com/group/google-apps-manager
|
||||||
|
[GAM Updates]: https://github.com/taers232c/GAMADV-XTD3/wiki/GamUpdates
|
||||||
|
|
||||||
@@ -50,7 +50,9 @@ See [Collections of Items](Collections-of-Items)
|
|||||||
<FeatureNameList> ::= "'<FeatureName>'(,'<FeatureName>')*"
|
<FeatureNameList> ::= "'<FeatureName>'(,'<FeatureName>')*"
|
||||||
<ResourceID> ::= <String>
|
<ResourceID> ::= <String>
|
||||||
<ResourceIDList> ::= "<ResourceID>(,<ResourceID>)*"
|
<ResourceIDList> ::= "<ResourceID>(,<ResourceID>)*"
|
||||||
<ResourceEntity> ::= <ResourceIDList> | <FileSelector> | <CSVkmdSelector>
|
<ResourceEntity> ::=
|
||||||
|
<ResourceIDList> | <FileSelector> | <CSVkmdSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<BuildingFieldName> ::=
|
<BuildingFieldName> ::=
|
||||||
address|
|
address|
|
||||||
|
|||||||
@@ -12,7 +12,9 @@
|
|||||||
<SchemaName> ::= <String>
|
<SchemaName> ::= <String>
|
||||||
<FieldName> ::= <String>
|
<FieldName> ::= <String>
|
||||||
<SchemaNameList> ::= "<SchemaName>(,<SchemaName>)*"
|
<SchemaNameList> ::= "<SchemaName>(,<SchemaName>)*"
|
||||||
<SchemaEntity> ::= <SchemaNameList> | <FileSelector> | <CSVkmdSelector>
|
<SchemaEntity> ::=
|
||||||
|
<SchemaNameList> | <FileSelector> | <CSVkmdSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<SchemaFieldDefinition> ::=
|
<SchemaFieldDefinition> ::=
|
||||||
field <FieldName> [displayname <String>]
|
field <FieldName> [displayname <String>]
|
||||||
|
|||||||
@@ -33,7 +33,9 @@ Added the option `mailbox <EmailAddress>` to `gam sendemail` to allow specifying
|
|||||||
<String>@<DomainName> |
|
<String>@<DomainName> |
|
||||||
<String> <<String>@<DomainName>> # The outer <> around <String>@<DomainName> are literal, e.g., IT Group<group@domain.com>
|
<String> <<String>@<DomainName>> # The outer <> around <String>@<DomainName> are literal, e.g., IT Group<group@domain.com>
|
||||||
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
||||||
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVkmdSelector>
|
<EmailAddressEntity> ::=
|
||||||
|
<EmailAddressList> | <FileSelector> | <CSVkmdSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users
|
||||||
<RecipientEntity> ::= <EmailAddressEntity> | (select <UserTypeEntity>)
|
<RecipientEntity> ::= <EmailAddressEntity> | (select <UserTypeEntity>)
|
||||||
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
|
|
||||||
|
|||||||
@@ -89,17 +89,14 @@
|
|||||||
<DriveFilePermissionEntity> ::=
|
<DriveFilePermissionEntity> ::=
|
||||||
<DriveFilePermissionList> |
|
<DriveFilePermissionList> |
|
||||||
<JSONData> |
|
<JSONData> |
|
||||||
<FileSelector> |
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
<CSVFileSelector> |
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CSVkmdSelector> |
|
|
||||||
<CSVDataSelector>
|
|
||||||
<DriveFilePermissionIDEntity> ::=
|
<DriveFilePermissionIDEntity> ::=
|
||||||
<DriveFilePermissionIDList> |
|
<DriveFilePermissionIDList> |
|
||||||
<JSONData> |
|
<JSONData> |
|
||||||
<FileSelector> |
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
<CSVFileSelector> |
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CSVkmdSelector> |
|
|
||||||
<CSVDataSelector>
|
|
||||||
|
|
||||||
<DrivePermissionsFieldName> ::=
|
<DrivePermissionsFieldName> ::=
|
||||||
additionalroles|
|
additionalroles|
|
||||||
|
|||||||
@@ -21,12 +21,14 @@
|
|||||||
<DomainNameList> ::= "<DomainName>(,<DomainName>)*"
|
<DomainNameList> ::= "<DomainName>(,<DomainName>)*"
|
||||||
<DomainNameEntity> ::=
|
<DomainNameEntity> ::=
|
||||||
<DomainNameList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<DomainNameList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<SiteName> ::= [a-z,0-9,-]+
|
<SiteName> ::= [a-z,0-9,-]+
|
||||||
<SiteItem> ::= [<DomainName>/]<SiteName>
|
<SiteItem> ::= [<DomainName>/]<SiteName>
|
||||||
<SiteList> ::= "<SiteItem>(,<SiteItem>)*"
|
<SiteList> ::= "<SiteItem>(,<SiteItem>)*"
|
||||||
<SiteEntity> ::=
|
<SiteEntity> ::=
|
||||||
<SiteList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<SiteList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<SiteACLRole> ::= editor|owner|reader|writer
|
<SiteACLRole> ::= editor|owner|reader|writer
|
||||||
<SiteACLRoleList> ::= "<SiteACLRole>(,<SiteACLRole>)*"
|
<SiteACLRoleList> ::= "<SiteACLRole>(,<SiteACLRole>)*"
|
||||||
@@ -44,6 +46,7 @@
|
|||||||
<SiteACLScopeList> ::= "<SiteACLScope>(,<SiteACLScope>)*"
|
<SiteACLScopeList> ::= "<SiteACLScope>(,<SiteACLScope>)*"
|
||||||
<SiteACLScopeEntity> ::=
|
<SiteACLScopeEntity> ::=
|
||||||
<SiteACLScopeList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<SiteACLScopeList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
```
|
```
|
||||||
## Manage classic sites
|
## Manage classic sites
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
|
|
||||||
## API documentation
|
## API documentation
|
||||||
* https://support.google.com/a/answer/6178640
|
* https://support.google.com/a/answer/6178640
|
||||||
|
* https://support.google.com/a/answer/11112794
|
||||||
* https://cloud.google.com/identity/docs/how-to/manage-user-invitations
|
* https://cloud.google.com/identity/docs/how-to/manage-user-invitations
|
||||||
* https://cloud.google.com/identity/docs/reference/rest/v1beta1/customers.userinvitations
|
* https://cloud.google.com/identity/docs/reference/rest/v1beta1/customers.userinvitations
|
||||||
|
|
||||||
|
|||||||
@@ -96,6 +96,7 @@
|
|||||||
<EmailAddressEntity> ::=
|
<EmailAddressEntity> ::=
|
||||||
<EmailAddressList> | <FileSelector> | <CSVFileSelector> |
|
<EmailAddressList> | <FileSelector> | <CSVFileSelector> |
|
||||||
<CSVkmdSelector> | <CSVDataSelector>
|
<CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users
|
||||||
<CalendarItem> ::= <EmailAddress>
|
<CalendarItem> ::= <EmailAddress>
|
||||||
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
||||||
<CourseAlias> ::= <String>
|
<CourseAlias> ::= <String>
|
||||||
@@ -259,7 +260,7 @@
|
|||||||
(id|eventid <EventId>) |
|
(id|eventid <EventId>) |
|
||||||
(event|events <EventIdList> |
|
(event|events <EventIdList> |
|
||||||
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<EventSelectEntity> ::=
|
<EventSelectEntity> ::=
|
||||||
(<EventSelectProperty>+ <EventMatchProperty>*)
|
(<EventSelectProperty>+ <EventMatchProperty>*)
|
||||||
|
|
||||||
|
|||||||
@@ -56,6 +56,7 @@
|
|||||||
(resources <ResourceIDList>)|
|
(resources <ResourceIDList>)|
|
||||||
((calendars <CalendarList>) | <FileSelector> | <CSVFileSelector> |
|
((calendars <CalendarList>) | <FileSelector> | <CSVFileSelector> |
|
||||||
<CSVkmdSelector> | <CSVDataSelector>)
|
<CSVkmdSelector> | <CSVDataSelector>)
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<UserCalendarEntity> ::=
|
<UserCalendarEntity> ::=
|
||||||
allcalendars|
|
allcalendars|
|
||||||
@@ -72,6 +73,7 @@
|
|||||||
((calendars <CalendarList>) | <FileSelector> | <CSVFileSelector> |
|
((calendars <CalendarList>) | <FileSelector> | <CSVFileSelector> |
|
||||||
<CSVkmdSelector> | <CSVDataSelector>)|
|
<CSVkmdSelector> | <CSVDataSelector>)|
|
||||||
<CalendarSelectProperty>*
|
<CalendarSelectProperty>*
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<UserCalendarSettingsField> ::=
|
<UserCalendarSettingsField> ::=
|
||||||
autoaddhangouts|
|
autoaddhangouts|
|
||||||
|
|||||||
@@ -24,7 +24,9 @@ Contact delegation must be enabled, see the following:
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<UserList> ::= "<UserItem>(,<UserItem>)*"
|
<UserList> ::= "<UserItem>(,<UserItem>)*"
|
||||||
<UserEntity> ::= <UserList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<UserEntity> ::=
|
||||||
|
<UserList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users
|
||||||
```
|
```
|
||||||
## Create contact delegates
|
## Create contact delegates
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<DataStudioAssetIDList> ::= "<DataStudioAssetID>(,<DataStudioAssetID>)*"
|
<DataStudioAssetIDList> ::= "<DataStudioAssetID>(,<DataStudioAssetID>)*"
|
||||||
<DataStudioAssetIDEntity> ::=
|
<DataStudioAssetIDEntity> ::=
|
||||||
<DataStudioAssetIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<DataStudioAssetIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<DataStudioPermission> ::=
|
<DataStudioPermission> ::=
|
||||||
user:<EmailAddress>|
|
user:<EmailAddress>|
|
||||||
@@ -40,6 +41,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<DataStudioPermissionList> ::= "<DataStudioPermission>(,<DataStudioPermission>)*"
|
<DataStudioPermissionList> ::= "<DataStudioPermission>(,<DataStudioPermission>)*"
|
||||||
<DataStudioPermissionEntity> ::=
|
<DataStudioPermissionEntity> ::=
|
||||||
<DataStudioPermissionList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<DataStudioPermissionList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
```
|
```
|
||||||
|
|
||||||
Data Studio assets have an ID that is referred to by Google as its `name`; this is the value
|
Data Studio assets have an ID that is referred to by Google as its `name`; this is the value
|
||||||
|
|||||||
@@ -224,19 +224,19 @@ The file ID will only be valid when the return code of the command is 0; program
|
|||||||
Google Drive folders to GAM are just like files, with the MimeType for a folder. To create a folder `FooFolder` in the root of the Drive for user `Fred`:
|
Google Drive folders to GAM are just like files, with the MimeType for a folder. To create a folder `FooFolder` in the root of the Drive for user `Fred`:
|
||||||
|
|
||||||
```
|
```
|
||||||
user Fred@yourdomain.com create drivefile drivefilename FooFolder mimetype gfolder
|
gam user Fred@yourdomain.com create drivefile drivefilename FooFolder mimetype gfolder
|
||||||
```
|
```
|
||||||
|
|
||||||
The same, but created in the existing folder `BarFolder`:
|
The same, but created in the existing folder `BarFolder`:
|
||||||
|
|
||||||
```
|
```
|
||||||
user Fred@yourdomain.com create drivefile drivefilename FooFolder mimetype gfolder parentname BarFolder
|
gam user Fred@yourdomain.com create drivefile drivefilename FooFolder mimetype gfolder parentname BarFolder
|
||||||
```
|
```
|
||||||
|
|
||||||
This only works if the folder name for the parent is unique. An alternative is to use the folder ID:
|
This only works if the folder name for the parent is unique. An alternative is to use the folder ID:
|
||||||
|
|
||||||
```
|
```
|
||||||
user Fred@yourdomain.com create drivefile drivefilename FooFolder mimetype gfolder parentid <FolderID>
|
gam user Fred@yourdomain.com create drivefile drivefilename FooFolder mimetype gfolder parentid <FolderID>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Bulk Create Files and Folders
|
## Bulk Create Files and Folders
|
||||||
|
|||||||
@@ -35,6 +35,7 @@ Supported editions for this feature: Business Standard and Business Plus; Enterp
|
|||||||
<DriveLabelNameList> ::= "<DriveLabelName>(,<DriveLabelName)*"
|
<DriveLabelNameList> ::= "<DriveLabelName>(,<DriveLabelName)*"
|
||||||
<DriveLabelNameEntity> ::=
|
<DriveLabelNameEntity> ::=
|
||||||
<DriveLabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
<DriveLabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<DriveLabelFieldID> ::= <String>
|
<DriveLabelFieldID> ::= <String>
|
||||||
<DriveLabelSelectionID> ::= <String>
|
<DriveLabelSelectionID> ::= <String>
|
||||||
|
|||||||
@@ -104,17 +104,13 @@ specify `basicpermissions` and additional permission fields, e.g., `permissions.
|
|||||||
<DriveFilePermissionEntity> ::=
|
<DriveFilePermissionEntity> ::=
|
||||||
<DriveFilePermissionList> |
|
<DriveFilePermissionList> |
|
||||||
(json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) |
|
(json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) |
|
||||||
<FileSelector> |
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
<CSVFileSelector> |
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CSVkmdSelector> |
|
|
||||||
<CSVDataSelector>
|
|
||||||
<DriveFilePermissionIDEntity> ::=
|
<DriveFilePermissionIDEntity> ::=
|
||||||
<DriveFilePermissionIDList> |
|
<DriveFilePermissionIDList> |
|
||||||
(json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) |
|
(json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) |
|
||||||
<FileSelector> |
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
<CSVFileSelector> |
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<CSVkmdSelector> |
|
|
||||||
<CSVDataSelector>
|
|
||||||
```
|
```
|
||||||
## GUI API permission name mapping
|
## GUI API permission name mapping
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,9 @@
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<UserList> ::= "<UserItem>(,<UserItem>)*"
|
<UserList> ::= "<UserItem>(,<UserItem>)*"
|
||||||
<UserEntity> ::= <UserList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<UserEntity> ::=
|
||||||
|
<UserList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users
|
||||||
```
|
```
|
||||||
## Aliases
|
## Aliases
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,9 @@
|
|||||||
|
|
||||||
<FilterID> ::= <String>
|
<FilterID> ::= <String>
|
||||||
<FilterIDList> ::= "<FilterID>(,<FilterID>)*"
|
<FilterIDList> ::= "<FilterID>(,<FilterID>)*"
|
||||||
<FilterIDEntity> ::= <FilterIDList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<FilterIDEntity> ::=
|
||||||
|
<FilterIDList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<GmailCategory> ::=
|
<GmailCategory> ::=
|
||||||
forums|
|
forums|
|
||||||
|
|||||||
@@ -21,7 +21,9 @@
|
|||||||
<DomainName> ::= <String>(.<String>)+
|
<DomainName> ::= <String>(.<String>)+
|
||||||
<EmailAddress> ::= <String>@<DomainName>
|
<EmailAddress> ::= <String>@<DomainName>
|
||||||
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
||||||
<EmailAddressEntity> ::= <EmailAddressList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<EmailAddressEntity> ::=
|
||||||
|
<EmailAddressList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users
|
||||||
```
|
```
|
||||||
## Introduction
|
## Introduction
|
||||||
An email address must be defined as a forwarding address before it can be used to forward.
|
An email address must be defined as a forwarding address before it can be used to forward.
|
||||||
|
|||||||
@@ -40,10 +40,12 @@
|
|||||||
<LabelIDList> ::= "<LabelID>(,<LabelID)*"
|
<LabelIDList> ::= "<LabelID>(,<LabelID)*"
|
||||||
<LabelIDEntity> ::=
|
<LabelIDEntity> ::=
|
||||||
<LabelIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<LabelIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<LabelName> ::= <String>
|
<LabelName> ::= <String>
|
||||||
<LabelNameList> ::= "'<LabelName>'(,'<LabelName>')*"
|
<LabelNameList> ::= "'<LabelName>'(,'<LabelName>')*"
|
||||||
<LabelNameEntity> ::=
|
<LabelNameEntity> ::=
|
||||||
<LabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<LabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
```
|
```
|
||||||
## Special quoting
|
## Special quoting
|
||||||
You specify a single label name with `label <LabelName>` and a list of labels with `labellist <LabelNameList>`.
|
You specify a single label name with `label <LabelName>` and a list of labels with `labellist <LabelNameList>`.
|
||||||
|
|||||||
@@ -148,7 +148,9 @@
|
|||||||
|
|
||||||
<MessageID> ::= <String>
|
<MessageID> ::= <String>
|
||||||
<MessageIDList> ::= "<MessageID>(,<MessageID>)*"
|
<MessageIDList> ::= "<MessageID>(,<MessageID>)*"
|
||||||
<MessageIDEntity> ::= <MessageIDList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<MessageIDEntity> ::=
|
||||||
|
<MessageIDList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<ThreadID> ::= <String>
|
<ThreadID> ::= <String>
|
||||||
<ThreadIDList> ::= "<ThreadID>(,<ThreadID>)*"
|
<ThreadIDList> ::= "<ThreadID>(,<ThreadID>)*"
|
||||||
<ThreadIDEntity> ::= <ThreadIDList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
<ThreadIDEntity> ::= <ThreadIDList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
|
||||||
|
|||||||
@@ -25,6 +25,7 @@
|
|||||||
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
||||||
<EmailAddressEntity> ::=
|
<EmailAddressEntity> ::=
|
||||||
<EmailAddressList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<EmailAddressList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users
|
||||||
<Charset> ::= ascii|mbcs|utf-8|utf-8-sig|utf-16|<String>
|
<Charset> ::= ascii|mbcs|utf-8|utf-8-sig|utf-16|<String>
|
||||||
<Password> ::= <String>
|
<Password> ::= <String>
|
||||||
<SMTPHostName> ::= <String>
|
<SMTPHostName> ::= <String>
|
||||||
|
|||||||
@@ -35,7 +35,9 @@
|
|||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
||||||
<GroupEntity> ::= <GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<GroupEntity> ::=
|
||||||
|
<GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GroupRole> ::= owner|manager|member
|
<GroupRole> ::= owner|manager|member
|
||||||
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -51,6 +51,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<NotesNameList> ::= "<NotesName>(,<NotesName)*"
|
<NotesNameList> ::= "<NotesName>(,<NotesName)*"
|
||||||
<NotesNameEntity> ::=
|
<NotesNameEntity> ::=
|
||||||
<NotesNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<NotesNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<NotesField> ::=
|
<NotesField> ::=
|
||||||
attachments|
|
attachments|
|
||||||
|
|||||||
@@ -63,6 +63,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<PeopleResourceNameList> ::= "<PeopleResourceName>(,<PeopleResourceName>)*"
|
<PeopleResourceNameList> ::= "<PeopleResourceName>(,<PeopleResourceName>)*"
|
||||||
<PeopleResourceNameEntity> ::=
|
<PeopleResourceNameEntity> ::=
|
||||||
<PeopleResourceNameNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
<PeopleResourceNameNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<PeopleContactGroupName> ::= <String>
|
<PeopleContactGroupName> ::= <String>
|
||||||
<PeopleContactGroupResourceName> ::= (contactgroup/<String>)|<String>
|
<PeopleContactGroupResourceName> ::= (contactgroup/<String>)|<String>
|
||||||
@@ -70,6 +71,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<PeopleContactGroupList> ::= "<PeopleContactGroupItem>(,<PeopleContactGroupItem>)*"
|
<PeopleContactGroupList> ::= "<PeopleContactGroupItem>(,<PeopleContactGroupItem>)*"
|
||||||
<PeopleContactGroupEntity> ::=
|
<PeopleContactGroupEntity> ::=
|
||||||
<PeopleContactGroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<PeopleContactGroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<PeopleUserContactSelection> ::=
|
<PeopleUserContactSelection> ::=
|
||||||
[(selectcontactgroup <PeopleContactGroupItem>)|
|
[(selectcontactgroup <PeopleContactGroupItem>)|
|
||||||
[query <QueryContact>]]
|
[query <QueryContact>]]
|
||||||
@@ -175,6 +177,7 @@ gam user user@domain.com check serviceaccount
|
|||||||
<OtherContactsResourceNameList> ::= "<OtherContactsResourceName>(,<OtherContactsResourceName>)*"
|
<OtherContactsResourceNameList> ::= "<OtherContactsResourceName>(,<OtherContactsResourceName>)*"
|
||||||
<OtherContactsResourceNameEntity> ::=
|
<OtherContactsResourceNameEntity> ::=
|
||||||
<OtherContactsResourceNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
<OtherContactsResourceNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<OtherContactsSelection> ::=
|
<OtherContactsSelection> ::=
|
||||||
[query <QueryContact>]
|
[query <QueryContact>]
|
||||||
|
|||||||
@@ -34,8 +34,10 @@ gam user user@domain.com check serviceaccount
|
|||||||
<TasklistIDTaskIDList> ::= "<TasklistIDTaskID>(,<TasklistIDTaskID>)*"
|
<TasklistIDTaskIDList> ::= "<TasklistIDTaskID>(,<TasklistIDTaskID>)*"
|
||||||
<TasklistIDEntity> ::=
|
<TasklistIDEntity> ::=
|
||||||
<TasklistIDList> | <FileSelector> | <CSVFileSelector>
|
<TasklistIDList> | <FileSelector> | <CSVFileSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<TasklistIDTaskIDEntity> ::=
|
<TasklistIDTaskIDEntity> ::=
|
||||||
<TasklistIDTaskIDList> | <FileSelector> | <CSVFileSelector>
|
<TasklistIDTaskIDList> | <FileSelector> | <CSVFileSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
|
|
||||||
<TaskAttribute> ::=
|
<TaskAttribute> ::=
|
||||||
(title <String>)|
|
(title <String>)|
|
||||||
|
|||||||
@@ -89,6 +89,7 @@ queries "\"orgUnitPath='/Students/Middle School'\",\"orgUnitPath='/Students/Low
|
|||||||
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
||||||
<GroupEntity> ::= <GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<GroupEntity> ::= <GroupList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<GroupRole> ::= owner|manager|member
|
<GroupRole> ::= owner|manager|member
|
||||||
|
|
||||||
<OrgUnitID> ::= id:<String>
|
<OrgUnitID> ::= id:<String>
|
||||||
|
|||||||
@@ -41,6 +41,7 @@
|
|||||||
<EmailItemList> ::= "<EmailItem>(,<EmailItem>)*"
|
<EmailItemList> ::= "<EmailItem>(,<EmailItem>)*"
|
||||||
<EmailAddressList> ::= "<EmailAddess>(,<EmailAddress>)*"
|
<EmailAddressList> ::= "<EmailAddess>(,<EmailAddress>)*"
|
||||||
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
||||||
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Items
|
||||||
<TimeZone> ::= <String>
|
<TimeZone> ::= <String>
|
||||||
See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||||
<UniqueID> ::= id:<String>
|
<UniqueID> ::= id:<String>
|
||||||
|
|||||||
Reference in New Issue
Block a user