Start-CIPPUserOffboarding.md

Start-CIPPUserOffboarding

SYNOPSIS

Starts an offboarding job for a user in the specified tenant.

DESCRIPTION

The Start-CIPPOffboardingJob function initiates the offboarding process for a user, handling various cleanup tasks like removing licenses and revoking sessions.

PARAMETERS

-CustomerTenantID

The ID of the customer tenant. If not provided, the default tenant is used.

-UserID

The ID of the user to be offboarded.

-ConvertToSharedMailbox

\

-HideFromGAL

Hide the user from the Global Address List.

-RemoveCalendarInvites

Remove all calendar invites for the user.

-RemovePermissions

Remove all mailbox permissions.

-RemoveRules

Remove all mailbox rules.

-RemoveMobileDevices

\

-RemoveGroups

Remove the user from all groups.

-RemoveLicenses

Remove all licenses assigned to the user.

-RevokeSessions

Revoke all active sessions for the user.

-DisableSignIn

Disable the user's sign-in capability.

-ClearImmutableId

Clear the immutable ID for the user.

-ResetPass

Reset the user's password.

-RemoveMFADevices

Remove all MFA devices associated with the user.

-DeleteUser

Delete the user account.

-OnedriveAccess

Grant OneDrive access to specified users.

-FullAccessNoAutomap

\

-FullAccessAutomap

\

-OutOfOffice

\

-ForwardTo

\

-KeepCopy

\

EXAMPLE 1

PS > Start-CIPPOffboardingJob -CustomerTenantID "7ced1621-b8f7-4231-868c-bc6b1a2f1778" -UserID "98765432-1234-5678-9012-34567890ABCD" -RevokeSessions -RemoveGroups -DeleteUser