cipp_offboard_user
Offboard a user irreversibly by disabling the account, revoking sessions, removing group memberships, and optionally transferring mailbox data.
Instructions
⚠ DESTRUCTIVE — IRREVERSIBLE. Completely offboards a user by disabling their account, revoking sessions, removing group memberships, and optionally transferring data. This comprehensive action cannot be easily undone. Confirm with the user before invoking.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The target user's Azure AD object ID or User Principal Name (UPN, e.g. alice@contoso.com). | |
| disableUser | No | When true, disables the Azure AD account so the user can no longer sign in. | |
| tenantFilter | Yes | Tenant domain name or ID to scope the operation. Use 'allTenants' to target every managed tenant. | |
| resetPassword | No | When true, resets the account password as part of the offboarding flow. | |
| transferMailbox | No | UPN of the recipient who should receive the offboarded mailbox contents via a mailbox export / auto-forward. Omit to skip mailbox transfer. | |
| revokePermissions | No | When true, removes the user from all groups and strips delegated mailbox and SharePoint permissions. |