Présentation de l'API Chrome Policy
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
L'API Chrome Policy est une suite de services qui permet aux administrateurs Chrome d'afficher et de gérer de manière automatisée les règles Chrome attribuées aux unités organisationnelles de leur organisation. Cette API permet aux administrateurs Chrome d'obtenir des informations sur l'utilisation des appareils ChromeOS et des navigateurs Chrome dans leur organisation.
Principaux avantages
Compatibilité avec la console d'administration Google:les modifications que vous apportez avec l'API sont répercutées dans l'interface utilisateur de la console d'administration Google, et inversement.
Journaux d'audit:les modifications apportées avec cette API sont consignées dans les journaux d'audit d'administration standards.
Approche basée sur les données:les règles Chrome sont représentées par des données et ne sont pas directement référencées par l'interface API. Cela vous permet d'automatiser la consommation des futures règles Chrome par les clients API, sans développement supplémentaire. Au fil du temps, le nombre de règles compatibles avec l'API augmentera.
Complète l'API du SDK Admin:cette API complète l'API du SDK Admin, qui permet aux administrateurs Chrome d'effectuer les tâches suivantes:
Cas d'utilisation courants
Le tableau ci-dessous liste les principales tâches que vous pouvez effectuer avec cette API. Pour consulter des exemples de requêtes et de réponses, consultez Exemples de code.
Les URL sont relatives à https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER
.
Description de la tâche |
URL relative |
Méthode HTTP |
Paramètres de requête |
Répertorier les schémas de règle |
./policySchemas |
GET |
Facultatif:filter , pageSize , pageToken |
Obtenir un schéma de règle |
./policySchemas/$SCHEMA_NAME |
GET |
|
Obtenir ou répertorier des règles pour une unité organisationnelle ou un groupe |
./policies:resolve |
POST |
Obligatoire:policySchemaFilter , policyTargetKey
Facultatifs:pageSize , pageToken
|
Modifier les règles d'une unité organisationnelle |
./policies/orgunits:batchModify |
POST |
Obligatoire: requests: {policyTargetKey, policyValue, updateMask} |
Hériter des règles d'une unité organisationnelle |
./policies/orgunits:batchInherit |
POST |
Obligatoire: requests: {policyTargetKey, policySchema} |
Modifier les règles d'un groupe |
./policies/groups:batchModify |
POST |
Obligatoire: requests: {policyTargetKey, policyValue, updateMask} |
Supprimer des règles dans un groupe |
./policies/groups:batchDelete |
POST |
Obligatoire: requests: {policyTargetKey, policySchema} |
Répertorier l'ordre de priorité d'un groupe |
./policies/groups:listGroupPriorityOrdering |
POST |
Obligatoire: requests: {policyTargetKey, policyNamespace} |
Mettre à jour l'ordre de priorité d'un groupe |
./policies/groups:updateGroupPriorityOrdering |
POST |
Obligatoire: requests: {policyTargetKey, policyNamespace, groupIds} |
Importer des fichiers pour une règle |
./policies/files:uploadPolicyFile |
POST |
Obligatoire: requests: {policyField} |
Limites d'utilisation
Cette API est réservée à une utilisation interne au sein de l'organisation d'un client Chrome. Pour en savoir plus, consultez les Conditions d'utilisation de l'API Chrome Policy. Pour créer un client API commercial en partenariat avec Google, envoyez une demande de partenariat.
Étapes suivantes
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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)"]]