Aliases

Aliases

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

API documentation

• https://developers.google.com/admin-sdk/directory/v1/reference/users/aliases
• https://developers.google.com/admin-sdk/directory/v1/reference/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>

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]

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

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

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