Skip to content

Users Gmail Delegates

Jump to bottom
Ross Scroggs edited this page Jan 31, 2024 · 12 revisions

Users - Gmail - Delegates

API documentation

Definitions

<DomainName> ::= <String>(.<String>)+
<EmailAddress> ::= <String>@<DomainName>
<UniqueID> ::= id:<String>
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
<UserList> ::= "<UserItem>(,<UserItem>)*"
<UserEntity> ::=
        <UserList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
        See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users

Aliases

It is an error to use a user'a alias as a delegate; if you try, an error will be generated. The convertalias option causes GAM to make an extra API call per user in <UserEntity> to convert aliases to primary email addresses. If you know that all of the email addresses in <UserEntity> are primary, you can omit convertalias and avoid the extra API calls.

Create Gmail delegates

These two commands are equivalent.

gam <UserTypeEntity> add delegate|delegates [convertalias] <UserEntity>
gam <UserTypeEntity> delegate|delegates to [convertalias] <UserEntity>

Example

To give Bob access to Fred's mailbox as a delegate:

gam user fred@domain.com add delegate bob@domain.com

Delete Gmail delegates

gam <UserTypeEntity> delete|del delegate|delegates [convertalias] <UserEntity>

Update Gmail delegates

Update delegates to be able to access a user's contacts.

gam <UserTypeEntity> update delegate|delegates [convertalias] [<UserEntity>]

If <UserEntity> is omitted, all of a user's accepted delegates are updated.

Display Gmail delegates

gam <UserTypeEntity> show delegates|delegate [shownames] [csv]
gam <UserTypeEntity> print delegates|delegate [todrive <ToDriveAttribute>*] [shownames]

By default, delegate names are not displayed; use the shownames option to display the delegates name. This involves an extra API call per delegate email address.

By default, show delegates displays indented keys and values; use the csv option to have just the values shown as a comma separated list.

Delete all delegates for a user

$ gam redirect csv ./Delegates.csv user testsimple print delegates
Getting all Delegates for testsimple@domain.com
$ gam redirect stdout - multiprocess csv Delegates.csv gam user "~User" delete delegate "~delegateAddress"
2023-11-10T06:56:04.118-08:00,0/3,Using 3 processes...
2023-11-10T06:56:04.123-08:00,0,Processing item 3/3
User: testsimple@domain.com, Delete 1 Delegate
  User: testsimple@domain.com, Delegate: testuser1@domain.com, Deleted
User: testsimple@domain.com, Delete 1 Delegate
  User: testsimple@domain.com, Delegate: testuser2@domain.com, Deleted
User: testsimple@domain.com, Delete 1 Delegate
  User: testsimple@domain.com, Delegate: testgroup@domain.com, Deleted
2023-11-10T06:56:07.253-08:00,0/3,Processing complete

Need more help? Ask on the GAM Discussion Group

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally