Tenant-Scoped Model Filtering (owner_tenant_id)#

Overview#

RAGFlow enforces tenant-level model isolation so that each user only sees the LLM/embedding/rerank models registered under their own (or a joined) tenant. The mechanism is a single optional owner_tenant_id field that propagates from a React context provider on the Pipeline/Agent canvas all the way to the GET /api/v1/models backend query.

Data Flow#

Agent/Pipeline page (index.tsx)
  └─ OwnerTenantIdContext.Provider value={agentDetail.user_id}
       └─ node form (e.g. ExtractorForm)
            └─ useOwnerTenantId()
                 └─ LargeModelFormField { ownerTenantId }
                      └─ NextLLMSelect { ownerTenantId }
                           └─ LlmSettingFieldItems { ownerTenantId }
                                └─ LLMFormField { ownerTenantId }
                                     └─ ModelTreeSelect { ownerTenantId }
                                          └─ useFetchAllAddedModels(type, ownerTenantId)
                                               └─ GET /api/v1/models?owner_tenant_id=<value>
                                                    └─ get_added_models() (models_api.py)
                                                         └─ list_tenant_added_models(target_tenant_id, ...)

Key Files#

Context Provider Details#

OwnerTenantIdContext is a createContext<string | undefined>(undefined) 4. In agent/index.tsx, the provider is placed around AgentCanvas and sets its value to agentDetail.user_id — the user ID of the agent/pipeline owner, which doubles as their tenant_id. Any node form rendered inside the canvas calls useOwnerTenantId() to read this value.

Backend Permission Check#

In get_added_models(), when owner_tenant_id is provided and differs from the authenticated caller's tenant_id:

1. TenantService.get_joined_tenants_by_user_id() fetches all tenants the caller has joined.
2. The requested owner_tenant_id must appear in that set; otherwise the endpoint returns "Permission denied".
3. On success, list_tenant_added_models(target_tenant_id, model_type_filter) is called with the owner's tenant ID as the scoping key 5.

This means a user viewing a shared agent that belongs to another tenant will see models from the owner's tenant — not their own — provided they are a member of that tenant.

Model List Anomalies from Missing/Incorrect Values#

Debugging tip: Check the network request for GET /api/v1/models in browser DevTools. The presence and value of owner_tenant_id in the query string will immediately confirm whether context propagation succeeded.

Extension Notes#

• Other model picker variants (ModelTreeSelectFormField, LargeModelFormFieldWithoutFilter) 7 expose the same ownerTenantId prop — wire it up the same way.
• Adding tenant scoping to a new node form: call useOwnerTenantId() from web/src/pages/agent/context.ts and pass the result to whatever LLM picker the form uses.
• Backend list_tenant_added_models lives in api/apps/services/models_api_service.py 8; it is the only place that actually queries the three-tier TenantModelProvider → TenantModelInstance → TenantModel hierarchy for a given tenant.