user
admin

offboard a workspace user (reassign objects, optionally delete user)

post/w/{workspace}/users/offboard/{username}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/users/offboard/{username}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
usernamestring required

Request body

reassign_tostring required

Target for reassignment: 'u/{username}' or 'f/{folder}'

new_on_behalf_of_userstring

Required when reassign_to is a folder. The username whose identity will be used as permissioned_as for schedules and triggers.

delete_userboolean

Whether to also remove the user from the workspace

Response

offboard response with conflicts or summary

conflictsstring[]

List of path conflicts that block the offboarding. Empty on success.

Changes

No recorded changes to this operation across all 297 revisions of this API.