Skip to main content
DELETE
DELETE /v1/users/{id}

Delete a User

Delete a user by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

Delete by ID

id
string
required
UUID of the user to delete.
recursive
boolean
default:"false"
Recursively delete child entities.
hardDelete
boolean
default:"false"
Permanently delete the user. If false, the user is soft-deleted and can be restored.

Delete by Name

Use DELETE /v1/users/name/{fqn} to delete by fully qualified name.
fqn
string
required
Fully qualified name of the user (e.g., aaron_johnson0).
recursive
boolean
default:"false"
Recursively delete child entities.
hardDelete
boolean
default:"false"
Permanently delete the user.

Restore a Soft-Deleted User

Use PUT /v1/users/restore to restore a soft-deleted user.
id
string
required
UUID of the soft-deleted user to restore.
DELETE /v1/users/{id}

Returns

Soft delete returns the user object with deleted: true. Hard delete returns no content (204). Restore returns the restored user object.

Error Handling