Skip to main content

coding_agent_policy

Creates, updates, deletes, gets or lists a coding_agent_policy resource.

Overview

Namecoding_agent_policy
TypeResource
Idgithub.copilot.coding_agent_policy

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
set_enterprise_coding_agent_policyreplaceenterprise, policy_stateSets 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
enterprisestringThe slug version of the enterprise name.

REPLACE examples

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.

REPLACE github.copilot.coding_agent_policy
SET
policy_state = '{{ policy_state }}'
WHERE
enterprise = '{{ enterprise }}' --required
AND policy_state = '{{ policy_state }}' --required;