diff --git a/docs/Users-Classification-Labels.md b/docs/Users-Classification-Labels.md index 8199fdff..003aafbd 100644 --- a/docs/Users-Classification-Labels.md +++ b/docs/Users-Classification-Labels.md @@ -4,10 +4,10 @@ - [Notes](#notes) - [Definitions](#definitions) - [Introduction](#introduction) -- [Display Drive Labels](#display-drive-labels) -- [Process File Drive Labels](#process-file-drive-labels) -- [Manage Drive Label Permissions](#manage-drive-label-permissions) -- [Display Drive Label Permissions](#display-drive-label-permissions) +- [Display Classification Labels](#display-classification-labels) +- [Manage Classification Label Permissions](#manage-classification-label-permissions) +- [Display Classification Label Permissions](#display-classification-label-permissions) +- [Process Drive File Classification Labels](#process-drive-file-classification-labels) ## API documentation * https://support.google.com/a/answer/9292382 @@ -24,31 +24,39 @@ To use these commands you must add the 'Drive Labels API' to your project and up gam update project gam user user@domain.com update serviceaccount ``` -Supported editions for this feature: Business Standard and Business Plus; Enterprise; Education Standard and Education Plus; G Suite Business; Essentials. +Supported editions for this feature: +``` +Frontline Starter and Frontline Standard +Business Standard and Business Plus +Enterprise Standard and Enterprise Plus +Education Standard and Education Plus +Essentials, Enterprise Essentials, and Enterprise Essentials Plus +G Suite Business +``` ## Definitions * [``](Drive-File-Selection) * [``](Collections-of-Users) -* [``, ``, ``](Collections-of-Items) ``` - ::= - ::= "(, ::= + ::= "(, ::= labels/[@latest|@published|@] - ::= "(, ::= - | | | + ::= labels/[@latest|@published|@] + ::= "(, ::= + | | | - ::= labels/[@latest|@published|@]/permissions/(audiences|groups|people)/ - ::= "(,)*" - ::= - | | | + ::= labels/[@latest|@published|@]/permissions/(audiences|groups|people)/ + ::= "(,)*" + ::= + | | | - ::= - ::= - ::= "(, ::= + ::= + ::= "(, ::= ar-sa| # Arabic Saudi Arabia @@ -99,10 +107,10 @@ Three forms of the commands are available: * `gam action ... adminaccess` - The user named in `` is used, adminaccess indicates that labels of type `SHARED` and `ADMIN`can be processed * `gam action ...` - The user named in `` is used, access is limited, onlylabels of type `SHARED` can be processed -## Display Drive Labels +## Display Classification Labels ``` -gam [] info drivelabels +gam [] info classificationlabels [[basic|full] [languagecode ] [formatjson] [adminaccess|asadmin] ``` @@ -115,7 +123,7 @@ By default, Gam displays the information as an indented list of keys and values. * `formatjson` - Display the fields in JSON format. ``` -gam [] show drivelabels +gam [] show classificationlabels [basic|full] [languagecode ] [publishedonly []] [minimumrole applier|editor|organizer|reader] [formatjson] [adminaccess|asadmin] @@ -130,7 +138,7 @@ By default, Gam displays the information as an indented list of keys and values. * `formatjson` - Display the fields in JSON format. ``` -gam [] print drivelabels [todrive *] +gam [] print classificationlabels [todrive *] [basic|full] [languagecode ] [publishedonly []] [minimumrole applier|editor|organizer|reader] [formatjson [quotechar ]] [adminaccess|asadmin] @@ -150,25 +158,10 @@ When using the `formatjson` option, double quotes are used extensively in the da The `quotechar ` 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. -## Process File Drive Labels -``, `` and `` values are obtained from the commands above. +## Manage Classification Label Permissions +Create a permission for a Classification Label by specifying the label name and the principal. ``` -gam process filedrivelabels - (addlabel )* - (deletelabel )* - (addlabelfield - (text )|selection )| - (integer )|(date )|(user ))* - (deletelabelfield )* - [nodetails] -``` - -By default, details of the process labels are displayed, use `nodetails` to suppress this display. - -## Manage Drive Label Permissions -Create a permission for a Drive Label by specifying the label name and the principal. -``` -gam [] create drivelabelpermission +gam [] create classificationlabelpermission (user ) | (group ) role applier|editor|organizer|reader [nodetails|formatjson] [adminaccess|asadmin] @@ -178,22 +171,22 @@ By default, when a permission is created, GAM outputs details of the permission * `nodetails` - Suppress the details output. * `formatjson` - Output the details in JSON format. -Delete a Drive Label permission by specifying the label name and the principal. +Delete a Classification Label permission by specifying the label name and the principal. ``` -gam [] delete drivelabelpermission +gam [] delete classificationlabelpermission (user ) | (group ) [adminaccess|asadmin] ``` -Delete a Drive Label permission by specifying the label permission name. +Delete a Classification Label permission by specifying the label permission name. ``` -gam [] remove drivelabelpermission +gam [] remove classificationlabelpermission [adminaccess|asadmin] ``` -## Display Drive Label Permissions -Display permissions for a collection of Drive Label permission names. +## Display Classification Label Permissions +Display permissions for a collection of Classification Label permission names. ``` -gam [] show drivelabelpermissions +gam [] show classificationlabelpermissions [formatjson] [adminaccess|asadmin] ``` @@ -201,7 +194,7 @@ By default, Gam displays the information as an indented list of keys and values. * `formatjson` - Display the fields in JSON format. ``` -gam [] print drivelabelpermissions [todrive *] +gam [] print classificationlabelpermissions [todrive *] [formatjson [quotechar ]] [adminaccess|asadmin] ``` By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format, @@ -213,3 +206,17 @@ When using the `formatjson` option, double quotes are used extensively in the da The `quotechar ` 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. +## Process Drive File Classification Labels +``, `` and `` values are obtained from the commands above. +``` +gam process filedrivelabels + (addlabel )* + (deletelabel )* + (addlabelfield + (text )|selection )| + (integer )|(date )|(user ))* + (deletelabelfield )* + [nodetails] +``` + +By default, details of the process labels are displayed, use `nodetails` to suppress this display.