lifecycle

post/lifecycle/user_offboarding/

Request body

userinteger required
scheduled_atstring date-time required

Absolute time at which the offboarding action is executed.

action'deactivate' | 'delete'
revoke_sessionsboolean

Revoke all of the user's sessions when offboarding.

revoke_tokensboolean

Revoke all of the user's tokens when offboarding.

Response

idstring uuid required
userinteger required
scheduled_atstring date-time required

Absolute time at which the offboarding action is executed.

action'deactivate' | 'delete'
revoke_sessionsboolean

Revoke all of the user's sessions when offboarding.

revoke_tokensboolean

Revoke all of the user's tokens when offboarding.

status'pending' | 'completed' | 'failed' | 'canceled' required
created_atstring date-time required
executed_atstring date-time nullable required

Changes

No recorded changes to this endpoint across all 1 revision of this API.