Docs

Integrations / Identity / Google Workspace

Set Google Workspace User Suspension

Suspend or reactivate a Google Workspace user, for example to offboard a user, reactivate a rehire, or unlock a suspended account

This tool suspends or reactivates a user in Google Workspace. A suspended user cannot sign in to Google services. Use it to suspend a user who leaves, reactivate a rehire, or unlock a suspended account.

What this tool does

When the tool runs, it:

  1. Reads the user's current suspension reason, if the action is reactivate.
  2. Suspends or reactivates the user in Google Workspace.
  3. Returns a confirmation of the new state.

If Google gave a reason for the old suspension, the confirmation shows it as Previous suspension reason. If Google suspended the account for abuse, the reactivation can leave the cause unresolved. The tool reactivates the user in both cases.

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 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. If your organization already uses Reset Google Workspace User Password, the grant has this scope.
  • The Google admin who gave consent has the User Management admin privilege. Only a super admin can suspend or reactivate another admin.

Enable the tool

  1. Select Tools in the sidebar.
  2. In the Tool groups list, select Google.
  3. On the Google Workspace Set User Suspension row, click Enable.

Risotto names the new tool Set Google Workspace User Suspension. The tool has Approval set to Required by default, so an approver must accept each suspension or reactivation before it runs.

Tool options

  • Restrict to Requestor Only (default: off): when on, the tool can only act on the ticket requestor. It is off by default because a suspended user usually cannot ask for their own reactivation. IT staff ask for them.
ParameterRequiredDescription
email_addressYesEmail address of the Google Workspace user to suspend or reactivate.
actionYessuspend to suspend the user, or reactivate to remove the suspension.

The tool does not use the requestor's email address when email_address is empty. It fails with "An email address is required" instead.

Troubleshooting

Google is not connected for this org

Connect the Google Workspace tools connector on the Tools app card of Settings > Integrations > Google Workspace, then run the tool again.

Google refused the call

The connector grant does not include the admin.directory.user scope, or the admin who connected it does not have the User Management privilege. Click Reconnect on the connector and approve the scope. To suspend or reactivate another admin, a super admin must give the consent.

not found in Google Workspace

Make sure the email address belongs to a user in your Google Workspace domain.

Something wrong or missing? Report an issue · View as Markdown