342 lines
9.1 KiB
Markdown
342 lines
9.1 KiB
Markdown
---
|
|
name: groups-routes
|
|
description: Handle 31 OpenAPI operation(s) under /api/v1/groups for the groups route group.
|
|
---
|
|
|
|
# groups API Routes
|
|
|
|
Handle 31 OpenAPI operation(s) under /api/v1/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
|
|
|
|
### list_groups
|
|
|
|
- Operation ID: `list_groups`
|
|
- Route: `GET /api/v1/groups`
|
|
- Mode: READ
|
|
- Summary: List all groups
|
|
- Parameters:
|
|
- `search` in `query`
|
|
- `filter` in `query`
|
|
- `q` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `expand` in `query`
|
|
- `sortBy` in `query`
|
|
- `sortOrder` in `query`
|
|
|
|
### add_group
|
|
|
|
- Operation ID: `add_group`
|
|
- Route: `POST /api/v1/groups`
|
|
- Mode: WRITE
|
|
- Summary: Add a group
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_group_rules
|
|
|
|
- Operation ID: `list_group_rules`
|
|
- Route: `GET /api/v1/groups/rules`
|
|
- Mode: READ
|
|
- Summary: List all group rules
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `search` in `query`
|
|
- `expand` in `query`
|
|
|
|
### create_group_rule
|
|
|
|
- Operation ID: `create_group_rule`
|
|
- Route: `POST /api/v1/groups/rules`
|
|
- Mode: WRITE
|
|
- Summary: Create a group rule
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_group_rule
|
|
|
|
- Operation ID: `get_group_rule`
|
|
- Route: `GET /api/v1/groups/rules/{groupRuleId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a group rule
|
|
- Parameters:
|
|
- `groupRuleId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### replace_group_rule
|
|
|
|
- Operation ID: `replace_group_rule`
|
|
- Route: `PUT /api/v1/groups/rules/{groupRuleId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a group rule
|
|
- Parameters:
|
|
- `groupRuleId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_group_rule
|
|
|
|
- Operation ID: `delete_group_rule`
|
|
- Route: `DELETE /api/v1/groups/rules/{groupRuleId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a group rule
|
|
- Parameters:
|
|
- `groupRuleId` in `path` required
|
|
- `removeUsers` in `query`
|
|
|
|
### activate_group_rule
|
|
|
|
- Operation ID: `activate_group_rule`
|
|
- Route: `POST /api/v1/groups/rules/{groupRuleId}/lifecycle/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate a group rule
|
|
- Parameters:
|
|
- `groupRuleId` in `path` required
|
|
|
|
### deactivate_group_rule
|
|
|
|
- Operation ID: `deactivate_group_rule`
|
|
- Route: `POST /api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate a group rule
|
|
- Parameters:
|
|
- `groupRuleId` in `path` required
|
|
|
|
### get_group
|
|
|
|
- Operation ID: `get_group`
|
|
- Route: `GET /api/v1/groups/{groupId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a group
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
|
|
### replace_group
|
|
|
|
- Operation ID: `replace_group`
|
|
- Route: `PUT /api/v1/groups/{groupId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a group
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_group
|
|
|
|
- Operation ID: `delete_group`
|
|
- Route: `DELETE /api/v1/groups/{groupId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a group
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
|
|
### list_assigned_applications_for_group
|
|
|
|
- Operation ID: `list_assigned_applications_for_group`
|
|
- Route: `GET /api/v1/groups/{groupId}/apps`
|
|
- Mode: READ
|
|
- Summary: List all assigned apps
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### list_group_owners
|
|
|
|
- Operation ID: `list_group_owners`
|
|
- Route: `GET /api/v1/groups/{groupId}/owners`
|
|
- Mode: READ
|
|
- Summary: List all group owners
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `search` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### assign_group_owner
|
|
|
|
- Operation ID: `assign_group_owner`
|
|
- Route: `POST /api/v1/groups/{groupId}/owners`
|
|
- Mode: WRITE
|
|
- Summary: Assign a group owner
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_group_owner
|
|
|
|
- Operation ID: `delete_group_owner`
|
|
- Route: `DELETE /api/v1/groups/{groupId}/owners/{ownerId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a group owner
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `ownerId` in `path` required
|
|
|
|
### list_group_assigned_roles
|
|
|
|
- Operation ID: `list_group_assigned_roles`
|
|
- Route: `GET /api/v1/groups/{groupId}/roles`
|
|
- Mode: READ
|
|
- Summary: List all group role assignments
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### assign_role_to_group
|
|
|
|
- Operation ID: `assign_role_to_group`
|
|
- Route: `POST /api/v1/groups/{groupId}/roles`
|
|
- Mode: WRITE
|
|
- Summary: Assign a role to a group
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `disableNotifications` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_group_assigned_role
|
|
|
|
- Operation ID: `get_group_assigned_role`
|
|
- Route: `GET /api/v1/groups/{groupId}/roles/{roleAssignmentId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a group role assignment
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
|
|
### unassign_role_from_group
|
|
|
|
- Operation ID: `unassign_role_from_group`
|
|
- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign a group role
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
|
|
### list_application_targets_for_application_administrator_role_for_group
|
|
|
|
- Operation ID: `list_application_targets_for_application_administrator_role_for_group`
|
|
- Route: `GET /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps`
|
|
- Mode: READ
|
|
- Summary: List all group role app targets
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### assign_app_target_to_admin_role_for_group
|
|
|
|
- Operation ID: `assign_app_target_to_admin_role_for_group`
|
|
- Route: `PUT /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}`
|
|
- Mode: WRITE
|
|
- Summary: Assign a group role app target
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `appName` in `path` required
|
|
|
|
### unassign_app_target_to_admin_role_for_group
|
|
|
|
- Operation ID: `unassign_app_target_to_admin_role_for_group`
|
|
- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign a group role app target
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `appName` in `path` required
|
|
|
|
### assign_app_instance_target_to_app_admin_role_for_group
|
|
|
|
- Operation ID: `assign_app_instance_target_to_app_admin_role_for_group`
|
|
- Route: `PUT /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}`
|
|
- Mode: WRITE
|
|
- Summary: Assign a group role app instance target
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `appName` in `path` required
|
|
- `appId` in `path` required
|
|
|
|
### unassign_app_instance_target_to_app_admin_role_for_group
|
|
|
|
- Operation ID: `unassign_app_instance_target_to_app_admin_role_for_group`
|
|
- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign a group role app instance target
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `appName` in `path` required
|
|
- `appId` in `path` required
|
|
|
|
### list_group_targets_for_group_role
|
|
|
|
- Operation ID: `list_group_targets_for_group_role`
|
|
- Route: `GET /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups`
|
|
- Mode: READ
|
|
- Summary: List all group role group targets
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### assign_group_target_to_group_admin_role
|
|
|
|
- Operation ID: `assign_group_target_to_group_admin_role`
|
|
- Route: `PUT /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}`
|
|
- Mode: WRITE
|
|
- Summary: Assign a group role group target
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `targetGroupId` in `path` required
|
|
|
|
### unassign_group_target_from_group_admin_role
|
|
|
|
- Operation ID: `unassign_group_target_from_group_admin_role`
|
|
- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign a group role group target
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `roleAssignmentId` in `path` required
|
|
- `targetGroupId` in `path` required
|
|
|
|
### list_group_users
|
|
|
|
- Operation ID: `list_group_users`
|
|
- Route: `GET /api/v1/groups/{groupId}/users`
|
|
- Mode: READ
|
|
- Summary: List all member users
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### assign_user_to_group
|
|
|
|
- Operation ID: `assign_user_to_group`
|
|
- Route: `PUT /api/v1/groups/{groupId}/users/{userId}`
|
|
- Mode: WRITE
|
|
- Summary: Assign a user to a group
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `userId` in `path` required
|
|
|
|
### unassign_user_from_group
|
|
|
|
- Operation ID: `unassign_user_from_group`
|
|
- Route: `DELETE /api/v1/groups/{groupId}/users/{userId}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign a user from a group
|
|
- Parameters:
|
|
- `groupId` in `path` required
|
|
- `userId` in `path` required
|