endpoints de la API REST para la administración de directivas del modelo Copilot
Use la API REST para administrar directivas Copilot de modelo para una organización.
Get model policies for an organization
Use this endpoint to retrieve the effective Copilot model policy for every model available to an organization, whether explicitly configured or determined by default availability.
For a model without an effective explicit policy that is eligible for default availability, the enterprise default is used when it is configured. Otherwise, the organization's default is used. A model that is not eligible for default availability and has no effective explicit policy is disabled. For more information, see About default availability of Copilot models.
The organization must either be independent or belong to an enterprise that is not using enterprise teams for model policy.
Organization owners can use this endpoint.
OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Organization SAML authorization and OAuth app access restrictions also apply.
Tokens de acceso granulares para "Get model policies for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Get model policies for an organization"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
org string ObligatorioThe organization name. The name is not case sensitive. |
Códigos de estado de respuesta HTTP para "Get model policies for an organization"
| código de estado | Descripción |
|---|---|
200 | OK |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Get model policies for an organization"
Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.
Ejemplo de solicitud
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/copilot/model-policiesOK
Status: 200{
"default_availability": {
"policy_state": "disabled",
"editable": true
},
"models": [
{
"model_name": "gpt-5.6-sol",
"display_name": "OpenAI GPT-5.6 Sol",
"policy_state": "enabled"
},
{
"model_name": "gpt-5",
"display_name": "GPT-5",
"policy_state": "disabled"
}
]
}Update model policies for an organization
Use this endpoint to set explicit Copilot model policies and default availability for an organization. All policies in the request are updated atomically, meaning if any change in the request cannot be applied, none of the changes are saved.
Use the model_name values returned by the "Get model policies for an organization"
endpoint. Models with an inherited enterprise policy are locked and cannot be updated.
Default availability cannot be updated when its editable value is false.
The response contains the effective policies for all models available to the organization, not only the policies updated by the request.
The organization must either be independent or belong to an enterprise that is not using enterprise teams for model policy.
Organization owners can use this endpoint.
OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Organization SAML authorization and OAuth app access restrictions apply.
Tokens de acceso granulares para "Update model policies for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Update model policies for an organization"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
org string ObligatorioThe organization name. The name is not case sensitive. |
| Nombre, Tipo, Descripción | |||
|---|---|---|---|
default_availability object The organization's default availability for eligible models without an explicit policy. It cannot be updated when it is inherited from the enterprise. | |||
Properties of |
| Nombre, Tipo, Descripción |
|---|
policy_state string ObligatorioPuede ser uno de los siguientes: |
models array of objects The model policies to update. Each model_name must be unique.
Properties of models
| Nombre, Tipo, Descripción |
|---|
model_name string ObligatorioThe public identifier of a model returned by the get endpoint. |
policy_state string ObligatorioThe explicit policy state to set for the organization. Puede ser uno de los siguientes: |
Códigos de estado de respuesta HTTP para "Update model policies for an organization"
| código de estado | Descripción |
|---|---|
200 | OK |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Ejemplos de código para "Update model policies for an organization"
Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.
Ejemplo de solicitud
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/copilot/model-policies \
-d '{"default_availability":{"policy_state":"disabled"},"models":[{"model_name":"gpt-5.6-sol","policy_state":"enabled"},{"model_name":"gpt-5","policy_state":"disabled"}]}'OK
Status: 200{
"default_availability": {
"policy_state": "disabled",
"editable": true
},
"models": [
{
"model_name": "gpt-5.6-sol",
"display_name": "OpenAI GPT-5.6 Sol",
"policy_state": "enabled"
},
{
"model_name": "gpt-5",
"display_name": "GPT-5",
"policy_state": "disabled"
}
]
}