Visão geral da API Chrome Policy
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A API Chrome Policy é um pacote de serviços que permite que os administradores do Chrome vejam e gerenciem programaticamente as políticas do Chrome atribuídas às unidades organizacionais da organização. Com essa API, os administradores do Chrome têm insights sobre como os dispositivos ChromeOS e os navegadores Chrome estão sendo usados na organização.
Principais vantagens
Compatibilidade do Google Admin Console: as alterações feitas com a API são
refletidas na IU do Google Admin Console e vice-versa.
Registro de auditoria:as alterações feitas com essa API são registradas nos registros de auditoria do administrador padrão.
Abordagem baseada em dados:as políticas do Chrome são representadas como dados e não são
referenciadas diretamente pela interface da API. Isso permite automatizar clientes de API
para o consumo de futuras políticas do Chrome sem precisar de desenvolvimento adicional. Com o tempo, o número de políticas compatíveis com a API aumentará.
Complementa a API Admin SDK:essa API complementa a API Admin SDK,
em que os administradores do Chrome podem executar as seguintes tarefas:
Casos de uso conhecidos
A tabela abaixo lista as principais tarefas que podem ser concluídas com essa API. Para analisar
exemplos de solicitações e respostas, acesse Exemplos de código.
Os URLs são relativos a https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER.
| Descrição da tarefa |
URL relativo |
Método HTTP |
Parâmetros de solicitação |
| Listar esquemas de política |
./policySchemas |
GET |
Opcional:filter, pageSize e pageToken. |
| Usar um esquema de política |
./policySchemas/$SCHEMA_NAME |
GET |
|
| Acessar ou listar políticas de uma unidade organizacional ou um grupo |
./policies:resolve |
POST |
Obrigatório:policySchemaFilter, policyTargetKey
Opcional:pageSize, pageToken
|
| Modificar políticas em uma unidade organizacional |
./policies/orgunits:batchModify |
POST |
Obrigatório:requests: {policyTargetKey, policyValue, updateMask} |
| Herdar políticas em uma unidade organizacional |
./policies/orgunits:batchInherit |
POST |
Obrigatório:requests: {policyTargetKey, policySchema} |
| Modificar políticas em um grupo |
./policies/groups:batchModify |
POST |
Obrigatório:requests: {policyTargetKey, policyValue, updateMask} |
| Excluir políticas em um grupo |
./policies/groups:batchDelete |
POST |
Obrigatório:requests: {policyTargetKey, policySchema} |
| Listar ordens de prioridade em um grupo |
./policies/groups:listGroupPriorityOrdering |
POST |
Obrigatório:requests: {policyTargetKey, policyNamespace} |
| Atualizar a ordem de prioridade em um grupo |
./policies/groups:updateGroupPriorityOrdering |
POST |
Obrigatório:requests: {policyTargetKey, policyNamespace, groupIds} |
| Fazer upload de arquivos para uma política |
./policies/files:uploadPolicyFile |
POST |
Obrigatório:requests: {policyField} |
Limites de uso
Essa API só deve ser usada internamente na organização de um cliente do Chrome. Confira mais detalhes nos Termos de Serviço da API Chrome Policy. Para criar um cliente de API comercial em parceria com o Google, envie uma inscrição para parceiro.
Próximas etapas
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eThe Chrome Policy API enables Chrome administrators to programmatically view and manage Chrome policies for their organization's ChromeOS devices and Chrome browsers.\u003c/p\u003e\n"],["\u003cp\u003eIt offers key benefits like Google Admin console compatibility, audit logging, and a data-driven approach for easier automation.\u003c/p\u003e\n"],["\u003cp\u003eAdmins can utilize this API to perform tasks such as listing policy schemas, retrieving specific schemas, and managing policies for organizational units and groups.\u003c/p\u003e\n"],["\u003cp\u003eUsage of this API is restricted to internal use within a Chrome customer's organization, with commercial partnerships requiring a separate application process.\u003c/p\u003e\n"],["\u003cp\u003eFurther exploration is encouraged through provided resources on policy schemas, request setup, and code samples.\u003c/p\u003e\n"]]],[],null,["# Chrome Policy API Overview\n\nThe Chrome Policy API is a suite of services that empower Chrome administrators\nto programmatically view and manage Chrome policies assigned to the\n[Organizational Units](https://support.google.com/a/answer/4352075)\nin their organization. With this API, Chrome admins can gain insights about how\nChromeOS devices and Chrome browsers are being used in their organization.\n\nKey advantages\n--------------\n\n- **Google Admin console compatibility:** Changes you make with the API are\n reflected in Google Admin console UI, and vice versa.\n\n- **Audit logging:** Changes made with this API are logged in the standard\n [Admin Audit logs](https://support.google.com/a/answer/4579579).\n\n- **Data-driven approach:** Chrome policies are represented as data and aren't\n directly referenced by the API interface. This lets you automate API clients\n for consumption of future Chrome policies without additional development. Over\n time, the number of policies supported via API will increase.\n\n- **Complements the Admin SDK API:** This API complements the Admin SDK API,\n where Chrome admins can perform the following tasks:\n\n - [Manage Chrome devices](/admin-sdk/directory/v1/guides/manage-chrome-devices) with the Admin SDK's Directory API.\n - [Manage Chrome browsers](https://support.google.com/chrome/a/answer/9681204) with the Admin SDK's Chrome Browser Management API.\n - [Manage Chrome CUPS printers](/admin-sdk/chrome-printer) with the Admin SDK's Chrome Printer Management API.\n\nPopular use cases\n-----------------\n\nThe table below lists the top tasks you can complete with this API. To review\nexample requests and responses, go to [Code samples](/chrome/policy/guides/samples_policyapi).\n\nURLs are relative to `https://chromepolicy.googleapis.com/v1/customers/`\u003cvar translate=\"no\"\u003e$CUSTOMER\u003c/var\u003e.\n\n| Task description | Relative URL | HTTP method | Request parameters |\n|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------|\n| [List policy schemas](/chrome/policy/reference/rest/v1/customers.policySchemas/list) | `./policySchemas` | `GET` | *Optional:* `filter`, `pageSize`, `pageToken` |\n| [Get a policy schema](/chrome/policy/reference/rest/v1/customers.policySchemas/get) | `./policySchemas/`\u003cvar translate=\"no\"\u003e$SCHEMA_NAME\u003c/var\u003e | `GET` | |\n| [Get or list policies for an Organizational Unit or Group](/chrome/policy/reference/rest/v1/customers.policies/resolve) | `./policies:resolve` | `POST` | *Required:* `policySchemaFilter`, `policyTargetKey` *Optional:* `pageSize`, `pageToken` |\n| [Modify policies in an Organizational Unit](/chrome/policy/reference/rest/v1/customers.policies.orgunits/batchModify) | `./policies/orgunits:batchModify` | `POST` | *Required:* `requests: {policyTargetKey, policyValue, updateMask}` |\n| [Inherit policies in an Organizational Unit](/chrome/policy/reference/rest/v1/customers.policies.orgunits/batchInherit) | `./policies/orgunits:batchInherit` | `POST` | *Required:* `requests: {policyTargetKey, policySchema}` |\n| [Modify policies in a Group](/chrome/policy/reference/rest/v1/customers.policies.groups/batchModify) | `./policies/groups:batchModify` | `POST` | *Required:* `requests: {policyTargetKey, policyValue, updateMask}` |\n| [Delete policies in a Group](/chrome/policy/reference/rest/v1/customers.policies.groups/batchDelete) | `./policies/groups:batchDelete` | `POST` | *Required:* `requests: {policyTargetKey, policySchema}` |\n| [List priority orderings in a Group](/chrome/policy/reference/rest/v1/customers.policies.groups/listGroupPriorityOrdering) | `./policies/groups:listGroupPriorityOrdering` | `POST` | *Required:* `requests: {policyTargetKey, policyNamespace}` |\n| [Update priority orderings in a Group](/chrome/policy/reference/rest/v1/customers.policies.groups/updateGroupPriorityOrdering) | `./policies/groups:updateGroupPriorityOrdering` | `POST` | *Required:* `requests: {policyTargetKey, policyNamespace, groupIds}` |\n| [Upload files for a policy](/chrome/policy/reference/rest/v1/media/upload) | `./policies/files:uploadPolicyFile` | `POST` | *Required:* `requests: {policyField}` |\n\nUsage limits\n------------\n\nThis API is only for use internally within a Chrome customer's organization. For more details, review the [Chrome Policy API Terms of Service](http://console.cloud.google.com/tos?id=chrome-policy). To build a commercial API client in partnership with Google, submit a [partner application](https://docs.google.com/forms/d/e/1FAIpQLSdJA-2_BZ3FJLSBtuWkPCMPXqUpxGbCta1wXRrrVdUCX7apog/viewform).\n\nNext steps\n----------\n\n- [Learn about policy schemas](./policy-schemas)\n- [Set up and authorize requests](./setup)\n- [Review code samples](./samples)"]]
