Offboard a User
A 3-step recipe with Google Workspace. We can help you get access.
Recipe · 3 steps
Offboard a User
with Google Workspace · Identity & Access Management
Suspend a user, revoke their sessions, and verify the suspension.
- Patch the user to a suspended state so they can no longer sign in, while leaving the rest of the profile intact.
- Sign the user out of all active web and device sessions and reset their sign-in cookies to immediately revoke access.
- Read the user back to confirm the suspended flag is set before completing the offboarding flow.
What you'll need to have ready
- accessToken: OAuth 2.0 bearer access token with the admin.directory.user scope.
- userKey: Primary email, alias, or unique id of the user to offboard.
- suspensionReason: Optional note recorded as the reason for suspension.
For your developer
Arazzo workflow google-workspace:offboard-user, 3 operations: patchUser → signOutUser → getUser. Specs on APIs.io.