endpoints da API REST para o gerenciamento da política de modelo do Copilot
Use a API REST para gerenciar Copilot políticas de modelo para uma organização.
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 acesso granulares para "Get model policies for an organization"
Este endpoint funciona com os seguintes tipos de token granulares:
- tokens de acesso do usuário do aplicativo GitHub
- tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Get model policies for an organization"
| Nome, Tipo, Descrição |
|---|
accept string Setting to |
| Nome, Tipo, Descrição |
|---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get model policies for an organization"
| Código de status | Descrição |
|---|---|
200 | OK |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Get model policies for an organization"
Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.
Exemplo de solicitação
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 acesso granulares para "Update model policies for an organization"
Este endpoint funciona com os seguintes tipos de token granulares:
- tokens de acesso do usuário do aplicativo GitHub
- tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Update model policies for an organization"
| Nome, Tipo, Descrição |
|---|
accept string Setting to |
| Nome, Tipo, Descrição |
|---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
| Nome, Tipo, Descrição | |||
|---|---|---|---|
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 |
| Nome, Tipo, Descrição |
|---|
policy_state string ObrigatórioPode ser um dos: |
models array of objects The model policies to update. Each model_name must be unique.
Properties of models
| Nome, Tipo, Descrição |
|---|
model_name string ObrigatórioThe public identifier of a model returned by the get endpoint. |
policy_state string ObrigatórioThe explicit policy state to set for the organization. Pode ser um dos: |
Códigos de status de resposta HTTP para "Update model policies for an organization"
| Código de status | Descrição |
|---|---|
200 | OK |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Update model policies for an organization"
Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.
Exemplo de solicitação
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"
}
]
}