Przeglądaj źródła

doc: document /group/list

KernelDeimos 10 miesięcy temu
rodzic
commit
de7e2adabd
1 zmienionych plików z 35 dodań i 0 usunięć
  1. 35 0
      doc/api/group.md

+ 35 - 0
doc/api/group.md

@@ -109,6 +109,41 @@ await fetch(`${window.api_origin}/group/add-users`, {
 });
 });
 ```
 ```
 
 
+## GET `/group/list`
+
+### Description
+
+List groups associated with the current user
+
+### Parameters
+
+_none_
+
+### Response Example
+
+```json
+{
+    "owned_groups": [
+        {
+            "uid": "c3bd4047-fc65-4da8-9363-e52195890de4",
+            "metadata": {},
+            "members": [
+                "default_user"
+            ]
+        }
+    ],
+    "in_groups": [
+        {
+            "uid": "c3bd4047-fc65-4da8-9363-e52195890de4",
+            "metadata": {},
+            "members": [
+                "default_user"
+            ]
+        }
+    ]
+}
+```
+
 # Group Permission Endpoints
 # Group Permission Endpoints
 
 
 ## POST `/grant-user-group`
 ## POST `/grant-user-group`