AI-generated Key Takeaways
-
The Chrome Management Profiles API enables administrators to view, retrieve, and delete data associated with managed profiles on Chrome browsers.
-
Admins need specific privileges like "Services -> Chrome Management -> Settings -> Managed Browsers" to access and manage profiles through the API.
-
API methods include listing profiles, retrieving a specific profile, and deleting a profile's collected data, each with corresponding HTTP methods and relative URLs.
-
Proper OAuth scopes, such as
https://www.googleapis.com/auth/chrome.management.profiles, are necessary for authentication and authorization when using the API.
The Chrome Management Profiles API allows administrators to view data and manage remote commands of managed profiles on Chrome browsers. This set of APIs can be used to list the managed profiles, retrieve a managed profile, delete the data collected from managed profile, issue a remote command to a managed profile, retrieve a remote command issued to a managed profile, and list remote commands issued to a managed profile.
Quick overview of API methods
URLs are relative to
https://chromemanagement.googleapis.com/v1/customers/{customer_id}
| Description | Relative URL | Http method |
|---|---|---|
| List the managed profiles | /profiles | GET |
| Retrieve a managed profile | /profiles/{profile_permanent_id} | GET |
| Delete the data collected from a managed profile | /profiles/{profile_permanent_id} | DELETE |
URLs are relative to
https://chromemanagement.googleapis.com/v1/customers/{customer_id}/profiles/{profile_permanent_id}
| Description | Relative URL | Http method |
|---|---|---|
| Issue a remote command | /commands | POST |
| Retrieve a remote command | /commands/{command_id} | GET |
| List remote commands | /commands | GET |
See code samples for example requests and responses.
Admin Privileges
Profiles API respects administrator role delegation.
| Method | Admin privileges required |
|---|---|
| ListChromeBrowserProfiles | "Services -> Chrome Management -> Settings -> Managed Browsers" or "Services -> Chrome Management -> Settings -> Managed Browsers -> Read" |
| GetChromeBrowserProfile | "Services -> Chrome Management -> Settings -> Managed Browsers" or "Services -> Chrome Management -> Settings -> Managed Browsers -> Read" |
| DeleteChromeBrowserProfile | "Services -> Chrome Management -> Settings -> Managed Browsers" |
| CreateChromeBrowserProfileCommand | "Services -> Chrome Management -> Settings -> Managed Browsers" |
| GetChromeBrowserProfileCommand | "Services -> Chrome Management -> Settings -> Managed Browsers" or "Services -> Chrome Management -> Settings -> Managed Browsers -> Read" |
| ListChromeBrowserProfileCommands | "Services -> Chrome Management -> Settings -> Managed Browsers" or "Services -> Chrome Management -> Settings -> Managed Browsers -> Read" |
To manage administrator roles and privileges visit "Admin Console -> Admin Roles".
API scopes
Chrome Management Profiles API requires the following OAuth scopes:
| Method | OAuth scopes required |
|---|---|
| ListChromeBrowserProfiles | https://www.googleapis.com/auth/chrome.management.profiles or https://www.googleapis.com/auth/chrome.management.profiles.readonly |
| GetChromeBrowserProfile | https://www.googleapis.com/auth/chrome.management.profiles or https://www.googleapis.com/auth/chrome.management.profiles.readonly |
| DeleteChromeBrowserProfile | https://www.googleapis.com/auth/chrome.management.profiles |
| CreateChromeBrowserProfileCommand | https://www.googleapis.com/auth/chrome.management.profiles |
| GetChromeBrowserProfileCommand | https://www.googleapis.com/auth/chrome.management.profiles or https://www.googleapis.com/auth/chrome.management.profiles.readonly |
| ListChromeBrowserProfileCommands | https://www.googleapis.com/auth/chrome.management.profiles or https://www.googleapis.com/auth/chrome.management.profiles.readonly |
For more information, see the Authentication Overview.