mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-03 22:01:39 +00:00
06f653db8f
Some checks failed
Build and test GAM / build (false, build, 1, Build Intel Ubuntu Jammy, ubuntu-22.04) (push) Has been cancelled
Build and test GAM / build (false, build, 10, Build x86_64 macOS 15, macos-15-intel) (push) Has been cancelled
Build and test GAM / build (false, build, 11, Build Arm MacOS 26, macos-26) (push) Has been cancelled
Build and test GAM / build (false, build, 12, Build Intel Windows, windows-2025-vs2026) (push) Has been cancelled
Build and test GAM / build (false, build, 13, Build Arm Windows, windows-11-arm) (push) Has been cancelled
Build and test GAM / build (false, build, 2, Build Intel Ubuntu Noble, ubuntu-24.04) (push) Has been cancelled
Build and test GAM / build (false, build, 3, Build Arm Ubuntu Noble, ubuntu-24.04-arm) (push) Has been cancelled
Build and test GAM / build (false, build, 4, Build Arm Ubuntu Jammy, ubuntu-22.04-arm) (push) Has been cancelled
Build and test GAM / build (false, build, 5, Build Intel StaticX Legacy, ubuntu-22.04, yes) (push) Has been cancelled
Build and test GAM / build (false, build, 6, Build Arm StaticX Legacy, ubuntu-22.04-arm, yes) (push) Has been cancelled
Build and test GAM / build (false, build, 8, Build Arm MacOS 14, macos-14) (push) Has been cancelled
Build and test GAM / build (false, build, 9, Build Arm MacOS 15, macos-15) (push) Has been cancelled
Build and test GAM / build (false, test, 14, Test Python 3.10, ubuntu-24.04, 3.10) (push) Has been cancelled
Build and test GAM / build (false, test, 15, Test Python 3.11, ubuntu-24.04, 3.11) (push) Has been cancelled
Build and test GAM / build (false, test, 16, Test Python 3.12, ubuntu-24.04, 3.12) (push) Has been cancelled
Build and test GAM / build (false, test, 17, Test Python 3.15-dev, ubuntu-24.04, 3.15-dev) (push) Has been cancelled
Build and test GAM / build (true, test, 18, Test Python 3.14 freethread, ubuntu-24.04, 3.14) (push) Has been cancelled
Build and test GAM / merge (push) Has been cancelled
Build and test GAM / publish (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Check for Google Root CA Updates / check-certs (push) Has been cancelled
Push wiki / pushwiki (push) Has been cancelled
94 lines
4.3 KiB
Markdown
94 lines
4.3 KiB
Markdown
# Users - Photo
|
|
- [API documentation](#api-documentation)
|
|
- [Notes](#notes)
|
|
- [Definitions](#definitions)
|
|
- [Upload a user's photo from a default file](#upload-a-users-photo-from-a-default-file)
|
|
- [Upload a user's photo specifying file name](#upload-a-users-photo-specifying-file-name)
|
|
- [Upload a user's photo specifying separate path and file name](#upload-a-users-photo-specifying-separate-path-and-file-name)
|
|
- [Upload a user's photo specifying a Google Drive owner and file name](#upload-a-users-photo-specifying-a-google-drive-owner-and-file-name)
|
|
- [Download a user's photo](#download-a-users-photo)
|
|
- [Delete a user's photo](#delete-a-users-photo)
|
|
- [Update photo fails to change user's photo](#update-photo-fails-to-change-users-photo)
|
|
- [Download a user's profile photo](Users-Profile-Photo)
|
|
|
|
## API documentation
|
|
* [Directory API - Users Photos](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users.photos)
|
|
|
|
## Notes
|
|
As of version 7.34.09, `gam <UserTypeEntity> update photo` was updated to delete the user's existing photo
|
|
before performing the update as the API update will succeed but not replace a user's existing self-set photo.
|
|
|
|
## Definitions
|
|
* [`<DriveFileEntity>`](Drive-File-Selection)
|
|
* [`<UserTypeEntity>`](Collections-of-Users)
|
|
|
|
## Upload a user's photo from a default file
|
|
```
|
|
gam <UserTypeEntity> update photo
|
|
```
|
|
* The default file is named `#email#.jpg` in the current working directory.
|
|
* `#email#` will be replaced by the user's full email address
|
|
|
|
## Upload a user's photo specifying file name
|
|
```
|
|
gam <UserTypeEntity> update photo <FileNamePattern>
|
|
```
|
|
By default, the user's photo will be uploaded from the current working directory.
|
|
* `<FileNamePattern>` can be a full file path/name or just a file name
|
|
* `#email#` and `#user#` will be replaced by the user's full email address
|
|
* `#username#` will be replaced by the local part of the user's email address
|
|
|
|
## Upload a user's photo specifying separate path and file name
|
|
```
|
|
gam <UserTypeEntity> update photo
|
|
[drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>]
|
|
```
|
|
By default, the user's photo will be uploaded from the current working directory.
|
|
* `drivedir` - The photo will be uploaded from the directory specified by `drive_dir` in gam.cfg
|
|
* `sourcefolder <FilePath>` - The photo will be uploaded from `<FilePath>`
|
|
|
|
* `filename <FileNamePattern>` - A file name
|
|
* `#email#` and `#user#` will be replaced by the user's full email address
|
|
* `#username#` will be replaced by the local part of the user's email address
|
|
|
|
## Upload a user's photo specifying a Google Drive owner and file name
|
|
```
|
|
gam <UserTypeEntity> update photo
|
|
gphoto <EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>
|
|
```
|
|
* `<DriveFileIDEntity>` - A file ID
|
|
* `<DriveFileNameEntity>` - A file name
|
|
* `#email#` and `#user#` will be replaced by the user's full email address
|
|
* `#username#` will be replaced by the local part of the user's email address
|
|
|
|
## Download a user's photo
|
|
```
|
|
gam <UserTypeEntity> get photo
|
|
[drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
|
|
[noshow] [nofile]
|
|
```
|
|
By default, the user's photo will be downloaded into the current working directory.
|
|
* `drivedir` - The photo will be downloaded to the directory specified by `drive_dir` in gam.cfg
|
|
* `targetfolder <FilePath>` - The photo will be downloaded to `<FilePath>`
|
|
* `nofile` - Suppress writing the photo data to a file
|
|
|
|
By default, the user's photo will be named `#email#.#ext#`; use the following option to specify a different file name.
|
|
* `filename <FileNamePattern>` - The downloaded file name will be `<FileNamePattern>`
|
|
|
|
In either case, the following substitutions will be made:
|
|
* `#email#` and `#user#` will be replaced by the user's full email address
|
|
* `#username#` will be replaced by the local part of the user's email address
|
|
* `#ext#` will be replaced by the appropriate extension based on the data: `jpg`, `png`, `gif`
|
|
|
|
By default, the Base64 encoded data is dumped to stdout.
|
|
* `noshow` - Suppress dumping the photo data to stdout
|
|
|
|
## Delete a user's photo
|
|
```
|
|
gam <UserTypeEntity> delete|del photo
|
|
```
|
|
|
|
## Update photo fails to change user's photo
|
|
If you use `gam <UserTypeEntity> update photo ...` to change a user's photo and the command succeeds
|
|
but the photo doesn't change, use `gam <UserTypeEntity> delete photo` first and then do the update.
|