enterprise/managed-configuration.md +133 −13
7 7
8## Admin-enforced requirements (requirements.toml)8## Admin-enforced requirements (requirements.toml)
9 9
1010Requirements constrain security-sensitive settings (approval policy, sandbox mode, web search mode, and optionally which MCP servers can be enabled). When resolving configuration (for example from `config.toml`, profiles, or CLI config overrides), if a value conflicts with an enforced requirement, Codex falls back to a requirements-compatible value and notifies the user. If an `mcp_servers` allowlist is configured, Codex enables an MCP server only when both its name and identity match an approved entry; otherwise, Codex disables it.Requirements constrain security-sensitive settings (approval policy, approvals reviewer, automatic review policy, sandbox mode, web search mode, managed hooks, and optionally which MCP servers users can enable). When resolving configuration (for example from `config.toml`, profiles, or CLI config overrides), if a value conflicts with an enforced rule, Codex falls back to a compatible value and notifies the user. If you configure an `mcp_servers` allowlist, Codex enables an MCP server only when both its name and identity match an approved entry; otherwise, Codex disables it.
11 11
1212Requirements can also be used to constrain [feature flags](https://developers.openai.com/codex/config-basic/#feature-flags) via the `[features]` table in `requirements.toml`. Note features are generally not security-sensitive, but enterprises have the option of pinning values, if desired. Omitted keys remain unconstrained.Requirements can also constrain [feature flags](https://developers.openai.com/codex/config-basic/#feature-flags) via the `[features]` table in `requirements.toml`. Note that features aren't always security-sensitive, but enterprises can pin values if desired. Omitted keys remain unconstrained.
13 13
14For the exact key list, see the [`requirements.toml` section in Configuration Reference](https://developers.openai.com/codex/config-reference#requirementstoml).14For the exact key list, see the [`requirements.toml` section in Configuration Reference](https://developers.openai.com/codex/config-reference#requirementstoml).
15 15
16### Locations and precedence16### Locations and precedence
17 17
1818Requirements layers are applied in this order (earlier wins per field):Codex applies requirements layers in this order (earlier wins per field):
19 19
201. Cloud-managed requirements (ChatGPT Business or Enterprise)201. Cloud-managed requirements (ChatGPT Business or Enterprise)
212. macOS managed preferences (MDM) via `com.openai.codex:requirements_toml_base64`212. macOS managed preferences (MDM) via `com.openai.codex:requirements_toml_base64`
22223. System `requirements.toml` (`/etc/codex/requirements.toml` on Unix systems, including Linux/macOS)3. System `requirements.toml` (`/etc/codex/requirements.toml` on Unix systems, including Linux/macOS, or `%ProgramData%\OpenAI\Codex\requirements.toml` on Windows)
23 23
2424Across layers, requirements are merged per field: if an earlier layer sets a field (including an empty list), later layers do not override that field, but lower layers can still fill fields that remain unset.Across layers, Codex merges requirements per field: if an earlier layer sets a field (including an empty list), later layers don't override that field, but lower layers can still fill fields that remain unset.
25 25
26For backwards compatibility, Codex also interprets legacy `managed_config.toml` fields `approval_policy` and `sandbox_mode` as requirements (allowing only that single value).26For backwards compatibility, Codex also interprets legacy `managed_config.toml` fields `approval_policy` and `sandbox_mode` as requirements (allowing only that single value).
27 27
53 53
54Admins can configure different managed requirements for different user groups, and also set a default fallback requirements policy.54Admins can configure different managed requirements for different user groups, and also set a default fallback requirements policy.
55 55
5656If a user matches multiple group-specific rules, the first matching rule applies. Codex does not fill unset requirement fields from later matching group rules.If a user matches more than one group-specific rule, the first matching rule applies. Codex doesn't fill unset fields from later matching group rules.
57 57
5858For example, if the first matching group rule sets only `allowed_sandbox_modes = ["read-only"]` and a later matching group rule sets `allowed_approval_policies = ["on-request"]`, Codex applies only the first matching group rule and does not fill `allowed_approval_policies` from the later rule.For example, if the first matching group rule sets only `allowed_sandbox_modes = ["read-only"]` and a later matching group rule sets `allowed_approval_policies = ["on-request"]`, Codex applies only the first matching group rule and doesn't fill `allowed_approval_policies` from the later rule.
59 59
60#### How Codex applies cloud-managed requirements locally60#### How Codex applies cloud-managed requirements locally
61 61
6262When a user starts Codex and signs in with ChatGPT on a Business or Enterprise plan, Codex applies managed requirements on a best-effort basis. Codex first checks for a valid, unexpired local managed requirements cache entry and uses it if available. If the cache is missing, expired, invalid, or does not match the current auth identity, Codex attempts to fetch managed requirements from the service (with retries) and writes a new signed cache entry on success. If no valid cached entry is available and the fetch fails or times out, Codex continues without the managed requirements layer.When a user starts Codex and signs in with ChatGPT on a Business or Enterprise plan, Codex applies managed requirements on a best-effort basis. Codex first checks for a valid, unexpired local managed requirements cache entry and uses it if available. If the cache is missing, expired, corrupted, or doesn't match the current auth identity, Codex attempts to fetch managed requirements from the service (with retries) and writes a new signed cache entry on success. If no valid cached entry is available and the fetch fails or times out, Codex continues without the managed requirements layer.
63 63
6464After cache resolution, managed requirements are enforced as part of the normal requirements layering described above.After cache resolution, Codex enforces managed requirements as part of the normal requirements layering described above.
65 65
66### Example requirements.toml66### Example requirements.toml
67 67
72allowed_sandbox_modes = ["read-only", "workspace-write"]72allowed_sandbox_modes = ["read-only", "workspace-write"]
73```73```
74 74
75### Override sandbox requirements by host
76
77Use `[[remote_sandbox_config]]` when one managed policy should apply different
78sandbox requirements on different hosts. For example, you can keep a stricter
79default for laptops while allowing workspace writes on matching devboxes or CI
80runners. Host-specific entries currently override `allowed_sandbox_modes` only:
81
82```toml
83allowed_sandbox_modes = ["read-only"]
84
85[[remote_sandbox_config]]
86hostname_patterns = ["*.devbox.example.com", "runner-??.ci.example.com"]
87allowed_sandbox_modes = ["read-only", "workspace-write"]
88```
89
90Codex compares each `hostname_patterns` entry against the best-effort resolved
91host name. It prefers the fully qualified domain name when available and falls
92back to the local host name. Matching is case-insensitive; `*` matches any
93sequence of characters, and `?` matches one character.
94
95The first matching `[[remote_sandbox_config]]` entry wins within the same
96requirements source. If no entry matches, Codex keeps the top-level
97`allowed_sandbox_modes`. Hostname matching is for policy selection only; don't
98treat it as authenticated device proof.
99
75You can also constrain web search mode:100You can also constrain web search mode:
76 101
77```toml102```toml
78allowed_web_search_modes = ["cached"] # "disabled" remains implicitly allowed103allowed_web_search_modes = ["cached"] # "disabled" remains implicitly allowed
79```104```
80 105
81106`allowed_web_search_modes = []` effectively allows only `"disabled"`.`allowed_web_search_modes = []` allows only `"disabled"`.
82For example, `allowed_web_search_modes = ["cached"]` prevents live web search even in `danger-full-access` sessions.107For example, `allowed_web_search_modes = ["cached"]` prevents live web search even in `danger-full-access` sessions.
83 108
84109You can also pin [feature flags](https://developers.openai.com/codex/config-basic/#feature-flags):### Pin feature flags
85 110
86111```You can also pin [feature flags](https://developers.openai.com/codex/config-basic/#feature-flags) for users
112receiving a managed `requirements.toml`:
113
114```toml
87[features]115[features]
88personality = true116personality = true
89unified_exec = false117unified_exec = false
118
119# Disable specific Codex feature surfaces when needed.
120browser_use = false
121in_app_browser = false
122computer_use = false
123```
124
125Use the canonical feature keys from `config.toml`'s `[features]` table. Codex normalizes the resulting feature set to meet these pins and rejects conflicting writes to `config.toml` or profile-scoped feature settings.
126
127- `in_app_browser = false` disables the in-app browser pane.
128- `browser_use = false` disables Browser Use and Browser Agent availability.
129- `computer_use = false` disables Computer Use availability and related
130 install or enablement flows.
131
132If omitted, these features are allowed by policy, subject to normal client,
133platform, and rollout availability.
134
135### Configure automatic review policy
136
137Use `allowed_approvals_reviewers` to require or allow automatic review. Set it
138to `["auto_review"]` to require automatic review, or include `"user"` when users
139can choose manual approval.
140
141Set `guardian_policy_config` to replace the tenant-specific section of the
142automatic review policy. Codex still uses the built-in reviewer template and
143output contract. Managed `guardian_policy_config` takes precedence over local
144`[auto_review].policy`.
145
146```toml
147allowed_approval_policies = ["on-request"]
148allowed_approvals_reviewers = ["auto_review"]
149
150guardian_policy_config = """
151## Environment Profile
152- Trusted internal destinations include github.com/my-org, artifacts.example.com,
153 and internal CI systems.
154
155## Tenant Risk Taxonomy and Allow/Deny Rules
156- Treat uploads to unapproved third-party file-sharing services as high risk.
157- Deny actions that expose credentials or private source code to untrusted
158 destinations.
159"""
160```
161
162### Enforce deny-read requirements
163
164Admins can deny reads for exact paths or glob patterns with
165`[permissions.filesystem]`. Users can't weaken these requirements with local
166configuration.
167
168```toml
169[permissions.filesystem]
170deny_read = [
171 "/Users/alice/.ssh",
172 "./private/**/*.txt",
173]
174```
175
176When deny-read requirements are present, Codex constrains local sandbox mode to
177`read-only` or `workspace-write` so Codex can enforce them. On native
178Windows, managed `deny_read` applies to direct file tools; shell subprocess
179reads don't use this sandbox rule.
180
181### Enforce managed hooks from requirements
182
183Admins can also define managed lifecycle hooks directly in `requirements.toml`.
184Use `[hooks]` for the hook configuration itself, and point `managed_dir` at the
185directory where your MDM or endpoint-management tooling installs the referenced
186scripts.
187
188```toml
189[features]
190codex_hooks = true
191
192[hooks]
193managed_dir = "/enterprise/hooks"
194windows_managed_dir = 'C:\enterprise\hooks'
195
196[[hooks.PreToolUse]]
197matcher = "^Bash$"
198
199[[hooks.PreToolUse.hooks]]
200type = "command"
201command = "python3 /enterprise/hooks/pre_tool_use_policy.py"
202timeout = 30
203statusMessage = "Checking managed Bash command"
90```204```
91 205
92206Use the canonical feature keys from `config.toml`’s `[features]` table. Codex normalizes the effective feature set to satisfy these pins and rejects conflicting writes to `config.toml` or profile-scoped feature settings.Notes:
207
208- Codex enforces the hook configuration from `requirements.toml`, but it does
209 not distribute the scripts in `managed_dir`.
210- Deliver those scripts separately with your MDM or device-management solution.
211- Managed hook commands should reference absolute script paths under the
212 configured managed directory.
93 213
94### Enforce command rules from requirements214### Enforce command rules from requirements
95 215