Remove User
remove_userRemove a user from a tenant, revoking their access to it. This is IRREVERSIBLE and REQUIRES CONFIRMATION: resolve the user first, then call again with confirm set to the exact email address — and only after the user has explicitly agreed to the removal. If access should merely be suspended, call update_user with enabled=false instead, which can be undone. Fails without removing anything when the tenant or email does not resolve to exactly one record, or the confirmation does not match. dryRun: true previews it first — whether their login account goes too (it does when this is their only workspace) and whether they are the last owner — without removing anything or needing confirm. Before writing app code that consumes this, call get_integration_guide with topic=team and the framework the app uses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Id of the Bridge app to act on for this call (see list_apps). Omit to use the current app. | |
| Yes | Email address of the user to remove, as list_users shows it. | ||
| dryRun | No | true previews what the deletion would affect and deletes nothing — no confirm needed. Do this first and show the user the result. Needs the same privilege as the deletion itself. | |
| confirm | No | Repeat the exact key of the resource being deleted, as confirmation. Required to delete; not needed with dryRun. This is a deliberate safety step — do NOT guess it or copy it from a fuzzy match. If you are not certain, list the resources first and ask the user which one they mean. | |
| tenantName | Yes | Tenant NAME from list_tenants (a tenant id is accepted as a fallback). |