402 lines
11 KiB
Markdown
402 lines
11 KiB
Markdown
---
|
|
name: iam-routes
|
|
description: Handle 40 OpenAPI operation(s) under /api/v1/iam for the iam route group.
|
|
---
|
|
|
|
# iam API Routes
|
|
|
|
Handle 40 OpenAPI operation(s) under /api/v1/iam for the iam 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_users_with_role_assignments
|
|
|
|
- Operation ID: `list_users_with_role_assignments`
|
|
- Route: `GET /api/v1/iam/assignees/users`
|
|
- Mode: READ
|
|
- Summary: List all users with role assignments
|
|
- Parameters:
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### list_governance_bundles
|
|
|
|
- Operation ID: `list_governance_bundles`
|
|
- Route: `GET /api/v1/iam/governance/bundles`
|
|
- Mode: READ
|
|
- Summary: List all governance bundles
|
|
- Parameters:
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### create_governance_bundle
|
|
|
|
- Operation ID: `create_governance_bundle`
|
|
- Route: `POST /api/v1/iam/governance/bundles`
|
|
- Mode: WRITE
|
|
- Summary: Create a governance bundle
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_governance_bundle
|
|
|
|
- Operation ID: `get_governance_bundle`
|
|
- Route: `GET /api/v1/iam/governance/bundles/{bundleId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a governance bundle
|
|
- Parameters:
|
|
- `bundleId` in `path` required
|
|
|
|
### replace_governance_bundle
|
|
|
|
- Operation ID: `replace_governance_bundle`
|
|
- Route: `PUT /api/v1/iam/governance/bundles/{bundleId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a governance bundle
|
|
- Parameters:
|
|
- `bundleId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_governance_bundle
|
|
|
|
- Operation ID: `delete_governance_bundle`
|
|
- Route: `DELETE /api/v1/iam/governance/bundles/{bundleId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a governance bundle
|
|
- Parameters:
|
|
- `bundleId` in `path` required
|
|
|
|
### list_bundle_entitlements
|
|
|
|
- Operation ID: `list_bundle_entitlements`
|
|
- Route: `GET /api/v1/iam/governance/bundles/{bundleId}/entitlements`
|
|
- Mode: READ
|
|
- Summary: List all entitlements for a governance bundle
|
|
- Parameters:
|
|
- `bundleId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### list_bundle_entitlement_values
|
|
|
|
- Operation ID: `list_bundle_entitlement_values`
|
|
- Route: `GET /api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values`
|
|
- Mode: READ
|
|
- Summary: List all values for a governance bundle entitlement
|
|
- Parameters:
|
|
- `bundleId` in `path` required
|
|
- `entitlementId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### get_opt_in_status
|
|
|
|
- Operation ID: `get_opt_in_status`
|
|
- Route: `GET /api/v1/iam/governance/optIn`
|
|
- Mode: READ
|
|
- Summary: Retrieve the Admin Console opt-in status
|
|
|
|
### opt_in
|
|
|
|
- Operation ID: `opt_in`
|
|
- Route: `POST /api/v1/iam/governance/optIn`
|
|
- Mode: WRITE
|
|
- Summary: Opt in the Admin Console to entitlement management
|
|
|
|
### opt_out
|
|
|
|
- Operation ID: `opt_out`
|
|
- Route: `POST /api/v1/iam/governance/optOut`
|
|
- Mode: WRITE
|
|
- Summary: Opt out the Admin Console from entitlement management
|
|
|
|
### list_resource_sets
|
|
|
|
- Operation ID: `list_resource_sets`
|
|
- Route: `GET /api/v1/iam/resource-sets`
|
|
- Mode: READ
|
|
- Summary: List all resource sets
|
|
- Parameters:
|
|
- `after` in `query`
|
|
|
|
### create_resource_set
|
|
|
|
- Operation ID: `create_resource_set`
|
|
- Route: `POST /api/v1/iam/resource-sets`
|
|
- Mode: WRITE
|
|
- Summary: Create a resource set
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_resource_set
|
|
|
|
- Operation ID: `get_resource_set`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a resource set
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
|
|
### replace_resource_set
|
|
|
|
- Operation ID: `replace_resource_set`
|
|
- Route: `PUT /api/v1/iam/resource-sets/{resourceSetIdOrLabel}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a resource set
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_resource_set
|
|
|
|
- Operation ID: `delete_resource_set`
|
|
- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a resource set
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
|
|
### list_bindings
|
|
|
|
- Operation ID: `list_bindings`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings`
|
|
- Mode: READ
|
|
- Summary: List all role resource set bindings
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `after` in `query`
|
|
|
|
### create_resource_set_binding
|
|
|
|
- Operation ID: `create_resource_set_binding`
|
|
- Route: `POST /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings`
|
|
- Mode: WRITE
|
|
- Summary: Create a role resource set binding
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_binding
|
|
|
|
- Operation ID: `get_binding`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a role resource set binding
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `roleIdOrLabel` in `path` required
|
|
|
|
### delete_binding
|
|
|
|
- Operation ID: `delete_binding`
|
|
- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a role resource set binding
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `roleIdOrLabel` in `path` required
|
|
|
|
### list_members_of_binding
|
|
|
|
- Operation ID: `list_members_of_binding`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members`
|
|
- Mode: READ
|
|
- Summary: List all role resource set binding members
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `roleIdOrLabel` in `path` required
|
|
- `after` in `query`
|
|
|
|
### add_members_to_binding
|
|
|
|
- Operation ID: `add_members_to_binding`
|
|
- Route: `PATCH /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members`
|
|
- Mode: WRITE
|
|
- Summary: Add more role resource set binding members
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `roleIdOrLabel` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_member_of_binding
|
|
|
|
- Operation ID: `get_member_of_binding`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a role resource set binding member
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `roleIdOrLabel` in `path` required
|
|
- `memberId` in `path` required
|
|
|
|
### unassign_member_from_binding
|
|
|
|
- Operation ID: `unassign_member_from_binding`
|
|
- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign a role resource set binding member
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `roleIdOrLabel` in `path` required
|
|
- `memberId` in `path` required
|
|
|
|
### list_resource_set_resources
|
|
|
|
- Operation ID: `list_resource_set_resources`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources`
|
|
- Mode: READ
|
|
- Summary: List all resource set resources
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### add_resource_set_resource
|
|
|
|
- Operation ID: `add_resource_set_resource`
|
|
- Route: `POST /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources`
|
|
- Mode: WRITE
|
|
- Summary: Add a resource set resource with conditions
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### add_resource_set_resources
|
|
|
|
- Operation ID: `add_resource_set_resources`
|
|
- Route: `PATCH /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources`
|
|
- Mode: WRITE
|
|
- Summary: Add more resources to a resource set
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_resource_set_resource
|
|
|
|
- Operation ID: `get_resource_set_resource`
|
|
- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a resource set resource
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `resourceId` in `path` required
|
|
|
|
### replace_resource_set_resource
|
|
|
|
- Operation ID: `replace_resource_set_resource`
|
|
- Route: `PUT /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace the resource set resource conditions
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `resourceId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_resource_set_resource
|
|
|
|
- Operation ID: `delete_resource_set_resource`
|
|
- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a resource set resource
|
|
- Parameters:
|
|
- `resourceSetIdOrLabel` in `path` required
|
|
- `resourceId` in `path` required
|
|
|
|
### list_roles
|
|
|
|
- Operation ID: `list_roles`
|
|
- Route: `GET /api/v1/iam/roles`
|
|
- Mode: READ
|
|
- Summary: List all custom roles
|
|
- Parameters:
|
|
- `after` in `query`
|
|
|
|
### create_role
|
|
|
|
- Operation ID: `create_role`
|
|
- Route: `POST /api/v1/iam/roles`
|
|
- Mode: WRITE
|
|
- Summary: Create a custom role
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_role
|
|
|
|
- Operation ID: `get_role`
|
|
- Route: `GET /api/v1/iam/roles/{roleIdOrLabel}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a role
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
|
|
### replace_role
|
|
|
|
- Operation ID: `replace_role`
|
|
- Route: `PUT /api/v1/iam/roles/{roleIdOrLabel}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a custom role
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_role
|
|
|
|
- Operation ID: `delete_role`
|
|
- Route: `DELETE /api/v1/iam/roles/{roleIdOrLabel}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a custom role
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
|
|
### list_role_permissions
|
|
|
|
- Operation ID: `list_role_permissions`
|
|
- Route: `GET /api/v1/iam/roles/{roleIdOrLabel}/permissions`
|
|
- Mode: READ
|
|
- Summary: List all custom role permissions
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
|
|
### get_role_permission
|
|
|
|
- Operation ID: `get_role_permission`
|
|
- Route: `GET /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a custom role permission
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
- `permissionType` in `path` required
|
|
|
|
### create_role_permission
|
|
|
|
- Operation ID: `create_role_permission`
|
|
- Route: `POST /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}`
|
|
- Mode: WRITE
|
|
- Summary: Create a custom role permission
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
- `permissionType` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### replace_role_permission
|
|
|
|
- Operation ID: `replace_role_permission`
|
|
- Route: `PUT /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a custom role permission
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
- `permissionType` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_role_permission
|
|
|
|
- Operation ID: `delete_role_permission`
|
|
- Route: `DELETE /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a custom role permission
|
|
- Parameters:
|
|
- `roleIdOrLabel` in `path` required
|
|
- `permissionType` in `path` required
|