From 426781eda39fdfbb050cec0465179feacde50da2 Mon Sep 17 00:00:00 2001 From: Ross Scroggs Date: Thu, 4 Jun 2026 15:41:37 -0700 Subject: [PATCH] Update Users.md --- wiki/Users.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 77 insertions(+), 5 deletions(-) diff --git a/wiki/Users.md b/wiki/Users.md index 48a4929e..87ac7617 100644 --- a/wiki/Users.md +++ b/wiki/Users.md @@ -1093,7 +1093,9 @@ gam print users [todrive *] (filtermultiattrcustom )* [delimiter ] [sortheaders []] [scalarsfirst []] [formatjson [quotechar ]] [quoteplusphonenumbers] - [issuspended ] [isarchived ] [aliasmatchpattern ] + ([issuspended []] [isarchived []])|(isdisabled [])] + [disabledafter ] [disabledbefore ] + [aliasmatchpattern ] [showvalidcolumn] (addcsvdata )* [includecsvdatainjson []] ``` @@ -1103,8 +1105,40 @@ By default, users in all domains in the account are selected; these options allo * `(query )|(queries )` - Limit users to those that match a query; each query is run against each domain * `limittoou |` - Limit users to those in the specified `>` * `deleted_only|only_deleted` - Only display deleted users -* `issuspended ` - Limit users based on their status -* `isarchived ` - Limit users based on their status + +The `isarchived`, `issuspended` and `isdisabled` options can be used to select users based on their archival/suspension status. + +| Options | Users Displayed | +|---------|-----------------| +| None | All Users| +| isarchived [true] | Archived Users | +| isarchived false | Non-Archived Users | +| issuspended [true] | Suspended Users | +| issuspended false | Non-Suspended Users | +| isarchived [true] issuspended [true] | Archived Users that are Suspended | +| isarchived [true] issuspended false | Archived Users that are not Suspended | +| isarchived false issuspended [true] | Suspended Users that are not Archived | +| isarchived false issuspended false | Non-Archived and Non-Suspended Users | +| isdisabled [true] | Archived or Suspended Users | +| isdisabled false | Non-Archived and Non-Suspended Users | + +When any of `isarchived [true]`, `issuspended [true]`, `isdisabled [true]` are specified, +the options `disabledafter ` and/or `disabledbefore ` can be used to further limit +the users displayed. + +### Examples +Display users suspended more than 90 days ago. +``` +gam print users issuspended disabledbefore -90d +``` +Display users archived within the last 10 days. +``` +gam print users isarchived disabledafter -10d +``` +Display users archived/suspended within a range. +``` +gam print users isdisabled disabledafter -60d disabledbefore -30d +``` ### Print a header row and fields for users specified by `` ``` @@ -1121,7 +1155,9 @@ gam print users [todrive *] select (filtermultiattrcustom )* [delimiter ] [sortheaders []] [scalarsfirst []] [formatjson [quotechar ]] [quoteplusphonenumbers] - [issuspended ] [isarchived ] [aliasmatchpattern ] + ([issuspended []] [isarchived []])|(isdisabled [])] + [disabledafter ] [disabledbefore ] + [aliasmatchpattern ] [showvalidcolumn] (addcsvdata )* [includecsvdatainjson []] gam print users [todrive *] @@ -1137,7 +1173,9 @@ gam print users [todrive *] (filtermultiattrcustom )* [delimiter ] [sortheaders []] [scalarsfirst []] [formatjson [quotechar ]] [quoteplusphonenumbers] - [issuspended ] [isarchived ] [aliasmatchpattern ] + ([issuspended []] [isarchived []])|(isdisabled [])] + [disabledafter ] [disabledbefore ] + [aliasmatchpattern ] [showvalidcolumn] (addcsvdata )* [includecsvdatainjson []] ``` @@ -1175,6 +1213,40 @@ of a specified `type` or `customType`. * `filtermultiattrtype ` - Display `` if its `type` is `` * `filtermultiattrcustom ` - Display `` if its `customType` is `` +The `isarchived`, `issuspended` and `isdisabled` options can be used to select users from `` based on their archival/suspension status. + +| Options | Users Displayed | +|---------|-----------------| +| None | All Users| +| isarchived [true] | Archived Users | +| isarchived false | Non-Archived Users | +| issuspended [true] | Suspended Users | +| issuspended false | Non-Suspended Users | +| isarchived [true] issuspended [true] | Archived Users that are Suspended | +| isarchived [true] issuspended false | Archived Users that are not Suspended | +| isarchived false issuspended [true] | Suspended Users that are not Archived | +| isarchived false issuspended false | Non-Archived and Non-Suspended Users | +| isdisabled [true] | Archived or Suspended Users | +| isdisabled false | Non-Archived and Non-Suspended Users | + +When any of `isarchived [true]`, `issuspended [true]`, `isdisabled [true]` are specified, +the options `disabledafter ` and/or `disabledbefore ` can be used to further limit +the users displayed. + +### Examples +Display users suspended more than 90 days ago. +``` +gam print users issuspended disabledbefore -90d +``` +Display users archived within the last 10 days. +``` +gam print users isarchived disabledafter -10d +``` +Display users archived/suspended within a range. +``` +gam print users isdisabled disabledafter -60d disabledbefore -30d +``` + By default, when aliases are displayed, all aliases are displayed. Use `aliasmatchpattern ` to limit the display of aliases to those that match ``.