admin
users
Offboard User
Revoke a departed employee's access and remove them from internal lists.
Disables the PropelAuth account, then soft-deletes auth.user. Both are needed: soft-deleting alone hides someone who can still sign in, and disabling alone leaves them in every internal work-list permanently.
Idempotent — offboarding an already-offboarded user returns them unchanged.
post/admin/users/{user_id}/offboard
Request
- Base URLhttps://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
- Auth
- API key in header x-api-key
- or HTTP bearer
Path parameters
user_idstring required
Headers
organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable
Response
Successful Response
User required
Changes
No recorded changes to this operation across all 1 revision of this API.