coding_agent_policy_orgs

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

Overview

Name	coding_agent_policy_orgs
Type	Resource
Id	github.copilot.coding_agent_policy_orgs

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:

Name	Accessible by	Required Params	Optional Params	Description
add_organizations_to_enterprise_coding_agent_policy	insert	enterprise		Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to enabled_for_selected_orgs before using this endpoint. Organizations can be specified by login or matched via custom properties. Only organizations that have Copilot enabled and belong to the enterprise will be affected. Only enterprise owners can add organizations to the coding agent policy. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.
remove_organizations_from_enterprise_coding_agent_policy	delete	enterprise		Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to enabled_for_selected_orgs before using this endpoint. Organizations can be specified by login or matched via custom properties. Only organizations that have Copilot enabled and belong to the enterprise will be affected. Only enterprise owners can remove organizations from the coding agent policy. 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.

Name	Datatype	Description
enterprise	string	The slug version of the enterprise name.

INSERT examples

add_organizations_to_enterprise_coding_agent_policy

Enables Copilot cloud agent for the specified organizations within the enterprise.

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before
using this endpoint. Organizations can be specified by login or matched via custom properties.

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

Only enterprise owners can add organizations to the coding agent policy.

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

INSERT INTO github.copilot.coding_agent_policy_orgs (
organizations,
custom_properties,
enterprise
)
SELECT 
'{{ organizations }}',
'{{ custom_properties }}',
'{{ enterprise }}'
;

Manifest

# Description fields are for documentation purposes
- name: coding_agent_policy_orgs
props:
  - name: enterprise
    value: "{{ enterprise }}"
    description: Required parameter for the coding_agent_policy_orgs resource.
  - name: organizations
    value:
      - "{{ organizations }}"
    description: |
      List of organization logins within the enterprise to enable Copilot cloud agent for.
  - name: custom_properties
    description: |
      List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.
    value:
      - property_name: "{{ property_name }}"
        values: "{{ values }}"

DELETE examples

remove_organizations_from_enterprise_coding_agent_policy

Disables Copilot cloud agent for the specified organizations within the enterprise.

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before
using this endpoint. Organizations can be specified by login or matched via custom properties.

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

Only enterprise owners can remove organizations from the coding agent policy.

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

DELETE FROM github.copilot.coding_agent_policy_orgs
WHERE enterprise = '{{ enterprise }}' --required
;