user

offboard a user globally (reassign objects across workspaces, optionally delete)

post/users/offboard/{email}

Request

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

Path parameters

emailstring required

Request body

reassignmentsobject

Map of workspace_id to reassignment config

delete_userboolean

Whether to also remove the user from the instance

Response

offboard result

conflictsstring[]

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

Changes

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