Access control layers
Onyx applies access control at two distinct levels:Role-based access
Controls what actions a user can perform: managing connectors, changing settings, curating documents.
Document-level permissions
Controls which documents appear in search results, regardless of the user’s role.
User roles
| Role | Admin actions | Group scope | Notes |
|---|---|---|---|
| Admin | All | All groups | Full platform control |
| Global Curator | Connector & document management | All groups they belong to | Cannot change roles or system settings |
| Curator | Connector & document management | Only assigned groups | Designated per-group by an Admin |
| Basic | None | — | Standard end user |
| Limited | None | — | Restricted API access only |
Role updates are handled through a separate admin-only process. Users cannot change their own role, and an admin cannot demote their own account.
Document-level permissions
Onyx mirrors permissions from source applications. If a user does not have access to a document in its origin system, that document will not appear in their Onyx search results—even if the connector has been indexed.How it works
Connector sync
When a connector runs, Onyx fetches documents along with the access control lists (ACLs) defined in the source system.
Permission storage
Each document’s permitted users and groups are stored alongside the document in the index.
Examples by connector
- Confluence: If a Confluence space is restricted to the Engineering team, only Engineering team members see pages from that space in Onyx.
- Google Drive: Documents shared with specific users or Google Groups are only surfaced to those users in Onyx.
- Slack: Messages from private channels only appear for users who are members of that channel.
Group-based access control
Groups let you restrict connector visibility at the Onyx level, independently of the source system’s permissions. When a connector is configured with group restrictions, only members of the specified groups see documents from that connector in search—even if the underlying document has broader permissions. This is useful when you want to:- Limit a connector to a specific team before rolling it out broadly
- Create department-scoped search experiences without changing source system permissions
- Give a team their own isolated knowledge base within a shared Onyx deployment
Assistant and agent visibility
Assistants (also called agents or personas) have their own visibility settings, separate from document permissions.Public
Public
Visible to all users in the deployment. Anyone can use the assistant from the assistant selector.
Private
Private
Visible only to the creator. Other users cannot discover or use the assistant.
Group-scoped
Group-scoped
Visible only to members of one or more specified groups. Use this to give a team a custom assistant without exposing it to the whole organization.
Curator role in depth
The Curator role gives trusted non-admin users management capabilities scoped to specific groups. What a Curator can do within their assigned groups:- Add and configure connectors
- Pause, resume, and delete connector syncs
- Manage document boost and hidden status for their group’s connectors
- View indexing errors and sync status
- Change user roles
- Access connectors or documents outside their assigned groups
- Modify system-level settings (LLM config, auth, etc.)
Admin vs. Global Curator
- Admin
- Global Curator
- Full access to all groups, connectors, documents, and system settings
- Can promote or demote any user’s role
- Can create, edit, and delete any group
- Can manage all assistants regardless of ownership
- Can view all query history and analytics
External group sync (Enterprise Edition)
Enterprise Edition supports syncing group memberships from external identity providers directly into Onyx. When external group sync is enabled:- Groups from your identity provider (e.g. Okta groups, Azure AD groups, Google Workspace groups) are automatically created and updated in Onyx.
- User group memberships stay in sync without manual administration.
- Document permissions tied to identity provider groups are automatically reflected in Onyx search results.
