97 lines
2.2 KiB
Markdown
97 lines
2.2 KiB
Markdown
---
|
|
name: groups-routes
|
|
description: Handle 8 OpenAPI operation(s) under /groups for the groups route group.
|
|
---
|
|
|
|
# groups API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /groups for the groups 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
|
|
|
|
### get_groups
|
|
|
|
- Operation ID: `get_groups`
|
|
- Route: `GET /groups`
|
|
- Mode: READ
|
|
- Summary: List groups for enterprise
|
|
- Parameters:
|
|
- `filter_term` in `query`
|
|
- `fields` in `query`
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
|
|
### post_groups
|
|
|
|
- Operation ID: `post_groups`
|
|
- Route: `POST /groups`
|
|
- Mode: WRITE
|
|
- Summary: Create group
|
|
- Parameters:
|
|
- `fields` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_groups_terminate_sessions
|
|
|
|
- Operation ID: `post_groups_terminate_sessions`
|
|
- Route: `POST /groups/terminate_sessions`
|
|
- Mode: WRITE
|
|
- Summary: Create jobs to terminate user group session
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_groups_id
|
|
|
|
- Operation ID: `get_groups_id`
|
|
- Route: `GET /groups/{group_id}`
|
|
- Mode: READ
|
|
- Summary: Get group
|
|
- Parameters:
|
|
- `group_id` in `path` required
|
|
- `fields` in `query`
|
|
|
|
### put_groups_id
|
|
|
|
- Operation ID: `put_groups_id`
|
|
- Route: `PUT /groups/{group_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update group
|
|
- Parameters:
|
|
- `group_id` in `path` required
|
|
- `fields` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_groups_id
|
|
|
|
- Operation ID: `delete_groups_id`
|
|
- Route: `DELETE /groups/{group_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove group
|
|
- Parameters:
|
|
- `group_id` in `path` required
|
|
|
|
### get_groups_id_memberships
|
|
|
|
- Operation ID: `get_groups_id_memberships`
|
|
- Route: `GET /groups/{group_id}/memberships`
|
|
- Mode: READ
|
|
- Summary: List members of group
|
|
- Parameters:
|
|
- `group_id` in `path` required
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
|
|
### get_groups_id_collaborations
|
|
|
|
- Operation ID: `get_groups_id_collaborations`
|
|
- Route: `GET /groups/{group_id}/collaborations`
|
|
- Mode: READ
|
|
- Summary: List group collaborations
|
|
- Parameters:
|
|
- `group_id` in `path` required
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|