248 lines
7.0 KiB
Markdown
248 lines
7.0 KiB
Markdown
---
|
|
name: organizations-routes
|
|
description: Handle 22 OpenAPI operation(s) under /organizations for the organizations route group.
|
|
---
|
|
|
|
# organizations API Routes
|
|
|
|
Handle 22 OpenAPI operation(s) under /organizations for the organizations 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
|
|
|
|
### organizations_controller_list
|
|
|
|
- Operation ID: `organizations_controller_list`
|
|
- Route: `GET /organizations`
|
|
- Mode: READ
|
|
- Summary: List Organizations
|
|
- Parameters:
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
- `domains` in `query`
|
|
- `search` in `query`
|
|
|
|
### organizations_controller_create
|
|
|
|
- Operation ID: `organizations_controller_create`
|
|
- Route: `POST /organizations`
|
|
- Mode: WRITE
|
|
- Summary: Create an Organization
|
|
- Body: JSON request body accepted.
|
|
|
|
### organizations_controller_get_by_external_id
|
|
|
|
- Operation ID: `organizations_controller_get_by_external_id`
|
|
- Route: `GET /organizations/external_id/{external_id}`
|
|
- Mode: READ
|
|
- Summary: Get an Organization by External ID
|
|
- Parameters:
|
|
- `external_id` in `path` required
|
|
|
|
### organizations_controller_find
|
|
|
|
- Operation ID: `organizations_controller_find`
|
|
- Route: `GET /organizations/{id}`
|
|
- Mode: READ
|
|
- Summary: Get an Organization
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### organizations_controller_update_organization
|
|
|
|
- Operation ID: `organizations_controller_update_organization`
|
|
- Route: `PUT /organizations/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update an Organization
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### organizations_controller_delete_organization
|
|
|
|
- Operation ID: `organizations_controller_delete_organization`
|
|
- Route: `DELETE /organizations/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an Organization
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### organizations_controller_get_audit_log_configuration
|
|
|
|
- Operation ID: `organizations_controller_get_audit_log_configuration`
|
|
- Route: `GET /organizations/{id}/audit_log_configuration`
|
|
- Mode: READ
|
|
- Summary: Get Audit Log Configuration
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### audit_logs_retention_controller_audit_logs_retention
|
|
|
|
- Operation ID: `audit_logs_retention_controller_audit_logs_retention`
|
|
- Route: `GET /organizations/{id}/audit_logs_retention`
|
|
- Mode: READ
|
|
- Summary: Get Retention
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### audit_logs_retention_controller_update_audit_logs_retention
|
|
|
|
- Operation ID: `audit_logs_retention_controller_update_audit_logs_retention`
|
|
- Route: `PUT /organizations/{id}/audit_logs_retention`
|
|
- Mode: WRITE
|
|
- Summary: Set Retention
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### organization_api_keys_controller_list
|
|
|
|
- Operation ID: `organization_api_keys_controller_list`
|
|
- Route: `GET /organizations/{organizationId}/api_keys`
|
|
- Mode: READ
|
|
- Summary: List API keys for an organization
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
|
|
### organization_api_keys_controller_create
|
|
|
|
- Operation ID: `organization_api_keys_controller_create`
|
|
- Route: `POST /organizations/{organizationId}/api_keys`
|
|
- Mode: WRITE
|
|
- Summary: Create an API key for an organization
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### provider_controller_list_for_organization
|
|
|
|
- Operation ID: `provider_controller_list_for_organization`
|
|
- Route: `GET /organizations/{organizationId}/data_integration_configurations`
|
|
- Mode: READ
|
|
- Summary: List providers for an organization
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
|
|
### provider_controller_configure
|
|
|
|
- Operation ID: `provider_controller_configure`
|
|
- Route: `PUT /organizations/{organizationId}/data_integration_configurations/{slug}`
|
|
- Mode: WRITE
|
|
- Summary: Configure a provider for an organization
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `slug` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### organization_feature_flags_controller_list
|
|
|
|
- Operation ID: `organization_feature_flags_controller_list`
|
|
- Route: `GET /organizations/{organizationId}/feature-flags`
|
|
- Mode: READ
|
|
- Summary: List enabled feature flags for an organization
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
|
|
### groups_controller_create
|
|
|
|
- Operation ID: `groups_controller_create`
|
|
- Route: `POST /organizations/{organizationId}/groups`
|
|
- Mode: WRITE
|
|
- Summary: Create a group
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_controller_list
|
|
|
|
- Operation ID: `groups_controller_list`
|
|
- Route: `GET /organizations/{organizationId}/groups`
|
|
- Mode: READ
|
|
- Summary: List groups
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
|
|
### groups_controller_get
|
|
|
|
- Operation ID: `groups_controller_get`
|
|
- Route: `GET /organizations/{organizationId}/groups/{groupId}`
|
|
- Mode: READ
|
|
- Summary: Get a group
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `groupId` in `path` required
|
|
|
|
### groups_controller_update
|
|
|
|
- Operation ID: `groups_controller_update`
|
|
- Route: `PATCH /organizations/{organizationId}/groups/{groupId}`
|
|
- Mode: WRITE
|
|
- Summary: Update a group
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_controller_delete
|
|
|
|
- Operation ID: `groups_controller_delete`
|
|
- Route: `DELETE /organizations/{organizationId}/groups/{groupId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a group
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `groupId` in `path` required
|
|
|
|
### group_memberships_controller_add_member
|
|
|
|
- Operation ID: `group_memberships_controller_add_member`
|
|
- Route: `POST /organizations/{organizationId}/groups/{groupId}/organization-memberships`
|
|
- Mode: WRITE
|
|
- Summary: Add a member to a Group
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### group_memberships_controller_list_members
|
|
|
|
- Operation ID: `group_memberships_controller_list_members`
|
|
- Route: `GET /organizations/{organizationId}/groups/{groupId}/organization-memberships`
|
|
- Mode: READ
|
|
- Summary: List Group members
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `groupId` in `path` required
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
|
|
### group_memberships_controller_remove_member
|
|
|
|
- Operation ID: `group_memberships_controller_remove_member`
|
|
- Route: `DELETE /organizations/{organizationId}/groups/{groupId}/organization-memberships/{omId}`
|
|
- Mode: WRITE
|
|
- Summary: Remove a member from a Group
|
|
- Parameters:
|
|
- `organizationId` in `path` required
|
|
- `groupId` in `path` required
|
|
- `omId` in `path` required
|