Set the coding agent policy for an enterprise

PUT

/enterprises/{enterprise}/copilot/policies/coding_agent

Sets the policy for Copilot cloud agent usage across an enterprise.

Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only.

Only enterprise owners can set the coding agent policy for their enterprise.

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

API method documentation

Parameters

Path Parameters

enterprise

required

string

The slug version of the enterprise name.

Request Body ^required

The coding agent policy configuration

Media type application/json

object

policy_state

required

The policy state for Copilot cloud agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

string

Allowed values: enabled_for_all_orgs disabled_for_all_orgs enabled_for_selected_orgs configured_by_org_admins

Examples

Example default

Enable coding agent for all organizations

{
  "policy_state": "enabled_for_all_orgs"
}

Responses

204

A header with no content is returned.

400

Bad Request

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

Scim Error

Scim Error

object

message

string

nullable

documentation_url

string

nullable

detail

string

nullable

status

integer

scimType

string

nullable

schemas

Array<string>

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "detail": "example",
  "status": 1,
  "scimType": "example",
  "schemas": [
    "example"
  ]
}