Regularly optimize cost and seat usage for an organization by removing unused Copilot for Business seat assignments from the Organization.
If your organization has enabled Copilot access for all members, then the delete API will not work. Enable access for selected members in order to manage seats via the API. In this case, you can use the report to manually remove the seat assignments.
Note: 4-Mar-2024 This Action uses the Copilot for Business API, which is in public Beta and subject to change
Create a Fine-grained personal access tokens with
- Resource owner as Organization
- read & write access to GitHub Copilot for Business under Organization permissions
Pass this token as an input to the action - GITHUB_TOKEN
Incorporate the copilot-user-mgmt action into your workflow and initiate the workflow either manually or through a schedule. For a routine identification of inactive users and their removal from Copilot seat assignments, utilize the scheduled workflow. This workflow can be set to run on the 26th of each month, checking for users inactive for the last 25 days or those who have never used Copilot, and subsequently removing them. This approach allows sufficient time for seat assignment reversion if needed, and ensures the removal takes effect as part of the next billing cycle.
Sample workflow 0: Manual trigger to Report and Eliminate Copilot Seat assignment for Users inactive for last n days
name: Copilot User Management to Report Inactive Users
on:
workflow_dispatch:
inputs:
org_name:
description: 'Organization name'
required: true
default: 'octodemo'
csv_path:
description: 'CSV File path'
required: true
default: 'data/Copilot-Usage-Report.csv'
is_delete:
description: 'Eliminate Inactive Users and Users inactive for the past n days'
required: false
type: boolean
default: false
inactive_only:
description: 'Remove only the inactive users from seat assignments'
required: false
type: boolean
default: false
inactive_days:
description: 'Number of days to identify an inactive user.'
required: false
default: '25'
jobs:
first-job:
runs-on: ubuntu-latest
steps:
- name: Copilot User Management
uses: ambilykk/copilot-user-mgmt@main
with:
GITHUB_TOKEN: ${{ secrets.GH_TOK }}
org_name: ${{ inputs.org_name }}
csv_path: ${{ inputs.csv_path }}
is_delete: ${{ inputs.is_delete }}
inactive_only: ${{ inputs.inactive_only }}
inactive_days: ${{ inputs.inactive_days }}
- name: Upload Copilot Usage Report for Inactive Users
uses: actions/upload-artifact@v4
with:
name: Copilot Usage Report
path: ${{ inputs.csv_path }}
This will shows all options in the workflow dispatch UI. You can select the options and trigger the workflow.
Sample workflow 1: Copilot User Management to Report Inactive Users
name: Copilot User Management to Report Inactive Users
on:
workflow_dispatch:
jobs:
first-job:
runs-on: ubuntu-latest
steps:
- name: Copilot User Management
uses: ambilykk/copilot-user-mgmt@main
with:
GITHUB_TOKEN: ${{secrets.ORG_TOKEN}}
org_name: 'octodemo'
csv_path: data/Copilot-Usage-Report.csv
inactive_only: true
- name: Upload Copilot Usage Report for Inactive Users
uses: actions/upload-artifact@v3
with:
name: Copilot Usage Report
path: data/Copilot-Usage-Report.csv
Sample workflow 2: Copilot User Management to Eliminate Copilot Seat assignment for Inactive Users
name: Copilot User Management to Eliminate Copilot Seat assignment for Inactive Users
on:
workflow_dispatch:
jobs:
first-job:
runs-on: ubuntu-latest
steps:
- name: Copilot User Management
uses: ambilykk/copilot-user-mgmt@main
with:
GITHUB_TOKEN: ${{secrets.ORG_TOKEN}}
org_name: 'octodemo'
csv_path: data/Copilot-Usage-Report.csv
inactive_only: true
is_delete: true
- name: Upload Copilot Usage Report for Inactive Users
uses: actions/upload-artifact@v3
with:
name: Copilot Usage Report
path: data/Copilot-Usage-Report.csv
Sample workflow 3: Revise Copilot User Management to Report Inactive Users and Users inactive for the past 50 days.
name: Copilot User Management to Report Users inactive for last 50 days
on:
workflow_dispatch:
jobs:
first-job:
runs-on: ubuntu-latest
steps:
- name: Copilot User Management
uses: ambilykk/copilot-user-mgmt@main
with:
GITHUB_TOKEN: ${{secrets.ORG_TOKEN}}
org_name: 'octodemo'
csv_path: data/Copilot-Usage-Report.csv
inactive_days: 50
- name: Upload Copilot Usage Report for Inactive Users
uses: actions/upload-artifact@v3
with:
name: Copilot Usage Report
path: data/Copilot-Usage-Report.csv
Sample workflow 4: Revise Copilot User Management to Eliminate Copilot Seat assignment for Inactive Users and Users inactive for the past 50 days.
name: Copilot User Management to Eliminate Copilot Seat assignment for Users inactive for last 50 days
on:
workflow_dispatch:
jobs:
first-job:
runs-on: ubuntu-latest
steps:
- name: Copilot User Management
uses: ambilykk/copilot-user-mgmt@main
with:
GITHUB_TOKEN: ${{secrets.ORG_TOKEN}}
org_name: 'octodemo'
csv_path: data/Copilot-Usage-Report.csv
inactive_days: 50
is_delete: true
- name: Upload Copilot Usage Report for Inactive Users
uses: actions/upload-artifact@v3
with:
name: Copilot Usage Report
path: data/Copilot-Usage-Report.csv
| Name | Required | Description |
|---|---|---|
| GITHUB_TOKEN | Yes | PAT Token for access |
| org_name | Yes | GitHub Organization Name |
| csv_path | Yes | CSV file path for the Copilot Seat report |
| inactive_only | No | Generate a report exclusively for inactive users who Never used Copilot or No Activity yet. The default is set to false. When set to true, only the inactive users who have never used Copilot will be listed. |
| inactive_days | No | Generate a report for users who have been inactive for the past n days, with the default value set to 25 days. |
| is_delete | No | Remove Copilot Seat assignment for inactive users. The default setting is false. When set to false, only the report will be generated. If set to true, in addition to the inactive user report, users will be Removed from copilot seat assignments. |
Following fields are included in the Copilot Usage Report
- User
- Created At
- Updated At
- Last Activity At
- Last Activity Editor
- Pending Cancellation Date
- Team
- Status - this field have the default value as 'pending_cancellation'. If the user is removed, this turned to 'deleted'
You can Fork and modify the Actions code to incorporate User management using Teams. Incorporate the Remove teams from the Copilot subscription for an organization API instead of Remove users from the Copilot subscription for an organization
Copilot usage report is added as a build artifact in the workflow. You can download the report from the workflow run page.
The scripts and documentation in this project are released under the MIT License