CIPP.app icon

CIPP.app

Manage Microsoft 365 tenants via CIPP.app

Actions619

User → Offboard

AI-generated

Summary

Offboards one or more users in the selected tenant by running the chosen offboarding actions immediately or scheduling them for later. The operation can also send configured post-execution notifications and attach a reference to the notification title or scheduled task.

Inputs

  • Tenant (required) — Select a tenant from the list or enter its default domain.
  • Users to Offboard (required) — JSON array of user objects to submit for offboarding.
  • Scheduled Offboard — When enabled, schedules the offboarding instead of running it immediately; requires Scheduled Time.
  • Scheduled Time (required) — Date and time to run the offboarding when scheduling is enabled.
  • Offboard Options — Choose actions such as blocking sign-in, revoking sessions, resetting passwords, removing groups or licenses, converting to a shared mailbox, setting out-of-office or forwarding, granting mailbox or OneDrive access, and optionally deleting the user. Defaults are off or empty.
  • Post-Execution Notifications — Choose whether to send results through configured email, PSA, or webhook notifications.
  • Reference — Reference included in the notification title and scheduled task.

Output shape

A single API response containing the offboarding result or scheduled task details.

The exact response fields depend on the CIPP API response. Offboarding actions and notifications depend on the options selected and the CIPP instance configuration.

Links

Discussion