55 lines
1.5 KiB
Markdown
55 lines
1.5 KiB
Markdown
---
|
|
name: group-memberships-routes
|
|
description: Handle 4 OpenAPI operation(s) under /group_memberships for the group memberships route group.
|
|
---
|
|
|
|
# group memberships API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /group_memberships for the group memberships 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
|
|
|
|
### post_group_memberships
|
|
|
|
- Operation ID: `post_group_memberships`
|
|
- Route: `POST /group_memberships`
|
|
- Mode: WRITE
|
|
- Summary: Add user to group
|
|
- Parameters:
|
|
- `fields` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_group_memberships_id
|
|
|
|
- Operation ID: `get_group_memberships_id`
|
|
- Route: `GET /group_memberships/{group_membership_id}`
|
|
- Mode: READ
|
|
- Summary: Get group membership
|
|
- Parameters:
|
|
- `group_membership_id` in `path` required
|
|
- `fields` in `query`
|
|
|
|
### put_group_memberships_id
|
|
|
|
- Operation ID: `put_group_memberships_id`
|
|
- Route: `PUT /group_memberships/{group_membership_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update group membership
|
|
- Parameters:
|
|
- `group_membership_id` in `path` required
|
|
- `fields` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_group_memberships_id
|
|
|
|
- Operation ID: `delete_group_memberships_id`
|
|
- Route: `DELETE /group_memberships/{group_membership_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove user from group
|
|
- Parameters:
|
|
- `group_membership_id` in `path` required
|