---
name: usergroups-routes
description: Handle 12 OpenAPI operation(s) under /api/v1/usergroups for the usergroups route group.
---

# usergroups API Routes

Handle 12 OpenAPI operation(s) under /api/v1/usergroups for the usergroups route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### api_create_usergroup_api_v1_usergroups_post

- Operation ID: `api_create_usergroup_api_v1_usergroups_post`
- Route: `POST /api/v1/usergroups/`
- Mode: WRITE
- Summary: Create a usergroup
- Body: JSON request body accepted.

### api_get_usergroups_api_v1_usergroups_org_org_id_get

- Operation ID: `api_get_usergroups_api_v1_usergroups_org_org_id_get`
- Route: `GET /api/v1/usergroups/org/{org_id}`
- Mode: READ
- Summary: List usergroups for an organization
- Parameters:
  - `org_id` in `path` required

### api_get_usergroupsby_resource_api_v1_usergroups_resou_65ed5ed760

- Operation ID: `api_get_usergroupsby_resource_api_v1_usergroups_resource_resource_uuid_get`
- Route: `GET /api/v1/usergroups/resource/{resource_uuid}`
- Mode: READ
- Summary: List usergroups linked to a resource
- Parameters:
  - `resource_uuid` in `path` required

### api_delete_usergroup_api_v1_usergroups_usergroup_id_delete

- Operation ID: `api_delete_usergroup_api_v1_usergroups_usergroup_id_delete`
- Route: `DELETE /api/v1/usergroups/{usergroup_id}`
- Mode: WRITE
- Summary: Delete a usergroup
- Parameters:
  - `usergroup_id` in `path` required

### api_get_usergroup_api_v1_usergroups_usergroup_id_get

- Operation ID: `api_get_usergroup_api_v1_usergroups_usergroup_id_get`
- Route: `GET /api/v1/usergroups/{usergroup_id}`
- Mode: READ
- Summary: Get a usergroup
- Parameters:
  - `usergroup_id` in `path` required

### api_update_usergroup_api_v1_usergroups_usergroup_id_put

- Operation ID: `api_update_usergroup_api_v1_usergroups_usergroup_id_put`
- Route: `PUT /api/v1/usergroups/{usergroup_id}`
- Mode: WRITE
- Summary: Update a usergroup
- Parameters:
  - `usergroup_id` in `path` required
- Body: JSON request body accepted.

### api_add_resources_to_usergroup_api_v1_usergroups_user_b634bb257c

- Operation ID: `api_add_resources_to_usergroup_api_v1_usergroups_usergroup_id_add_resources_post`
- Route: `POST /api/v1/usergroups/{usergroup_id}/add_resources`
- Mode: WRITE
- Summary: Add resources to a usergroup
- Parameters:
  - `usergroup_id` in `path` required
  - `resource_uuids` in `query` required

### api_add_users_to_usergroup_api_v1_usergroups_usergrou_580b980b98

- Operation ID: `api_add_users_to_usergroup_api_v1_usergroups_usergroup_id_add_users_post`
- Route: `POST /api/v1/usergroups/{usergroup_id}/add_users`
- Mode: WRITE
- Summary: Add users to a usergroup
- Parameters:
  - `usergroup_id` in `path` required
  - `user_ids` in `query` required

### api_delete_resources_from_usergroup_api_v1_usergroups_1f25c6c66f

- Operation ID: `api_delete_resources_from_usergroup_api_v1_usergroups_usergroup_id_remove_resour`
- Route: `DELETE /api/v1/usergroups/{usergroup_id}/remove_resources`
- Mode: WRITE
- Summary: Remove resources from a usergroup
- Parameters:
  - `usergroup_id` in `path` required
  - `resource_uuids` in `query` required

### api_delete_users_from_usergroup_api_v1_usergroups_use_976c3491af

- Operation ID: `api_delete_users_from_usergroup_api_v1_usergroups_usergroup_id_remove_users_dele`
- Route: `DELETE /api/v1/usergroups/{usergroup_id}/remove_users`
- Mode: WRITE
- Summary: Remove users from a usergroup
- Parameters:
  - `usergroup_id` in `path` required
  - `user_ids` in `query` required

### api_get_resources_linked_to_usergroup_api_v1_usergrou_503b3fdf32

- Operation ID: `api_get_resources_linked_to_usergroup_api_v1_usergroups_usergroup_id_resources_g`
- Route: `GET /api/v1/usergroups/{usergroup_id}/resources`
- Mode: READ
- Summary: List resources linked to a usergroup
- Parameters:
  - `usergroup_id` in `path` required

### api_get_users_linked_to_usergroup_api_v1_usergroups_u_9d301543fb

- Operation ID: `api_get_users_linked_to_usergroup_api_v1_usergroups_usergroup_id_users_get`
- Route: `GET /api/v1/usergroups/{usergroup_id}/users`
- Mode: READ
- Summary: List users in a usergroup
- Parameters:
  - `usergroup_id` in `path` required