Aliases

Aliases

• API documentation
• Query documentation
• Python Regular Expressions Match function
• Definitions
• Manage aliases
• Delete all of a user's aliases
• Display aliases
• Bulk delete aliases
• Determine if an address is a user, user alias, group or group alias

API documentation

• https://developers.google.com/admin-sdk/directory/reference/rest/v1/users.aliases
• https://developers.google.com/admin-sdk/directory/reference/rest/v1/groups.aliases

Query documentation

• https://developers.google.com/admin-sdk/directory/v1/guides/search-users

Definitions

<DomainName> ::= <String>(.<String>)+
<EmailAddress> ::= <String>@<DomainName>
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
<EmailAddressEntity> ::= <EmailAddressList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
<UniqueID> ::= uid:<String>

Manage aliases

gam create alias|aliases <EmailAddressEntity> user|group|target <UniqueID>|<EmailAddress>
gam update alias|aliases <EmailAddressEntity> user|group|target <UniqueID>|<EmailAddress>
gam delete alias|aliases [user|group|target] <EmailAddressEntity>
gam remove alias|aliases <EmailAddress> user|group <EmailAddressEntity>

Example

To allow Robert to also receive mail as Bob:

gam create alias bob[@yourdomain.com] user robert[@yourdomain.com]

Delete all of a user's aliases

gam <UserTypeEntity> delete aliases

Display aliases

gam info alias|aliases <EmailAddressEntity>
gam print aliases [todrive <ToDriveAttribute>*]
        [(query <QueryUser>)|(queries <QueryUserList>)]
        [aliasmatchpattern <RegularExpression>]
        [shownoneditable] [nogroups] [nousers]
        [onerowpertarget] [suppressnoaliasrows]

By default, all group and user aliases are printed.

• nogroups - Print only user aliases
• nousers - Print only group aliases
• (query <QueryUser>)|(queries <QueryUserList>) - Print aliases for selected users
• aliasmatchpattern <RegularExpression> - Print aliases that match a pattern

By default, the CSV output has three columns: Alias,Target,TargetType; if a target has multiple aliases, there will be multiple rows, one per alias.

Use shownoneditable to list non-editable alias email addresses; these are typically outside of the account's primary domain or subdomains. This adds the column NonEditableAlias

Specifying onerowpertarget changes the three columns to: Target,TargetType,Aliases; all aliases for the target are space-separated in the Aliases column. If shownoneditable is specified, there will be a fourth column NonEditableAliases with space-separated non-editable aliases.

Specifying both onerowpertarget and suppressnoaliasrows causes GAM to not display any targets that have no aliases.

Bulk delete aliases

You can bulk delete aliases as follows; use (query <QueryUser>)|(queries <QueryUserList>) and aliasmatchpattern ` as desired.

gam redirect csv ./OldDomainAliases.csv print aliases aliasmatchpattern ".*@olddomain.com" onerowpertarget suppressnoaliasrows
gam csv ./OldDomainAliases.csv gam remove aliases "~Target" "~TargetType" "~Aliases"

Determine if an address is a user, user alias, group or group alias

gam whatis <EmailItem> [noinfo]

The first line of output is: <TypeOfEmailItem>: <EmailItem>

There is additional output based on <TypeOfEmailItem>:

• User - gam info user <EmailItem>
• Group - gam info group <EmailItem>
• User Alias - gam info alias <EmailItem>
• Group Alias - gam info alias <EmailItem>

The noinfo argument suppresses the additional output.

The return code is set based on <TypeOfEmailItem>:

• User - 20
• User Alias - 21
• Group - 22
• Group Alias - 23
• Unknown - 59