47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
---
|
|
name: directories-routes
|
|
description: Handle 3 OpenAPI operation(s) under /api/v1/directories/{appInstanceId}/groups for the directories route group.
|
|
---
|
|
|
|
# directories API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /api/v1/directories/{appInstanceId}/groups for the directories 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
|
|
|
|
### update_group_membership
|
|
|
|
- Operation ID: `update_group_membership`
|
|
- Route: `POST /api/v1/directories/{appInstanceId}/groups/modify`
|
|
- Mode: WRITE
|
|
- Summary: Update an external directory group membership
|
|
- Parameters:
|
|
- `appInstanceId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### submit_group_attribute_query
|
|
|
|
- Operation ID: `submit_group_attribute_query`
|
|
- Route: `POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query`
|
|
- Mode: WRITE
|
|
- Summary: Submit a query for AD Group
|
|
- Parameters:
|
|
- `appInstanceId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_group_attribute_query_result
|
|
|
|
- Operation ID: `get_group_attribute_query_result`
|
|
- Route: `GET /api/v1/directories/{appInstanceId}/groups/{groupId}/query/{resultId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve the results of an AD group query
|
|
- Parameters:
|
|
- `appInstanceId` in `path` required
|
|
- `groupId` in `path` required
|
|
- `resultId` in `path` required
|