mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-18 05:01:37 +00:00
caddda2b1c
Some checks failed
Build and test GAM / build (Win64, build, 7, VC-WIN64A, windows-2022) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 2, linux-aarch64, [self-hosted linux arm64]) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 4, linux-aarch64, [self-hosted linux arm64], yes) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 6, darwin64-arm64, macos-14) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 1, linux-x86_64, ubuntu-22.04) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 3, linux-x86_64, ubuntu-22.04, yes) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 5, darwin64-x86_64, macos-13) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 10, ubuntu-24.04, 3.10) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 11, ubuntu-24.04, 3.11) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 8, ubuntu-24.04, 3.13) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 9, ubuntu-24.04, 3.9) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Check for Google Root CA Updates / check-apis (push) Has been cancelled
Build and test GAM / merge (push) Has been cancelled
Build and test GAM / publish (push) Has been cancelled
131 lines
5.9 KiB
Markdown
131 lines
5.9 KiB
Markdown
!# Users - Tokens
|
|
- [API documentation](#api-documentation)
|
|
- [Definitions](#definitions)
|
|
- [Delete a user's token](#delete-a-users-token)
|
|
- [Display individual user's tokens](#display-individual-users-tokens)
|
|
- [Display individual user's token counts](#display-individual-users-token-counts)
|
|
- [Display aggregated user's tokens](#display-aggregated-users-tokens)
|
|
|
|
## API documentation
|
|
* https://developers.google.com/admin-sdk/directory/reference/rest/v1/tokens
|
|
|
|
## Definitions
|
|
* [`<UserTypeEntity>`](Collections-of-Users)
|
|
|
|
```
|
|
<ClientID> ::= <String>
|
|
```
|
|
## Delete a user's token
|
|
```
|
|
gam <UserTypeEntity> delete|del token|tokens clientid <ClientID>
|
|
```
|
|
## Display individual user's tokens
|
|
```
|
|
gam <UserTypeEntity> print tokens|token [todrive <ToDriveAttributes>*] [clientid <ClientID>]
|
|
[orderby clientid|id|appname|displaytext] [delimiter <Character>]
|
|
gam <UserTypeEntity> show tokens|token|3lo|oauth [clientid <ClientID>]
|
|
[orderby clientid|id|appname|displaytext]
|
|
gam print tokens|token [todrive <ToDriveAttributes>*] [clientid <ClientID>]
|
|
[orderby clientid|id|appname|displaytext] [delimiter <Character>]
|
|
[<UserTypeEntity>]
|
|
gam show tokens|token [clientid <ClientID>]
|
|
[orderby clientid|id|appname|displaytext] [delimiter <Character>]
|
|
[<UserTypeEntity>]
|
|
```
|
|
By default, all client tokens for a user are displayed, use `clientid <ClientID>` to display a specific client token.
|
|
|
|
For each user, select the order of token presentation:
|
|
* `orderby clientid|id` - Display each user's tokens ordered by Client ID
|
|
* `orderby appname|displaytext` - Display each user's tokens ordered by App Name
|
|
|
|
For `print tokens`:
|
|
* `delimiter <Character>` - Separate `scopes` entries with `<Character>`; the default value is `csv_output_field_delimiter` from `gam.cfg`.
|
|
|
|
### Example
|
|
This example shows which domain users have the Google Apps Sync for Microsoft Outlook app allowed for their account
|
|
```
|
|
gam all users print token clientid 1095133494869.apps.googleusercontent.com
|
|
```
|
|
|
|
## Display individual user's token counts
|
|
```
|
|
gam <UserTypeEntity> print tokens|token [todrive <ToDriveAttributes>*] [clientid <ClientID>]
|
|
usertokencounts
|
|
gam <UserTypeEntity> show tokens|token|3lo|oauth [clientid <ClientID>]
|
|
usertokencounts
|
|
gam print tokens|token [todrive <ToDriveAttributes>*] [clientid <ClientID>]
|
|
usertokencounts
|
|
[<UserTypeEntity>]
|
|
gam show tokens|token [clientid <ClientID>]
|
|
usertokencounts
|
|
[<UserTypeEntity>]
|
|
```
|
|
|
|
### Example
|
|
This example shows which domain users have any access tokens.
|
|
```
|
|
gam config csv_output_row_filter "tokenCount:count>0" all users print tokens usertokencounts
|
|
```
|
|
|
|
## Display aggregated user's tokens
|
|
```
|
|
gam <UserTypeEntity> print tokens|token [todrive <ToDriveAttributes>*] [clientid <ClientID>]
|
|
[aggregateusersby clientid|id|appname|displaytext] [delimiter <Character>]
|
|
gam <UserTypeEntity> show tokens|token|3lo|oauth [clientid <ClientID>]
|
|
[aggregateusersby clientid|id|appname|displaytext]
|
|
gam print tokens|token [todrive <ToDriveAttributes>*] [clientid <ClientID>]
|
|
[aggregateusersby clientid|id|appname|displaytext] [delimiter <Character>]
|
|
[<UserTypeEntity>]
|
|
```
|
|
By default, all client tokens for aggregated users are displayed, use `clientid <ClientID>` to display a specific client token.
|
|
|
|
For aggregated users, select the order of token presentation:
|
|
* `aggregateusersby clientid|id` - Display aggregated users tokens ordered by Client ID
|
|
* `aggregateusersby appname|displaytext` - Display aggregated users tokens ordered by App Name
|
|
|
|
For `print tokens`:
|
|
* `delimiter <Character>` - Separate `scopes` entries with `<Character>`; the default value is `csv_output_field_delimiter` from `gam.cfg`.
|
|
|
|
### Generate a list of all Google Apps being used by each of your users.
|
|
|
|
Serial processing
|
|
```
|
|
gam config csv_output_header_filter "^user$,clientId,displayText" redirect csv UserApps.csv [todrive <ToDriveAttributes>*] all users print tokens
|
|
```
|
|
* `config csv_output_header_filter "^user$,clientId,displayText"` - Select relevant columns
|
|
* `redirect csv UserApps.csv` - Specify CSV file
|
|
* `[todrive <ToDriveAttributes>*]` - Optional, upload CSV to Google Drive
|
|
* `all users print tokens` - Get the apps
|
|
|
|
Parallel processing
|
|
```
|
|
gam config auto_batch_min 1 num_threads 10 csv_output_header_filter "^user$,clientId,displayText" redirect csv UserApps.csv multiprocess [todrive <ToDriveAttributes>*] all users print tokens
|
|
```
|
|
* `config auto_batch_min 1 num_threads 10` - Turn on parallel processing
|
|
* `csv_output_header_filter "^user$,clientId,displayText"` - Select relevant columns
|
|
* `redirect csv UserApps.csv multiprocess` - Specify CSV file with parallel processing
|
|
* `[todrive <ToDriveAttributes>*]` - Optional, upload CSV to Google Drive
|
|
* `all users print tokens` - Get the apps
|
|
|
|
### Generate a list of all Google Apps being used by any user.
|
|
Serial processing must be used
|
|
```
|
|
gam config csv_output_header_filter "^users$,clientId,displayText" redirect csv UserApps.csv [todrive <ToDriveAttributes>*] all users print tokens aggregateusersby displaytext
|
|
```
|
|
* `config csv_output_header_filter "^users$,clientId,displayText"` - Select relevant columns
|
|
* `redirect csv UserApps.csv` - Specify CSV file
|
|
* `[todrive <ToDriveAttributes>*]` - Optional, upload CSV to Google Drive
|
|
* `all users print tokens` - Get the apps
|
|
* `aggregateusersby displaytext` - Aggregate users
|
|
|
|
### Display how many users are using Google Chrome
|
|
Serial processing must be used
|
|
```
|
|
gam config csv_output_header_filter "^users$,clientId,displayText" redirect csv UserApps.csv [todrive <ToDriveAttributes>*] all users print tokens aggregateusersby displaytext clientid 77185425430.apps.googleusercontent.com
|
|
```
|
|
* `config csv_output_header_filter "^users$,clientId,displayText"` - Select relevant columns
|
|
* `redirect csv UserApps.csv` - Specify CSV file
|
|
* `[todrive <ToDriveAttributes>*]` - Optional, upload CSV to Google Drive
|
|
* `all users print tokens` - Get the apps
|
|
* `aggregateusersby displaytext` - Aggregate users
|