Sign in
Administration - Users

Orphan a user from their organization

Remove a user from their current organization and assign them orphan status.

This operation:

  • Removes the user from their current organization
  • Invalidates all current user roles
  • Assigns the 'orphaned_user' role
  • Preserves user account for potential future organization assignment

Authentication Required: Yes Permissions: Administrative permissions required

Use Cases:

  • User leaving an organization
  • Administrative account cleanup
  • Preparing user for organization transfer

Warning: This is a destructive operation that affects user access.

patch/users/{id}/orphan

Request body

idinteger
first_namestring required

User first name.

last_namestring required

User last name.

referring_userinteger nullable

User who referred this user.

organizationinteger nullable

Organization to which the user belongs.

Response

OK

idinteger
emailstring email

User's email address (used for login and communications)

first_namestring

User's first name

last_namestring

User's last name

rolesinteger[]

Roles associated with the user.

active_rolesstring

Approved active role IDs for this user

pending_rolesstring

Role IDs the user has requested but not yet been approved/rejected

mobilestring nullable

User cell phone number.

socialobject nullable

Social media account information.

lineageinteger[] nullable

Lineage of user IDs who referred the current user.

statesstring

Application state for the user etc map viewport, etc.

preferencesobject

User preferences and settings (write-only)

internal_stateobject nullable

Internal state for limits, quotas, and admin-managed settings. Admin-only field.

primary_languageinteger nullable

Primary language of the user.

secondary_languageinteger nullable

Secondary language of the user.

referring_userinteger nullable

User who referred this user.

accepted_termsboolean nullable

Indicates whether the user has accepted the terms.

accepted_terms_timestampstring date-time nullable

Timestamp when the user accepted the terms.

last_sign_in_atstring date-time nullable

Timestamp of the previous login.

current_sign_in_atstring date-time nullable

Timestamp of the current login.

sign_in_countinteger

Total number of times the user has logged in.

Changes