Get Copilot cloud agent permissions for an organization

GET

/orgs/{org}/copilot/coding-agent/permissions

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

Gets information about which repositories in an organization have been enabled or disabled for the Copilot cloud agent.

Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Responses

200

Response

Media typeapplication/json

object

enabled_repositories

required

The policy for which repositories can use Copilot cloud agent. Can be one of all, selected, or none.

string

Allowed values: all selected none

selected_repositories_url

The URL for the selected repositories endpoint. Only present when enabled_repositories is selected.

string

Examples

All repositories enabled

{
  "enabled_repositories": "all"
}

Selected repositories enabled

{
  "enabled_repositories": "selected",
  "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories"
}

No repositories enabled

{
  "enabled_repositories": "none"
}

401

Requires authentication

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Internal Error

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}