You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1487f44
Browse filesBrowse the repository at this point in the historyBrowse files
Delete an organization.**Requires superuser access.**
2
2
3
-
Permanently deletes an organization and all associated data.
3
+
Supports two delete modes, selected by an optional request body:
4
+
5
+
```json
6
+
{ "hard_delete": false }
7
+
```
8
+
9
+
-**`hard_delete: false` (default)** — *Soft delete.* The organization is marked **inactive** and all of its projects are deactivated as well. No data is removed, so the organization can be reactivated later. It simply stops appearing in listings and can no longer be used. Omitting the body entirely also performs a soft delete.
10
+
-**`hard_delete: true`** — *Permanent delete.* The organization and everything owned by it — projects, collections, documents, credentials, assistants, fine-tunings, conversations, and user-project mappings — are permanently removed. **This cannot be undone.**
11
+
12
+
In both modes, user **accounts are never deleted** (a user may belong to other organizations). Any user left without an active project afterwards is marked **inactive** and can no longer log in until they are added to an active project again.
Returns paginated list of all organizations in the system. The response includes a `has_more` field in `metadata` indicating whether additional pages are available.
3
+
Returns a paginated list of organizations. The response includes a `has_more` field in `metadata` indicating whether additional pages are available.
4
+
5
+
**Query Parameters:**
6
+
-`search` (optional): Case-insensitive substring match on the organization **name**. For example, `?search=acme` returns every organization whose name contains "acme".
7
+
-`is_active` (optional, default `true`): Filter by active status. Pass `false` to list soft-deleted organizations.
8
+
-`skip` (optional, default `0`): Number of records to skip for pagination.
9
+
-`limit` (optional, default `100`, max `100`): Maximum number of records to return.
Permanently deletes a project and all associated data including documents, collections, and configurations.
3
+
Supports two delete modes, selected by an optional request body:
4
+
5
+
```json
6
+
{ "hard_delete": false }
7
+
```
8
+
9
+
-**`hard_delete: false` (default)** — *Soft delete.* The project is marked **inactive**. No data is removed, so the project can be reactivated later. It simply stops appearing in listings and can no longer be used. Omitting the body entirely also performs a soft delete.
10
+
-**`hard_delete: true`** — *Permanent delete.* The project and everything owned by it — collections, documents, credentials, assistants, fine-tunings, conversations, and user-project mappings — are permanently removed. **This cannot be undone.**
11
+
12
+
In both modes, user **accounts are never deleted** (a user may belong to other projects). Any user left without an active project afterwards is marked **inactive** and can no longer log in until they are added to an active project again.
List projects across all organizations. **Requires superuser access.**
2
2
3
-
Returns paginated list of all projects across all organizations.
3
+
Returns a paginated list of projects. The response includes a `has_more` field in `metadata` indicating whether additional pages are available.
4
+
5
+
**Query Parameters:**
6
+
-`search` (optional): Case-insensitive substring match on the project **name**. For example, `?search=onboarding` returns every project whose name contains "onboarding".
7
+
-`is_active` (optional, default `true`): Filter by active status. Pass `false` to list soft-deleted projects.
8
+
-`skip` (optional, default `0`): Number of records to skip for pagination.
9
+
-`limit` (optional, default `100`, max `100`): Maximum number of records to return.
List projects for a given organization.**Requires superuser access.**
2
2
3
-
Returns all projects belonging to the specified organization ID. The organization must exist and be active.
3
+
Returns the projects belonging to the specified organization ID. The organization must exist and be active.
4
+
5
+
**Query Parameters:**
6
+
-`search` (optional): Case-insensitive substring match on the project **name**. For example, `?search=onboarding` returns only projects whose name contains "onboarding".
7
+
-`is_active` (optional, default `true`): Filter by active status. Pass `false` to list soft-deleted projects (e.g. to selectively reactivate them).
Copy file name to clipboardExpand all lines: backend/app/api/docs/user_project/delete.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,4 +6,4 @@ Remove a user from a project. **Requires superuser access.**
6
6
**Query Parameters:**
7
7
-`project_id` (required): The ID of the project to remove the user from.
8
8
9
-
This only removes the user-project mapping — the user account itself is not deleted. You cannot remove yourself from a project.
9
+
This only removes the user-project mapping — the user account itself is never deleted. If this was the user's last project, the account is marked **inactive** and can no longer log in until they are added to a project again. You cannot remove yourself from a project.
0 commit comments