user_seats
Overview
| Name | user_seats |
| Type | Resource |
| Id | github.copilot.user_seats |
Fields
| Name | Datatype | Description |
|---|---|---|
assignee | object | The assignee that has been granted access to GitHub Copilot. |
assigning_team | object | The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. |
created_at | string | Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. |
last_activity_at | string | Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. |
last_activity_editor | string | Last editor that was used by the user for a GitHub Copilot completion. |
pending_cancellation_date | string | The pending cancellation date for the seat, in YYYY-MM-DD format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. |
updated_at | string | Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_copilot_seat_assignment_details_for_user | SELECT | org, username | Note: This endpoint is in beta and is subject to change. Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint. |
add_copilot_for_business_seats_for_users | INSERT | org, data__selected_usernames | Note: This endpoint is in beta and is subject to change. Purchases a GitHub Copilot for Business seat for each user specified. The organization will be billed accordingly. For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. For more information about setting up a Copilot for Business subscription, see "Setting up a Copilot for Business subscription for your organization". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization". |
cancel_copilot_seat_assignment_for_users | EXEC | org, data__selected_usernames | Note: This endpoint is in beta and is subject to change. Cancels the Copilot for Business seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business" For more information about disabling access to Copilot for Business, see "Disabling access to GitHub Copilot for specific users in your organization". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint. |