Skip to content
forgit api docs

Add organizations to the enterprise coding agent policy

POST
/enterprises/{enterprise}/copilot/policies/coding_agent/organizations

Enables Copilot cloud agent for the specified organizations within the enterprise.

The enterprise’s coding agent policy must be set to enabled_for_selected_orgs before using this endpoint. Organizations can be specified by login or matched via custom properties.

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

Only enterprise owners can add organizations to the coding agent policy.

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

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
enterprise
required
string

The slug version of the enterprise name.

Request Body required

Section titled “ Request Body required ”

The organizations to enable Copilot cloud agent for

Media type application/json
object
organizations

List of organization logins within the enterprise to enable Copilot cloud agent for.

Array<string>
custom_properties

List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.

Array<object>
object
property_name
required

The name of the custom property to filter by.

string
values
required

The values of the custom property to match.

Array<string>
Examples
Example default

Add organizations that match a login or have a custom property 

{
  "organizations": [
    "my-org-1",
    "my-org-2"
  ],
  "custom_properties": [
    {
      "property_name": "department",
      "values": [
        "engineering",
        "security"
      ]
    }
  ]
}

Responses

Section titled “ Responses ”

204

Section titled “ 204 ”

A header with no content is returned.

400

Section titled “ 400 ”

Bad Request

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"
}