org_copilot_seats_users

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

Overview

Name	org_copilot_seats_users
Type	Resource
Id	github.copilot.org_copilot_seats_users

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_copilot_seats_for_users	insert	org, selected_usernames		> [!NOTE] > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "About billing for GitHub Copilot in your organization." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "Subscribing to Copilot for your organization." For more information about setting a suggestion matching policy, see "Managing policies for Copilot in your organization." The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin: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.

INSERT examples

add_copilot_seats_for_users

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

Purchases a GitHub Copilot seat for each user specified.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "About billing for GitHub Copilot in your organization."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "Subscribing to Copilot for your organization."
For more information about setting a suggestion matching policy, see "Managing policies for Copilot in your organization."

The response contains the total number of new seats that were created and existing seats that were refreshed.

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

INSERT INTO github.copilot.org_copilot_seats_users (
selected_usernames,
org
)
SELECT 
'{{ selected_usernames }}' /* required */,
'{{ org }}'
RETURNING
seats_created
;

Manifest

# Description fields are for documentation purposes
- name: org_copilot_seats_users
props:
  - name: org
    value: "{{ org }}"
    description: Required parameter for the org_copilot_seats_users resource.
  - name: selected_usernames
    value:
      - "{{ selected_usernames }}"
    description: |
      The usernames of the organization members to be granted access to GitHub Copilot.