Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
docs: comprehensive RBAC permissions matrix and deployment guide (#5112)
iris-clawd52249683a726
diff --git a/docs/en/enterprise/features/rbac.mdx b/docs/en/enterprise/features/rbac.mdxindex 216a29d39..3f58c000d 100644--- a/docs/en/enterprise/features/rbac.mdx+++ b/docs/en/enterprise/features/rbac.mdx@@ -7,11 +7,13 @@ mode: "wide"## Overview-RBAC in CrewAI AMP enables secure, scalable access management through a combination of organization‑level roles and automation‑level visibility controls.+RBAC in CrewAI AMP enables secure, scalable access management through two layers:++1. **Feature permissions** — control what each role can do across the platform (manage, read, or no access)+2. **Entity-level permissions** — fine-grained access on individual automations, environment variables, LLM connections, and Git repositories<Frame><img src="/images/enterprise/users_and_roles.png" alt="RBAC overview in CrewAI AMP" />-</Frame>## Users and Roles@@ -39,6 +41,13 @@ You can configure users and roles in Settings → Roles.</Step></Steps>+### Predefined Roles++| Role | Description |+| :--------- | :-------------------------------------------------------------------------- |+| **Owner** | Full access to all features and settings. Cannot be restricted. |+| **Member** | Read access to most features, manage access to Studio projects. Cannot modify organization or default settings. |+### Configuration summary| Area | Where to configure | Options |@@ -46,23 +55,80 @@ You can configure users and roles in Settings → Roles.| Users & Roles | Settings → Roles | Predefined: Owner, Member; Custom roles || Automation visibility | Automation → Settings → Visibility | Private; Whitelist users/roles |-## Automation‑level Access Control+---++## Feature Permissions Matrix++Every role has a permission level for each feature area. The three levels are:++- **Manage** — full read/write access (create, edit, delete)+- **Read** — view-only access+- **No access** — feature is hidden/inaccessible++| Feature | Owner | Member (default) | Description |+| :------------------------ | :------ | :--------------- | :-------------------------------------------------------------- |+| `usage_dashboards` | Manage | Read | View usage metrics and analytics |+| `crews_dashboards` | Manage | Read | View deployment dashboards, access automation details |+| `invitations` | Manage | Read | Invite new members to the organization |+| `training_ui` | Manage | Read | Access training/fine-tuning interfaces |+| `tools` | Manage | Read | Create and manage tools |+| `agents` | Manage | Read | Create and manage agents |+| `environment_variables` | Manage | Read | Create and manage environment variables |+| `llm_connections` | Manage | Read | Configure LLM provider connections |+| `default_settings` | Manage | No access | Modify organization-wide default settings |+| `organization_settings` | Manage | No access | Manage billing, plans, and organization configuration |+| `studio_projects` | Manage | Manage | Create and edit projects in Studio |++<Tip>+ When creating a custom role, you can set each feature independently to **Manage**, **Read**, or **No access** to match your team's needs.+</Tip>++---++## Deploying from GitHub or Zip++One of the most common RBAC questions is: _"What permissions does a team member need to deploy?"_++### Deploy from GitHub++To deploy an automation from a GitHub repository, a user needs:++1. **`crews_dashboards`**: at least `Read` — required to access the automations dashboard where deployments are created+2. **Git repository access** (if entity-level RBAC for Git repositories is enabled): the user's role must be granted access to the specific Git repository via entity-level permissions+3. **`studio_projects`: `Manage`** — if building the crew in Studio before deploying++### Deploy from Zip++To deploy an automation from a Zip file upload, a user needs:++1. **`crews_dashboards`**: at least `Read` — required to access the automations dashboard+2. **Zip deployments enabled**: the organization must not have disabled zip deployments in organization settings++### Quick Reference: Minimum Permissions for Deployment++| Action | Required feature permissions | Additional requirements |+| :------------------- | :------------------------------------ | :----------------------------------------------- |+| Deploy from GitHub | `crews_dashboards: Read` | Git repo entity access (if Git RBAC is enabled) |+| Deploy from Zip | `crews_dashboards: Read` | Zip deployments must be enabled at the org level |+| Build in Studio | `studio_projects: Manage` | — |+| Configure LLM keys | `llm_connections: Manage` | — |+| Set environment vars | `environment_variables: Manage` | Entity-level access (if entity RBAC is enabled) |++---++## Automation‑level Access Control (Entity Permissions)++In addition to organization‑wide roles, CrewAI supports fine‑grained entity-level permissions that restrict access to individual resources.-In addition to organization‑wide roles, CrewAI Automations support fine‑grained visibility settings that let you restrict access to specific automations by user or role.+### Automation Visibility-This is useful for:+Automations support visibility settings that restrict access by user or role. This is useful for:- Keeping sensitive or experimental automations private- Managing visibility across large teams or external collaborators- Testing automations in isolated contexts-Deployments can be configured as private, meaning only whitelisted users and roles will be able to:--- View the deployment-- Run it or interact with its API-- Access its logs, metrics, and settings--The organization owner always has access, regardless of visibility settings.+Deployments can be configured as private, meaning only whitelisted users and roles will be able to interact with them.You can configure automation‑level access control in Automation → Settings → Visibility tab.@@ -99,9 +165,92 @@ You can configure automation‑level access control in Automation → Settings<Frame><img src="/images/enterprise/visibility.png" alt="Automation Visibility settings in CrewAI AMP" />-</Frame>+### Deployment Permission Types++When granting entity-level access to a specific automation, you can assign these permission types:++| Permission | What it allows |+| :------------------- | :-------------------------------------------------- |+| `run` | Execute the automation and use its API |+| `traces` | View execution traces and logs |+| `manage_settings` | Edit, redeploy, rollback, or delete the automation |+| `human_in_the_loop` | Respond to human-in-the-loop (HITL) requests |+| `full_access` | All of the above |++### Entity-level RBAC for Other Resources++When entity-level RBAC is enabled, access to these resources can also be controlled per user or role:++| Resource | Controlled by | Description |+| :--------------------- | :------------------------------- | :---------------------------------------------------- |+| Environment variables | Entity RBAC feature flag | Restrict which roles/users can view or manage specific env vars |+| LLM connections | Entity RBAC feature flag | Restrict access to specific LLM provider configurations |+| Git repositories | Git repositories RBAC org setting | Restrict which roles/users can access specific connected repos |++---++## Common Role Patterns++While CrewAI ships with Owner and Member roles, most teams benefit from creating custom roles. Here are common patterns:++### Developer Role++A role for team members who build and deploy automations but don't manage organization settings.++| Feature | Permission |+| :------------------------ | :--------- |+| `usage_dashboards` | Read |+| `crews_dashboards` | Manage |+| `invitations` | Read |+| `training_ui` | Read |+| `tools` | Manage |+| `agents` | Manage |+| `environment_variables` | Manage |+| `llm_connections` | Read |+| `default_settings` | No access |+| `organization_settings` | No access |+| `studio_projects` | Manage |++### Viewer / Stakeholder Role++A role for non-technical stakeholders who need to monitor automations and view results.++| Feature | Permission |+| :------------------------ | :--------- |+| `usage_dashboards` | Read |+| `crews_dashboards` | Read |+| `invitations` | No access |+| `training_ui` | Read |+| `tools` | Read |+| `agents` | Read |+| `environment_variables` | No access |+| `llm_connections` | No access |+| `default_settings` | No access |+| `organization_settings` | No access |+| `studio_projects` | Read |++### Ops / Platform Admin Role++A role for platform operators who manage infrastructure settings but may not build agents.++| Feature | Permission |+| :------------------------ | :--------- |+| `usage_dashboards` | Manage |+| `crews_dashboards` | Manage |+| `invitations` | Manage |+| `training_ui` | Read |+| `tools` | Read |+| `agents` | Read |+| `environment_variables` | Manage |+| `llm_connections` | Manage |+| `default_settings` | Manage |+| `organization_settings` | Read |+| `studio_projects` | Read |++---+<Card title="Need Help?" icon="headset" href="mailto:[email protected]">Contact our support team for assistance with RBAC questions.</Card>