# LightOn Documentation: French API Paradigm Références API API V3 ## API V3 ### Budget - [Get company budget](https://docs.lighton.ai/api-reference-v3/budget/get-company-budget.md): Return the company's monthly budget configuration, current spend, and alert thresholds. - [Create or update company budget](https://docs.lighton.ai/api-reference-v3/budget/create-or-update-company-budget.md): Set or update the company's monthly spend budget. Requires CompanyAdmin role. Creates the budget on first call; updates it on subsequent calls. - [Delete company budget](https://docs.lighton.ai/api-reference-v3/budget/delete-company-budget.md): Delete the company's budget and all associated alerts. Requires CompanyAdmin role. - [List budget alerts](https://docs.lighton.ai/api-reference-v3/budget/list-budget-alerts.md): Return all alert thresholds for the company's budget. - [Create budget alert](https://docs.lighton.ai/api-reference-v3/budget/create-budget-alert.md): Add an alert threshold to the company's budget. Requires CompanyAdmin role. - [Toggle all budget alerts](https://docs.lighton.ai/api-reference-v3/budget/toggle-all-budget-alerts.md): Enable or disable all alert thresholds for the company's budget in a single operation. Requires CompanyAdmin role. - [Delete budget alert](https://docs.lighton.ai/api-reference-v3/budget/delete-budget-alert.md): Delete an alert threshold. Requires CompanyAdmin role. - [Update budget alert](https://docs.lighton.ai/api-reference-v3/budget/update-budget-alert.md): Update an existing alert threshold. Requires CompanyAdmin role. ### Usage - [Company free-tier credits](https://docs.lighton.ai/api-reference-v3/usage/company-free-tier-credits.md): Returns the company's cumulative metered-API-call spend in euros plus the free-tier budget and a per-playground-endpoint estimate of how many operations the remaining credits buy at current list price. `limit_eur`, `remaining_eur` and `estimates` are populated only for non-exempt companies while `LI… - [Company storage usage](https://docs.lighton.ai/api-reference-v3/usage/company-storage-usage.md): Returns the company's current ingested-file footprint in bytes plus its tier's included/free storage allowance. `limit_bytes` is the tier allowance (5 GB for free / pay-as-you-go, 100 GB for business) — a hard cap only for the free tier; for paid tiers it is the free allowance above which storage is… - [Get month-to-date storage cost](https://docs.lighton.ai/api-reference-v3/usage/get-month-to-date-storage-cost.md): Return the storage charge the caller's company has accrued so far in the current billing month, alongside the quantities it is derived from. - [Get 30-day usage histogram for the authenticated user](https://docs.lighton.ai/api-reference-v3/usage/get-30-day-usage-histogram-for-the-authenticated-user.md): Return a per-day breakdown of metered usage over the last 30 days (oldest first), including a list-price cost estimate per feature and per day. Days with no usage are returned with an empty `usage` object so the response is dense. - [Get spend for the open billing period](https://docs.lighton.ai/api-reference-v3/usage/get-spend-for-the-open-billing-period.md): Recap what the caller's company has accrued in the billing period now open: a `total_cost` plus a per-feature breakdown, highest cost first. ### System - [System status](https://docs.lighton.ai/api-reference-v3/system/system-status.md): Returns the current maintenance state: active maintenance periods and the active announcement. ### Agents - [List all agents](https://docs.lighton.ai/api-reference-v3/agents/list-all-agents.md): Get a paginated list of agents (ChatSettings) accessible to the user. Access control: Sys-admin users can access all agents from all companies. Company admin users can access all agents from their company. Regular users can only access agents linked to groups they belong to. - [Create a new agent](https://docs.lighton.ai/api-reference-v3/agents/create-a-new-agent.md): Create a new agent (ChatSettings) with specified tools and MCP servers. - [List agent favorites](https://docs.lighton.ai/api-reference-v3/agents/list-agent-favorites.md): Get a list of the current user's favorited agents, ordered by newest first. - [Create agent favorite](https://docs.lighton.ai/api-reference-v3/agents/create-agent-favorite.md): Favorite an agent for the current user. - [Delete agent favorite by agent id](https://docs.lighton.ai/api-reference-v3/agents/delete-agent-favorite-by-agent-id.md): Remove an agent from the current user's favorites by agent id. - [Delete agent favorite](https://docs.lighton.ai/api-reference-v3/agents/delete-agent-favorite.md): Remove an agent from the current user's favorites by favorite id. - [Retrieve a single agent](https://docs.lighton.ai/api-reference-v3/agents/retrieve-a-single-agent.md): Get detailed information about a specific agent (ChatSettings) by ID. Access control: Sys-admin users can access all agents from all companies. Company admin users can access all agents from their company. Regular users can only access agents linked to groups they belong to. - [Delete an agent](https://docs.lighton.ai/api-reference-v3/agents/delete-an-agent.md): Delete an agent (ChatSettings) by ID. Access control: Users can delete agents in their personal groups. Company admins can delete agents in any group within their company. Sys-admin users can delete any agent. Default agents cannot be deleted. - [Update an agent](https://docs.lighton.ai/api-reference-v3/agents/update-an-agent.md): Partially update an agent (ChatSettings) by ID. - [List files scoped to an agent](https://docs.lighton.ai/api-reference-v3/agents/list-files-scoped-to-an-agent.md): Retrieve a paginated list of files (documents) accessible to the authenticated user. Results are ordered by upload date (newest first) by default. When using the `search` parameter, results are ordered by relevance. - [Get agent icon](https://docs.lighton.ai/api-reference-v3/agents/get-agent-icon.md): Retrieve the icon for an agent as a WebP image file. Access control: Sys-admin users can access icons for all agents from all companies. Company admin users can access icons for all agents from their company. Regular users can only access icons for agents linked to groups they belong to. - [Upload agent icon](https://docs.lighton.ai/api-reference-v3/agents/upload-agent-icon.md): Upload or update an icon for an agent. Maximum file size: 5MB. Access control: Users can upload icons for agents in their personal groups. Company admins can upload icons for agents in any group within their company. Sys-admin users can upload icons for any agent. - [List tags used in workspaces for an agent](https://docs.lighton.ai/api-reference-v3/agents/list-tags-used-in-workspaces-for-an-agent.md): Return a non-paginated list of tags used in documents within workspaces scoped to the specified agent. If the agent is default, tags are computed across all workspaces accessible to the user. If the agent is not default, tags are computed only across workspaces linked to the agent's group, intersect… - [List native tools and MCP servers available for a specific agent](https://docs.lighton.ai/api-reference-v3/agents/list-native-tools-and-mcp-servers-available-for-a-specific-agent.md): Get available native tools and MCP servers with their tools for a given agent ID. ### Threads - [List conversation threads](https://docs.lighton.ai/api-reference-v3/threads/list-conversation-threads.md): List conversation threads for the authenticated user with cursor-based pagination. - [Create a conversation thread](https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-thread.md): Create a new conversation thread. - [Create a conversation thread with initial turn](https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-thread-with-initial-turn.md): Create a new thread and immediately ask a query in a single request. This endpoint combines thread creation and turn creation to reduce round trips. - [Retrieve a conversation thread](https://docs.lighton.ai/api-reference-v3/threads/retrieve-a-conversation-thread.md): Get a thread by ID. - [Delete a conversation thread](https://docs.lighton.ai/api-reference-v3/threads/delete-a-conversation-thread.md): Delete a thread by ID. - [Update a conversation thread](https://docs.lighton.ai/api-reference-v3/threads/update-a-conversation-thread.md): Update a thread by ID. Use query parameters 'anonymize=true' to anonymize an ephemeral thread or 'cancel=true' to cancel the current turn processing. - [Resume a turn generation](https://docs.lighton.ai/api-reference-v3/threads/resume-a-turn-generation.md): Resume streaming the last turn of a thread. - [Get suggested queries for a conversation thread](https://docs.lighton.ai/api-reference-v3/threads/get-suggested-queries-for-a-conversation-thread.md): Get AI-generated suggested follow-up queries for a thread. - [List conversation turns in a thread](https://docs.lighton.ai/api-reference-v3/threads/list-conversation-turns-in-a-thread.md): List all turns (answers) for a thread with cursor-based pagination. - [Create a conversation turn in a thread](https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread.md): Ask a query to the agent. - [Update a conversation turn in a thread](https://docs.lighton.ai/api-reference-v3/threads/update-a-conversation-turn-in-a-thread.md): Update a turn by ID. Use query parameter 'action' to specify the action: 'like_dislike' to send like/dislike feedback, 'copied' to mark as copied, or 'flag' to create a flag. ### Tools - [List native tools](https://docs.lighton.ai/api-reference-v3/tools/list-native-tools.md): Returns native tools available to the authenticated user's company. If the company has no tool restrictions configured, all native tools are returned. Sys-admins can pass `company_id` to inspect another company's allowed tools. ### Models - [List aliases](https://docs.lighton.ai/api-reference-v3/models/list-aliases.md): List all aliases for the authenticated user's company. Sysadmins can filter by company_id to view aliases from any company. - [Create alias](https://docs.lighton.ai/api-reference-v3/models/create-alias.md): Create a new model alias for the authenticated user's company. - [Get alias details](https://docs.lighton.ai/api-reference-v3/models/get-alias-details.md): Retrieve an alias with its linked models. - [Delete alias](https://docs.lighton.ai/api-reference-v3/models/delete-alias.md): Delete an alias and all its model mappings. - [Update alias](https://docs.lighton.ai/api-reference-v3/models/update-alias.md): Partially update an alias. - [Add model to alias](https://docs.lighton.ai/api-reference-v3/models/add-model-to-alias.md): Link an ML model to this alias with a priority rank. - [Remove model from alias](https://docs.lighton.ai/api-reference-v3/models/remove-model-from-alias.md): Soft-delete the link between a model and this alias. - [Update model priority in alias](https://docs.lighton.ai/api-reference-v3/models/update-model-priority-in-alias.md): Update the priority of a model linked to this alias. - [Preview alias routing](https://docs.lighton.ai/api-reference-v3/models/preview-alias-routing.md): Simulate the routing resolution for this alias as it would happen at request time. - [Generate a chat completion](https://docs.lighton.ai/api-reference-v3/models/generate-a-chat-completion.md): This endpoint can be used to generate chat completions from a Large Language Model. - [Create embeddings](https://docs.lighton.ai/api-reference-v3/models/create-embeddings.md): This endpoint can be used to convert text chunks into embeddings. - [List external API keys](https://docs.lighton.ai/api-reference-v3/models/list-external-api-keys.md): Returns active provider API keys for the current user and their company. Key values are never returned. Each item includes a `scope` field: 'user' or 'company'. - [Set personal external API key](https://docs.lighton.ai/api-reference-v3/models/set-personal-external-api-key.md): Creates or replaces the active personal API key for the given provider. The previous key (if any) is deactivated. Key value is never returned. - [Deactivate personal external API key](https://docs.lighton.ai/api-reference-v3/models/deactivate-personal-external-api-key.md): Soft-deletes the active personal API key for the given provider. - [Extract structured data from a document](https://docs.lighton.ai/api-reference-v3/models/extract-structured-data-from-a-document.md): Pull specific fields from a document into a typed schema. - [Get the status and result of an async extract job](https://docs.lighton.ai/api-reference-v3/models/get-the-status-and-result-of-an-async-extract-job.md): Poll for the status and result of an async extract job submitted via `POST /api/v3/extract` with `options.async=true`. Returns the same envelope shape as the synchronous extract endpoint once `status` is `completed`. - [Parse a document to Markdown via VLM](https://docs.lighton.ai/api-reference-v3/models/parse-a-document-to-markdown-via-vlm.md): **Deprecated: Use the v3 parse endpoint instead.** - [Parse a document to Markdown](https://docs.lighton.ai/api-reference-v3/models/parse-a-document-to-markdown.md): Convert a document into readable, structured Markdown content. - [Get the status and result of an async parse job](https://docs.lighton.ai/api-reference-v3/models/get-the-status-and-result-of-an-async-parse-job.md): Poll for the status and result of an async parse job submitted via `POST /api/v3/parse` with `options.async=true`. Returns the same envelope shape as the synchronous parse endpoint once `status` is `completed`. - [Render a document as PDF](https://docs.lighton.ai/api-reference-v3/models/render-a-document-as-pdf.md): Convert a document into a PDF suitable for inline preview. ### MCP - [List MCP servers](https://docs.lighton.ai/api-reference-v3/mcp/list-mcp-servers.md): List MCP servers available to the authenticated user (servers only; tools are not included). - [Create MCP server](https://docs.lighton.ai/api-reference-v3/mcp/create-mcp-server.md): Create a new MCP server scoped to the authenticated user's personal group. The server is automatically linked to the user's company and personal group — users cannot create servers for other companies or groups. - [Get MCP server details](https://docs.lighton.ai/api-reference-v3/mcp/get-mcp-server-details.md): Get details of a specific MCP server. URL is redacted unless user has secret read permissions. - [Delete MCP server](https://docs.lighton.ai/api-reference-v3/mcp/delete-mcp-server.md): Delete an MCP server. This will remove it from all agents using it. - [Update MCP server](https://docs.lighton.ai/api-reference-v3/mcp/update-mcp-server.md): Update an existing MCP server. All fields are optional. - [List tools for an MCP server](https://docs.lighton.ai/api-reference-v3/mcp/list-tools-for-an-mcp-server.md): Returns the tools registered for a specific MCP server. Returns 403 if the server does not exist or is not accessible. ### Sources - [List or retrieve sources](https://docs.lighton.ai/api-reference-v3/sources/list-or-retrieve-sources.md): Unified endpoint to list document and web sources with filtering. ### Artifacts - [Retrieve an artifact](https://docs.lighton.ai/api-reference-v3/artifacts/retrieve-an-artifact.md): Retrieve an artifact by ID. - [Retrieve an artifact content](https://docs.lighton.ai/api-reference-v3/artifacts/retrieve-an-artifact-content.md): Get the content of an artifact. Returns the file content if the user is authorized to access it. ### Agent - [List agent tools and MCP servers for a chat setting](https://docs.lighton.ai/api-reference-v3/agent/list-agent-tools-and-mcp-servers-for-a-chat-setting.md): Get available native tools and MCP servers with their tools for a given chat setting ID. ### Files - [List files accessible to the authenticated user](https://docs.lighton.ai/api-reference-v3/files/list-files-accessible-to-the-authenticated-user.md): Retrieve a paginated list of files (documents) accessible to the authenticated user. Results are ordered by upload date (newest first) by default. When using the `search` parameter, results are ordered by relevance. - [Upload a file](https://docs.lighton.ai/api-reference-v3/files/upload-a-file.md): Upload a file to a workspace. - [Delete multiple files in a single request](https://docs.lighton.ai/api-reference-v3/files/delete-multiple-files-in-a-single-request.md): Permanently delete multiple files in a single request. - [Retrieve a single file by ID](https://docs.lighton.ai/api-reference-v3/files/retrieve-a-single-file-by-id.md): Retrieve detailed information for a single file by its ID. Only files that the authenticated user is authorized to access will be returned. Returns 404 if the file does not exist or the user does not have access. - [Delete a file](https://docs.lighton.ai/api-reference-v3/files/delete-a-file.md): Permanently delete a file and all associated data. - [Update file metadata](https://docs.lighton.ai/api-reference-v3/files/update-file-metadata.md): Update mutable fields of a file (document). - [Download a document file](https://docs.lighton.ai/api-reference-v3/files/download-a-document-file.md): Download a document file. Returns the original file by default. Use the purpose parameter to request a specific version (e.g. rendered_pdf for frontend viewers). - [Get document thumbnail](https://docs.lighton.ai/api-reference-v3/files/get-document-thumbnail.md): Returns the 256x256 WebP thumbnail for a document. Thumbnails are generated asynchronously after ingestion completes: poll the `thumbnail.status` field on the file resource and request this endpoint once it reads `READY`. ### Facets - [List content types](https://docs.lighton.ai/api-reference-v3/facets/list-content-types.md): List your classification trees: the content types you've adopted from the starter templates or created from scratch. This is where you see what's available to classify your documents with. - [Define content types and attributes](https://docs.lighton.ai/api-reference-v3/facets/define-content-types-and-attributes.md): Create, modify, and organise your company's content-type trees and their attributes. Every action is idempotent, safe to re-run. - [Batch define content types and attributes](https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes.md): Execute multiple content-type actions in a single request. - [Resolve search scope](https://docs.lighton.ai/api-reference-v3/facets/resolve-search-scope.md): Resolves content type and attribute filters from a natural-language query. Call this **before** `/search`, `/ask`, or `/files` to narrow results by domain. Pass the inferred `content_type` and `attribute` directly to those endpoints. - [List content type templates](https://docs.lighton.ai/api-reference-v3/facets/list-content-type-templates.md): Browse the platform's **starter-kit templates** for content types. These are ready-made taxonomies (legal, finance, healthcare, tech, manufacturing) you can adopt to quickly organise your documents, no manual setup required. - [List file classifications and attribute values](https://docs.lighton.ai/api-reference-v3/facets/list-file-classifications-and-attribute-values.md): See what content types a file is classified under and what attribute values have been set on it. - [Classify file and set attribute values](https://docs.lighton.ai/api-reference-v3/facets/classify-file-and-set-attribute-values.md): Apply content-type classifications to a file and set attribute values (metadata) on it. This is how you tag a document with structured metadata from your content-type schema. - [Batch classify and set attribute values](https://docs.lighton.ai/api-reference-v3/facets/batch-classify-and-set-attribute-values.md): Execute multiple file facet actions in a single request. ### Tags - [Add tags to a file](https://docs.lighton.ai/api-reference-v3/tags/add-tags-to-a-file.md): Add one or more tags to a file without affecting existing tags. - [Remove a tag from a file](https://docs.lighton.ai/api-reference-v3/tags/remove-a-tag-from-a-file.md): Remove a specific tag from a file. - [List all tags for the authenticated user's company](https://docs.lighton.ai/api-reference-v3/tags/list-all-tags-for-the-authenticated-users-company.md): Retrieve a list of tags for the authenticated user's company. Results are ordered by creation date (newest first). - [Create a new tag for the company](https://docs.lighton.ai/api-reference-v3/tags/create-a-new-tag-for-the-company.md): Create a new tag for the authenticated user's company. The auto_assign flag determines if the tag can be automatically assigned by the system (True) or only manually (False). Requires tag creation permission. - [Delete a company tag](https://docs.lighton.ai/api-reference-v3/tags/delete-a-company-tag.md): Delete a company tag. This will also remove all Document-Tag associations with this tag. Requires tag deletion permission. ### Workspaces - [List workspaces](https://docs.lighton.ai/api-reference-v3/workspaces/list-workspaces.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Create a workspace](https://docs.lighton.ai/api-reference-v3/workspaces/create-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Browse datasource folders](https://docs.lighton.ai/api-reference-v3/workspaces/browse-datasource-folders.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Test datasource credentials](https://docs.lighton.ai/api-reference-v3/workspaces/test-datasource-credentials.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Retrieve a workspace](https://docs.lighton.ai/api-reference-v3/workspaces/retrieve-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Delete a workspace](https://docs.lighton.ai/api-reference-v3/workspaces/delete-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Update a workspace](https://docs.lighton.ai/api-reference-v3/workspaces/update-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [List workspace members](https://docs.lighton.ai/api-reference-v3/workspaces/list-workspace-members.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Replace all workspace members](https://docs.lighton.ai/api-reference-v3/workspaces/replace-all-workspace-members.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Add a member to a workspace](https://docs.lighton.ai/api-reference-v3/workspaces/add-a-member-to-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Remove a group from a custom workspace](https://docs.lighton.ai/api-reference-v3/workspaces/remove-a-group-from-a-custom-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Remove a user from a workspace](https://docs.lighton.ai/api-reference-v3/workspaces/remove-a-user-from-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. ### Files Processing - [Ask a question over your documents](https://docs.lighton.ai/api-reference-v3/files-processing/ask-a-question-over-your-documents.md): Retrieval-augmented generation: searches your indexed corpus, then generates an LLM answer grounded in the retrieved passages. - [Retrieve document chunks](https://docs.lighton.ai/api-reference-v3/files-processing/retrieve-document-chunks.md): **Deprecated: Use the v3 search endpoint instead.** - [Search document chunks](https://docs.lighton.ai/api-reference-v3/files-processing/search-document-chunks.md): Embedding → hybrid vector search → optional reranking, returning ranked chunks with provenance. No LLM generation is performed. ### Users - [List company users](https://docs.lighton.ai/api-reference-v3/users/list-company-users.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments. - [Create a new company member](https://docs.lighton.ai/api-reference-v3/users/create-a-new-company-member.md): This endpoint allows to create a new company member. - [Get current user profile](https://docs.lighton.ai/api-reference-v3/users/get-current-user-profile.md): Returns information on the authenticated user. - [Update current user profile](https://docs.lighton.ai/api-reference-v3/users/update-current-user-profile.md): Updates settings for the authenticated user. - [Retrieve a company member](https://docs.lighton.ai/api-reference-v3/users/retrieve-a-company-member.md): This endpoint allows to retrieve a specific company member by ID. - [Update a company member](https://docs.lighton.ai/api-reference-v3/users/update-a-company-member.md): This endpoint allows to update a specific company member by ID. - [Delete a company member](https://docs.lighton.ai/api-reference-v3/users/delete-a-company-member.md): This endpoint allows to soft-delete a specific company member by ID. - [Partially update a company member](https://docs.lighton.ai/api-reference-v3/users/partially-update-a-company-member.md): This endpoint allows to update a specific company member by ID. - [List roles of a company member](https://docs.lighton.ai/api-reference-v3/users/list-roles-of-a-company-member.md): This endpoint allows you to list the roles of a company member. - [Update roles of a company member](https://docs.lighton.ai/api-reference-v3/users/update-roles-of-a-company-member.md): This endpoint allows you to update the roles of a company member. ### API Keys - [List API keys](https://docs.lighton.ai/api-reference-v3/api-keys/list-api-keys.md): List all API keys belonging to the authenticated user. - [Create API key](https://docs.lighton.ai/api-reference-v3/api-keys/create-api-key.md): Create a new API key for the authenticated user. - [Retrieve API key](https://docs.lighton.ai/api-reference-v3/api-keys/retrieve-api-key.md): Retrieve a single API key belonging to the authenticated user, including its workspace scope. - [Revoke API key](https://docs.lighton.ai/api-reference-v3/api-keys/revoke-api-key.md): Revoke an API key. Revoked keys can no longer be used to authenticate requests. - [Update API key](https://docs.lighton.ai/api-reference-v3/api-keys/update-api-key.md): Update an existing API key. ### User Groups - [List user groups](https://docs.lighton.ai/api-reference-v3/user-groups/list-user-groups.md): Get the list of groups you are member of. - [Get group details](https://docs.lighton.ai/api-reference-v3/user-groups/get-group-details.md): Retrieve the details of a group you are member of. - [Fully update a group (PUT)](https://docs.lighton.ai/api-reference-v3/user-groups/fully-update-a-group-put.md): Update the name and description of a custom group you own. Members are managed through the `/api/v3/groups/{id}/members` endpoints, not here. - [Delete group of users](https://docs.lighton.ai/api-reference-v3/user-groups/delete-group-of-users.md): Delete a group of usersNote that if the users group could not be deleted because of protected dependencies, - [Partially update a group (PATCH)](https://docs.lighton.ai/api-reference-v3/user-groups/partially-update-a-group-patch.md): Partially update a custom group you own (name or description). - [List the members of a group you own](https://docs.lighton.ai/api-reference-v3/user-groups/list-the-members-of-a-group-you-own.md): Get the list of members for a group you own. - [Bulk replace the members of a custom group you own](https://docs.lighton.ai/api-reference-v3/user-groups/bulk-replace-the-members-of-a-custom-group-you-own.md): Bulk replace the entire member list of a custom group you own. - [Add a new member to a custom group you own](https://docs.lighton.ai/api-reference-v3/user-groups/add-a-new-member-to-a-custom-group-you-own.md): Add a new member to a custom group you own. - [Remove a user from a group you own](https://docs.lighton.ai/api-reference-v3/user-groups/remove-a-user-from-a-group-you-own.md): Remove a user from a group you own. ### SCIM - [List or Retrieve a group](https://docs.lighton.ai/api-reference-v3/scim/list-or-retrieve-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it - [Create a group](https://docs.lighton.ai/api-reference-v3/scim/create-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it - [Delete a group](https://docs.lighton.ai/api-reference-v3/scim/delete-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it - [Update a group](https://docs.lighton.ai/api-reference-v3/scim/update-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it - [List or Retrieve resource types](https://docs.lighton.ai/api-reference-v3/scim/list-or-retrieve-resource-types.md) - [List or Retrieve schemas](https://docs.lighton.ai/api-reference-v3/scim/list-or-retrieve-schemas.md) - [Retrieve Service Provider Configuration](https://docs.lighton.ai/api-reference-v3/scim/retrieve-service-provider-configuration.md) - [List or Retrieve users](https://docs.lighton.ai/api-reference-v3/scim/list-or-retrieve-users.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() - [Replace a user](https://docs.lighton.ai/api-reference-v3/scim/replace-a-user.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() - [Create a user](https://docs.lighton.ai/api-reference-v3/scim/create-a-user.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() - [Delete a user](https://docs.lighton.ai/api-reference-v3/scim/delete-a-user.md): Override default SCIM delete to anonymize immediately without soft/hard delete. - [Update a user](https://docs.lighton.ai/api-reference-v3/scim/update-a-user.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() ## OpenAPI Specs - [openapi-v3](/api-reference/openapi-v3.yaml)