org_details

Creates, updates, deletes, gets or lists an org_details resource.

Overview

Name	org_details
Type	Resource
Id	github.copilot.org_details

Fields

The following fields are returned by SELECT queries:

get_copilot_organization_details

Name	Datatype	Description
cli	string	The organization policy for allowing or disallowing Copilot CLI. (enabled, disabled, unconfigured)
ide_chat	string	The organization policy for allowing or disallowing Copilot Chat in the IDE. (enabled, disabled, unconfigured)
plan_type	string	The Copilot plan of the organization, or the parent enterprise, when applicable. (business, enterprise)
platform_chat	string	The organization policy for allowing or disallowing Copilot features on GitHub.com. (enabled, disabled, unconfigured)
public_code_suggestions	string	The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). (allow, block, unconfigured)
seat_breakdown	object	The breakdown of Copilot Business seats for the organization. (title: Copilot Seat Breakdown)
seat_management_setting	string	The mode of assigning new seats. (assign_all, assign_selected, disabled, unconfigured)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_copilot_organization_details	select	org		> [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "Managing policies for Copilot in your organization." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org 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
org	string	The organization name. The name is not case sensitive.

SELECT examples

get_copilot_organization_details

> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot subscription, including seat breakdown
and feature policies. To configure these settings, go to your organization's settings on GitHub.com.
For more information, see "Managing policies for Copilot in your organization."

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

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

SELECT
cli,
ide_chat,
plan_type,
platform_chat,
public_code_suggestions,
seat_breakdown,
seat_management_setting
FROM github.copilot.org_details
WHERE org = '{{ org }}' -- required
;