add user group examples

Author: x-eun

basics/user_management.ipynb

@@ -54,7 +54,8 @@
       "outputs": [],
       "source": [
         "import labelbox as lb\n",
-        "import os"
+        "import os\n",
+        "from labelbox.schema.user_group import UserGroup, UserGroupColor"
       ]
     },
     {
@@ -257,6 +258,126 @@
         "organization.remove_user(user)"
       ]
     },
+    {
+      "cell_type": "markdown",
+      "id": "5d62aa21",
+      "metadata": {},
+      "source": [
+        "## Manage user groups\n",
+        "### Create user groups"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "69a5a82e",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# Define a user group\n",
+        "user_group = UserGroup(\n",
+        "    client=client,\n",
+        "    name=\"New User Group\",\n",
+        "    color=UserGroupColor.BLUE\n",
+        "    users=set(user, user1, user2),\n",
+        "    projects=set(project)\n",
+        ")\n",
+        "\n",
+        "# Create the defined user group\n",
+        "created_group = user_group.create() "
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "id": "b9edbdfd",
+      "metadata": {},
+      "source": [
+        "### Update user groups"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "062b8006",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# Define the user group properties to be updated\n",
+        "user_group.name = \"Updated User Group Name\"\n",
+        "user_group.color = UserGroupColor.GREEN\n",
+        "\n",
+        "# Add new projects to the group\n",
+        "projects = []\n",
+        "projects.append(user_group.projects)\n",
+        "projects.append([project_1, project_2])\n",
+        "user_group.projects = projects\n",
+        "\n",
+        "# Add new users to the group\n",
+        "\n",
+        "users = user_group.users\n",
+        "users.append([new_user_1, new_user_2])\n",
+        "user_group.users = users\n",
+        "\n",
+        "# Push the changes to the group\n",
+        "user_group.update()"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "ce016ffb",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "## Remove all members and projects from the group\n",
+        "user_group.users = []\n",
+        "user_group.projects = []\n",
+        "user_group.update()\n",
+        "\n",
+        "# Push the changes to the group\n",
+        "user_group.update()"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "7560a5cb",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# Delete a user group\n",
+        "user_group.delete()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "id": "047a83dc",
+      "metadata": {},
+      "source": [
+        "## Get user group info"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "d3e18466",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# Get info of a user group\n",
+        "user_group.get()\n",
+        "\n",
+        "# Get all user groups in your workspace\n",
+        "user_groups = UserGroup(client).get_user_groups()\n",
+        "\n",
+        "# Search for a user group by its name\n",
+        "example_group = next((group for group in user_groups if group.name == \"example_name\"), None)\n",
+        "if example_group:\n",
+        "    print(f\"Found user group 'example_name' with ID: {example_group.id}\")\n",
+        "else:\n",
+        "    print(\"No user group named 'example_name' found\")"
+      ]
+    },
     {
       "cell_type": "markdown",
       "metadata": {},