Manage Google Workspace User Alias
Add or remove an email alias for a Google Workspace user
This tool adds or removes an email alias for a Google Workspace user. Mail sent to the alias goes to the user's inbox. Use an alias when one person must get mail at one more address, for example sales@ for the sales lead.
What this tool does
When the tool runs, it adds the alias to the user or removes the alias from the user. It then returns a confirmation, for example "Mail sent to sales@example.com will now be delivered to jane@example.com."
Prerequisites
- The Google Workspace tools connector is connected. The tool runs on the connector's grant. It does not use the Admin API card on Settings > Integrations > Google Workspace.
- The connector grant includes the
https://www.googleapis.com/auth/admin.directory.user.aliasscope. No other built-in tool uses this scope. When you add this tool, Risotto adds the scope to the connector consent. An admin must click Reconnect on the connector and approve the scope. - The Google admin who gave consent has the User Management admin privilege.
Enable the tool
- Select Tools in the sidebar.
- In the Tool groups list, select Google.
- On the Google Workspace Manage User Alias row, click Enable.
Risotto names the new tool Manage Google Workspace User Alias. The tool has Approval set to Required by default, so an approver must accept each change before it runs.
Tool options
- Restrict to Requestor Only (default: on): when on, the tool can only change the aliases of the ticket requestor. Turn it off to let IT staff change aliases for other users.
| Parameter | Required | Description |
|---|---|---|
action | Yes | add to add the alias, or remove to remove it. |
alias | Yes | The alias email address, for example sales@example.com. |
email_address | No | The email address of the user. When it is empty, the tool uses the ticket requestor's email address. |
Troubleshooting
This tool is restricted to operate only on the requestor's resources
Restrict to Requestor Only is on, and the email address is not the requestor's. To change aliases for other users, turn off the option on the tool.
is already in use as a user, group, or alias
The address belongs to a user, a group, or another alias. If many people must get mail at this address, add the user to a group at this address with Manage Google Group Members.
The alias does not exist or is not associated with this user
The user does not have this alias. Check the alias and the user's email address.
Google refused the call
The connector grant does not include the admin.directory.user.alias scope,
or the admin who connected it does not have the User Management
privilege. Click Reconnect on the connector and approve the scope.
Related
Something wrong or missing? Report an issue · View as Markdown