| title | Enterprise managed settings reference | ||
|---|---|---|---|
| shortTitle | Managed settings reference | ||
| intro | Reference for the enterprise managed settings schema used by {% data variables.product.prodname_copilot_short %} clients. | ||
| versions |
|
||
| contentType | reference | ||
| category |
|
Use this reference to understand the currently supported keys in {% data variables.copilot.managed_setting_file %}.
For deployment methods and supported clients, see AUTOTITLE.
When multiple settings sources are present, settings earlier in this list take precedence over settings later in the list:
- MDM-managed settings
- Server-managed settings
- File-based settings
- User-level settings
{% rowheaders %}
| Key | Purpose | {% data variables.copilot.copilot_cli_short %} | {% data variables.product.prodname_vscode_shortname %} | {% data variables.copilot.github_copilot_app %} | {% data variables.copilot.copilot_cloud_agent %} |
|---|---|---|---|---|---|
permissions.disableBypassPermissionsMode |
Disables bypass or YOLO-style allow-all behavior | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
permissions.model |
Sets auto model selection as the default for new conversations | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
enabledPlugins |
Enables or disables specific plugins by key | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
extraKnownMarketplaces |
Adds plugin marketplaces that users can access | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
strictKnownMarketplaces |
Restricts plugin installation to explicitly listed marketplaces | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
telemetry |
Configures OpenTelemetry export, routing {% data variables.product.prodname_copilot_short %} usage data to a collector of your choice | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} |
remoteControl |
Restricts whether sessions hosted on this device can be remotely controlled, based on the controlling client's SSO authorization status for the listed organizations. Doesn't affect the user's ability to remotely control sessions hosted on other devices | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
{% endrowheaders %}
The following example shows these keys in one managed settings file.
{
"permissions": {
"disableBypassPermissionsMode": "disable",
"model": "auto"
},
"enabledPlugins": {
"my-plugin@agent-skills": true
},
"extraKnownMarketplaces": {
"agent-skills": {
"source": {
"source": "github",
"repo": "OWNER/REPO"
}
}
},
"strictKnownMarketplaces": [
{
"source": "github",
"repo": "OWNER/REPO"
}
],
"telemetry": {
"enabled": true,
"endpoint": "https://otel-collector.example.com",
"protocol": "http/protobuf",
"captureContent": false,
"lockCaptureContent": true,
"serviceName": "copilot",
"resourceAttributes": {
"deployment.environment": "production"
},
"headers": {
"Authorization": "Bearer TOKEN"
}
},
"remoteControl": {
"mode": "requireSSO",
"githubDotComOrganizations": ["ORG-NAME"]
}
}Defines plugins that are automatically installed or blocked for all enterprise users. Each entry uses the format PLUGIN-NAME@MARKETPLACE-NAME as the key, with a boolean value: true to require the plugin to be enabled, or false to require it to be disabled. See AUTOTITLE.
Defines additional plugin marketplaces available to users. Each entry is a named marketplace object containing a source property. The following source types are supported:
"github"— requiresrepoinOWNER/REPOformat; optionalref(branch, tag, or SHA) andpath(subdirectory)"git"— requiresurl; optionalrefandpath"directory"— requirespath
See AUTOTITLE.
Restricts plugin installation to only the marketplaces explicitly defined by the enterprise. An empty array means complete lockdown. Each entry is a marketplace object with a source property indicating the source type. The following source types are supported:
"github"— requiresrepoinOWNER/REPOformat; optionalrefandpath"git"— requiresurl; optionalrefandpath"url"— requiresurl; optionalheadersobject"npm"— requirespackage"file"— requirespath"directory"— requirespath"hostPattern"— requireshostPattern(regex matching marketplace hosts)"pathPattern"— requirespathPattern(regex matching marketplace paths)
Prevents users from enabling bypass mode (also known as "YOLO mode"). Bypass mode lets an agent run commands, access files, and fetch URLs without asking for approval.
When you set disableBypassPermissionsMode to "disable", users cannot turn on bypass mode:
- In {% data variables.copilot.copilot_cli_short %}, all of the command line options for allowing all permissions (
--yolo,--allow-all, and the individual--allow-all-tools,--allow-all-paths, and--allow-all-urlsoptions) are suppressed at startup and cannot grant elevated permissions. The/yoloand/allow-allslash commands are also blocked. - In {% data variables.product.prodname_vscode_shortname %}, the global auto-approve setting (
chat.tools.global.autoApprove) is turned off and cannot be re-enabled. - In the {% data variables.copilot.github_copilot_app %}, the "Allow all" setting for "Tool Permissions" is blocked in the sessions settings.
Sets auto model selection as the default for new conversations. See AUTOTITLE.
When you set permissions.model to "auto", new sessions use Auto model unless the user specifies a different model on a per-conversation basis.
Configures OpenTelemetry export, routing {% data variables.product.prodname_copilot_short %} usage data to a collector of your choice.
This property is supported for {% data variables.copilot.copilot_cli_short %} and {% data variables.product.prodname_vscode_shortname %}.
When you set the telemetry property, {% data variables.product.prodname_copilot_short %} telemetry is sent to the endpoint you specify. The following sub-properties are supported:
enabled: Set totrueto turn on telemetry export, orfalseto turn it off.endpoint: The URL of your OTLP collector (for example,https://otel-collector.example.com).protocol: The transport protocol for telemetry export. Accepted values are"http/json"and"http/protobuf".captureContent: Set totrueto include prompt and response content in the telemetry payload, orfalseto exclude it.lockCaptureContent: Set totrueto prevent users from changing thecaptureContentsetting.serviceName: A label for the telemetry service name (for example,"copilot").resourceAttributes: An object of OpenTelemetry resource attributes to attach to all exported telemetry (for example,{"deployment.environment": "production"}).headers: An object of HTTP headers to include with each telemetry request (for example, anAuthorizationheader for your collector).
Restricts whether {% data variables.product.prodname_copilot_short %} sessions hosted on a device can be remotely controlled. This doesn't affect a user's ability to remotely control their sessions hosted on other devices.
mode: Set to"disabled"to prevent remote control of sessions on the device,"requireSSO"to only allow remote control from a client that is SSO-authorized for the organizations listed ingithubDotComOrganizations, or"enabled"to allow it unrestricted.githubDotComOrganizations: An array of organization logins. Required whenmodeis"requireSSO".