Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/archestra-ai/archestra/llms.txt

Use this file to discover all available pages before exploring further.

Archestra uses a role-based access control (RBAC) system to manage user permissions across every resource in the platform. Permissions follow a resource:action format — for example, agent:create allows creating agents, mcpGateway:update allows modifying MCP gateway configuration, and llmProxy:read allows viewing LLM proxies. This model gives platform administrators precise control over what each user can see and do without granting blanket elevated access.

Predefined Roles

The following roles are built into Archestra and cannot be modified or deleted.

Admin

Full access to all resources including user management, roles, identity providers, and platform settings. The admin role has all permissions on every resource.

Editor

Full access to core resources — agents, MCP gateways, LLM proxies, knowledge bases, and organization settings — but cannot manage users, roles, or identity providers.

Member

Can create and manage their own agents, tools, and chat sessions, with read-only access to most platform-wide resources.

Editor Permissions

ResourceActions
Agentsread, create, update, delete, team-admin
Skillsread, create, update, delete, team-admin, execute
Agent Triggersread, create, update, delete
Scheduled Tasksread, create, update, delete
LLM Proxiesread, create, update, delete, team-admin
LLM Provider API Keysread, create, update, delete
LLM Virtual Keysread, create, update, delete
LLM OAuth Clientsread, create, update, delete
LLM Modelsread, update
LLM Limitsread, create, update, delete
Optimization Rulesread, create, update, delete
LLM Costsread
MCP Gatewaysread, create, update, delete, team-admin
Tools & Policiesread, create, update, delete
MCP Registryread, create, update, delete, team-admin
MCP Server Installationsread, create, update, delete
MCP Server Installation Requestsread, create, update, delete
Environmentsadmin
GitHub App Configurationsread, create, update, delete
Knowledge Filesread, create, update, delete
Knowledge Sourcesread, create, update, delete, query
Chatsread, create, update, delete
Logsread
API Keysread, create, delete
LLM Settingsread, update
Knowledge Settingsread, update
Usersread
Invitationsread
Rolesread
Teamsread
Identity Providersread
Secretsread
Organization Settingsread, update
Site Notificationsread
Chat Agent Pickerenable
Chat Provider Settingsenable
Chat Expand Tool Callsenable

Member Permissions

ResourceActions
Agentsread, create, update, delete
Skillsread, create, update, delete, execute
Scheduled Tasksread, create, update, delete
LLM Proxiesread, create, update, delete
LLM Provider API Keysread
LLM Virtual Keysread
LLM OAuth Clientsread
LLM Modelsread
MCP Gatewaysread, create, update, delete
Tools & Policiesread
MCP Registryread
MCP Server Installationsread, create, delete
MCP Server Installation Requestsread, create, update
Knowledge Filesread
Knowledge Sourcesread, query
Chatsread, create, update, delete
API Keysread, create, delete
Teamsread
Site Notificationsread
Simple Viewenable
Chat Agent Pickerenable
Chat Provider Settingsenable
Chat Expand Tool Callsenable

Custom Roles

Users with the ac:create permission can create custom roles by selecting specific permission combinations. Custom roles enable fine-grained access control tailored to your organization’s needs. You can only grant permissions that you already possess — this prevents privilege escalation.
Use clear, descriptive names for custom roles that indicate their purpose, such as Agent-Manager, Read-Only-Analyst, or Tool-Developer.

Available Permissions

PermissionDescription
ac:readView custom roles and their permissions
ac:createCreate new custom roles
ac:updateModify custom role permissions
ac:deleteDelete custom roles
PermissionDescription
agent:readView and list agents
agent:createCreate new agents
agent:updateModify agent configuration and settings
agent:deleteDelete agents
agent:team-adminManage team assignments for agents
agent:adminFull administrative control over all agents, bypassing team restrictions
skill:readView and use agent skills within your scope
skill:createCreate new agent skills
skill:updateModify agent skills and their team assignments
skill:deleteDelete agent skills
skill:team-adminManage team assignments for agent skills
skill:adminFull administrative control over all agent skills
skill:executeExecute skill scripts
agentSettings:readView agent settings (default model, default agent, security engine, file uploads)
agentSettings:updateModify agent settings (default model, default agent, security engine, file uploads)
agentTrigger:readView agent trigger configurations
agentTrigger:createSet up new agent triggers
agentTrigger:updateModify agent trigger configurations
agentTrigger:deleteRemove agent triggers
scheduledTask:readView scheduled tasks and their run history
scheduledTask:createCreate new scheduled tasks and trigger runs
scheduledTask:updateModify scheduled task configuration
scheduledTask:deleteDelete scheduled tasks
scheduledTask:adminView and manage all scheduled tasks, not just your own
PermissionDescription
llmProxy:readView and list LLM proxies
llmProxy:createCreate new LLM proxies
llmProxy:updateModify LLM proxy configuration
llmProxy:deleteDelete LLM proxies
llmProxy:team-adminManage team assignments for LLM proxies
llmProxy:adminFull administrative control over all LLM proxies
llmProviderApiKey:readView LLM provider API keys
llmProviderApiKey:createAdd new LLM provider API keys
llmProviderApiKey:updateModify LLM provider API key configuration and visibility
llmProviderApiKey:deleteRemove LLM provider API keys
llmProviderApiKey:adminManage all LLM provider API keys, including org-wide keys
llmVirtualKey:readView LLM virtual keys
llmVirtualKey:createCreate LLM virtual keys
llmVirtualKey:updateModify LLM virtual keys and their visibility
llmVirtualKey:deleteDelete LLM virtual keys
llmVirtualKey:adminManage all LLM virtual keys and view every scope
llmOauthClient:readView LLM OAuth client registrations
llmOauthClient:createCreate LLM OAuth client registrations
llmOauthClient:updateModify LLM OAuth client registrations
llmOauthClient:deleteDelete LLM OAuth client registrations
llmOauthClient:adminManage all LLM OAuth client registrations
llmSettings:readView LLM settings (compression, cleanup interval)
llmSettings:updateModify LLM settings
llmModel:readView synced LLM models and capabilities
llmModel:updateModify LLM model pricing and modality settings
llmLimit:readView token usage limits
llmLimit:createCreate new usage limits
llmLimit:updateModify existing usage limits
llmLimit:deleteRemove usage limits
llmCost:readView LLM usage cost statistics and analytics
optimizationRule:readView optimization rules
optimizationRule:createCreate new optimization rules
optimizationRule:updateModify optimization rules
optimizationRule:deleteRemove optimization rules
PermissionDescription
mcpGateway:readView and list MCP gateways
mcpGateway:createCreate new MCP gateways
mcpGateway:updateModify MCP gateway configuration
mcpGateway:deleteDelete MCP gateways
mcpGateway:team-adminManage team assignments for MCP gateways
mcpGateway:adminFull administrative control over all MCP gateways
mcpRegistry:readBrowse the MCP server registry
mcpRegistry:createAdd servers to the MCP registry
mcpRegistry:updateModify MCP registry entries
mcpRegistry:deleteRemove servers from the MCP registry
mcpRegistry:team-adminManage team assignments for MCP registry entries
mcpServerInstallation:readView installed MCP servers and their status
mcpServerInstallation:createInstall MCP servers from the registry
mcpServerInstallation:updateModify installed MCP server configuration
mcpServerInstallation:deleteUninstall MCP servers
mcpServerInstallation:adminApprove or manage all MCP server installations
mcpServerInstallationRequest:readView MCP server installation requests
mcpServerInstallationRequest:createSubmit requests to install MCP servers
mcpServerInstallationRequest:updateAdd notes to installation requests
mcpServerInstallationRequest:deleteDelete installation requests
mcpServerInstallationRequest:adminApprove or decline installation requests
toolPolicy:readView tools, tool invocation policies, and trusted data policies
toolPolicy:createRegister tools and create security policies
toolPolicy:updateModify tools, tool configuration, and security policies
toolPolicy:deleteRemove tools and security policies
PermissionDescription
knowledgeFile:readView uploaded Knowledge Files
knowledgeFile:createUpload Knowledge Files
knowledgeFile:updateModify Knowledge File visibility and agent access
knowledgeFile:deleteDelete Knowledge Files
knowledgeFile:adminView all Knowledge Files, bypassing visibility restrictions
knowledgeSource:readView Knowledge Bases and Connectors
knowledgeSource:createCreate Knowledge Bases and Connectors
knowledgeSource:updateModify Knowledge Bases and Connectors
knowledgeSource:deleteDelete Knowledge Bases and Connectors
knowledgeSource:queryQuery knowledge sources for information retrieval
knowledgeSource:adminView all Knowledge Bases and Connectors, bypassing visibility restrictions
knowledgeSettings:readView knowledge settings (embedding and reranking models)
knowledgeSettings:updateModify knowledge settings (embedding and reranking models)
PermissionDescription
member:readView organization members and their roles
member:createAdd new members to the organization
member:updateChange member roles and settings
member:deleteRemove members from the organization
team:readView teams and their members
team:createCreate new teams
team:updateModify team settings
team:deleteDelete teams
team:adminManage team membership (add/remove members)
invitation:createSend invitations to new users
invitation:cancelCancel pending invitations
organizationSettings:readView organization settings
organizationSettings:updateCustomize organization appearance, authentication, etc.
identityProvider:readView identity provider configurations (SSO)
identityProvider:createSet up new identity providers
identityProvider:updateModify identity provider settings
identityProvider:deleteRemove identity providers
environment:adminCreate, edit, and delete deployment environments (everyone can view them)
environment:deploy-to-restrictedDeploy catalog items to restricted environments
githubAppConfig:readView GitHub App configurations
githubAppConfig:createCreate GitHub App configurations
githubAppConfig:updateModify GitHub App configurations
githubAppConfig:deleteDelete GitHub App configurations
auditLog:readView the organization-wide audit log of administrative actions
PermissionDescription
apiKey:readView API keys
apiKey:createCreate API keys
apiKey:deleteDelete API keys
serviceAccount:readView service accounts
serviceAccount:createCreate service accounts
serviceAccount:updateModify service accounts
serviceAccount:deleteDelete service accounts
secret:readView secrets manager configuration
secret:updateModify secrets manager settings and test connectivity
chat:readView and access chat conversations
chat:createStart new chat conversations
chat:updateEdit chat messages and conversation settings
chat:deleteDelete chat conversations
chatAgentPicker:enableShow agent picker in chat
chatExpandToolCalls:enableAllow expanding tool call details in chat
chatProviderSettings:enableShow model and API key selectors in chat
simpleView:enableSidebar is collapsed by default on page load
siteNotification:readView site-wide notifications
siteNotification:createCreate new site notifications
siteNotification:updateModify site notifications
siteNotification:deleteDelete site notifications
log:readView LLM proxy and MCP tool call logs

Scoped Resources

Some resources use a two-step authorization model. RBAC grants a base action (read, create, update, delete), and then runtime scope rules further restrict which records a user can actually see or modify. The most common scopes are:
  • personal — owned by one user
  • team — shared with one or more teams
  • org — shared across the entire organization

Agents, MCP Gateways, and LLM Proxies

These three resources share the same scope model:
ScopeWho can access
personalThe author only
teamRequires <resource>:team-admin and membership in at least one assigned team
orgRequires <resource>:admin
agent:delete alone does not allow deleting every agent — it only applies to agents within the user’s permitted scope. Use agent:admin to bypass scope restrictions entirely.

Visibility-Scoped Credentials

llmProviderApiKey and llmVirtualKey support personal, team, and org scope but use different elevated permissions. Team records require membership in the selected team; organization-wide records require the resource-specific admin permission such as llmProviderApiKey:admin. These resources do not use :team-admin.

Chat Access

Chat access requires both chat:read and agent:read because chat is agent-backed — a user must be able to access at least one agent or profile context to start or use chat. The chatAgentPicker:enable, chatProviderSettings:enable, and chatExpandToolCalls:enable permissions are UI toggles only and do not grant access to provider credentials or model catalogs on their own.

Team-Based Access Control

Teams allow you to share agents, MCP gateways, LLM proxies, and MCP servers with specific groups of users. Team-based access works alongside RBAC — roles control what actions a user can perform, and teams control which records they can see.
1

Create teams for different groups

Navigate to Settings > Teams and create teams that reflect your organizational structure, such as “Data Scientists”, “Developers”, or “Security”.
2

Assign resources to teams

When creating or editing an agent, MCP gateway, LLM proxy, or MCP server, set its visibility to the relevant team.
3

Add users to teams

Add users to teams based on their role and responsibilities. Users will automatically see the resources assigned to their teams.

Default Team

New users are automatically added to the Default Team when they accept an invitation. This ensures all users have immediate access to any Archestra resources assigned to this team.

Team Access Rules

MCP Gateways, LLM Proxies & Agents

Users can only see resources assigned to teams they belong to. Exceptions: users with the :admin permission see all records; resources with no team assignment are visible to all users.

MCP Servers

Users can only access MCP servers assigned to their teams. Exceptions: users with mcpServerInstallation:admin see all servers; servers with no team assignment are accessible to all users.
Team-based access also extends to related artifacts such as interaction logs, policies, and tool assignments — members can only view these for agents and MCP servers they have access to.

Best Practices

Start new users with the Member role and add specific permissions as needed. This principle of least privilege reduces the blast radius of accidental or malicious actions.
  • Principle of Least Privilege — Grant only the minimum permissions necessary for a user’s role.
  • Team-based organization — Combine roles with teams for fine-grained resource access rather than granting broad org-wide permissions.
  • Regular review — Periodically review custom roles and team memberships to ensure they align with current needs and security requirements.
  • Clear naming — Use descriptive names for custom roles that indicate their purpose, such as Agent-Manager, Read-Only-Analyst, or Tool-Developer.

Build docs developers (and LLMs) love