---
title: "POST /lifecycle/user_offboarding/"
method: POST
path: "/lifecycle/user_offboarding/"
tags: ["lifecycle"]
---

# POST /lifecycle/user_offboarding/

`POST /lifecycle/user_offboarding/`

## Request body

- UserOffboardingRequest — Mixin to validate that a valid enterprise license exists before allowing to save the object
  - `user` integer, required
  - `scheduled_at` string, date-time, required — Absolute time at which the offboarding action is executed.
  - `action` 'deactivate' | 'delete'
  - `revoke_sessions` boolean — Revoke all of the user's sessions when offboarding.
  - `revoke_tokens` boolean — Revoke all of the user's tokens when offboarding.

## Response `201`

- UserOffboarding — Mixin to validate that a valid enterprise license exists before allowing to save the object
  - `id` string, uuid, required
  - `user` integer, required
  - `user_obj` PartialUser, required — Partial User Serializer, does not include child relations.
    - `pk` integer, required
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `name` string, required — User's display name.
    - `is_active` boolean — Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
    - `last_login` string, date-time, nullable
    - `email` string, email
    - `attributes` object
    - `uid` string, required
  - `scheduled_at` string, date-time, required — Absolute time at which the offboarding action is executed.
  - `action` 'deactivate' | 'delete'
  - `revoke_sessions` boolean — Revoke all of the user's sessions when offboarding.
  - `revoke_tokens` boolean — Revoke all of the user's tokens when offboarding.
  - `status` 'pending' | 'completed' | 'failed' | 'canceled', required
  - `created_by_obj` PartialUser, required — Partial User Serializer, does not include child relations.
    - `pk` integer, required
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `name` string, required — User's display name.
    - `is_active` boolean — Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
    - `last_login` string, date-time, nullable
    - `email` string, email
    - `attributes` object
    - `uid` string, required
  - `created_at` string, date-time, required
  - `executed_at` string, date-time, nullable, required

## Other responses

- `400`
- `403`

---

[API](https://skmtc.dev/goauthentik/apis/authentik.md) · [All operations](https://skmtc.dev/goauthentik/apis/authentik/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goauthentik/authentik/revisions/4e42e86021d7/schema)