mirror of
https://github.com/GAM-team/GAM.git
synced 2025-07-07 05:03:34 +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
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
!# Users - Backup Verification Codes
|
|
- [API documentation](#api-documentation)
|
|
- [Definitions](#definitions)
|
|
- [Manage backup verification codes](#manage-backup-verification-codes)
|
|
- [Display backup verification codes](#display-backup-verification-codes)
|
|
|
|
## API documentation
|
|
* https://developers.google.com/admin-sdk/directory/reference/rest/v1/verificationCodes
|
|
|
|
## Definitions
|
|
* [`<UserTypeEntity>`](Collections-of-Users)
|
|
|
|
## Manage backup verification codes
|
|
```
|
|
gam <UserTypeEntity> update backupcodes|verificationcodes
|
|
gam <UserTypeEntity> delete|del backupcodes|verificationcodes
|
|
```
|
|
You will get the following error message for any user that is suspended:
|
|
```
|
|
User: user@domain.com, Backup Verification Codes Not Updated: User is suspended. You must unsuspend to process backupcodes
|
|
User: user@domain.com, Backup Verification Codes Not Deleted: User is suspended. You must unsuspend to process backupcodes
|
|
```
|
|
## Display backup verification codes
|
|
```
|
|
gam <UserTypeEntity> show backupcodes|backupcode|verificationcodes
|
|
|
|
```
|
|
Gam displays the information as an indented list of keys and values.
|
|
|
|
Exit Status of 0 indicates no errors, and backup codes are sent to stdout.
|
|
|
|
Exit status of 60 indicates no errors, and that no backup codes are available for this user.
|
|
```
|
|
gam <UserTypeEntity> print backupcodes|verificationcodes [todrive <ToDriveAttributes>*]
|
|
[delimiter <Character>] [countsonly]
|
|
```
|
|
GAM displays the information in CSV form.
|
|
|
|
* `delimiter <Character>` - Separate `verificationCodes` entries with `<Character>`; the default value is `csv_output_field_delimiter` from `gam.cfg`.
|
|
* `countsonly` - Display only the number of available backup codes but not the codes themselves.
|