Onderwerpen
Autorisatie
Voordat je alle Cloud Management API's voor de Chrome-browser gebruikt, moet je de Admin SDK API aanzetten (als dit nog niet is gebeurd) in de Google Developer Console. Klik hiervoor op deze link en selecteer het project waarvoor je de API wilt aanzetten.
Daarna heb je 2 opties om een token te krijgen voor toegang tot de API:
- OAuth2.0 met nabootsing van identiteit met een serviceaccount (lees het gedeelte 'Autoriseren met nabootsing van identiteit')
- Driezijdige Oauth2.0 zonder nabootsing van identiteit (je kunt je verzoeken autoriseren op basis van de Oauth2-richtlijn)
De volgende bereiken zijn nodig om je toegang tot de Could Management API voor Chrome-browsers te autoriseren:
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly
of
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers
Autoriseren met nabootsing van identiteit
Als je een serviceaccount voor nabootsing van identiteit wilt gebruiken, moet je het volgende doen:
- Maak een serviceaccount en gebruik de vereiste serviceaccountsleutels voor dit serviceaccount. Volg hier hoe je een serviceaccount maakt en de serviceaccountsleutels ophaalt.
- De client-ID voor dit serviceaccount moet worden geautoriseerd voor de hierboven vermelde OAuth-bereiken. Hiervoor ga je naar de Beheerdersconsole onder Beveiliging -> API-functies -> Domeinbrede machtiging beheren. Vervolgens voeg je een nieuwe client toe.In dit dialoogvenster komt de client-ID overeen met de unieke ID van je serviceaccount.
Met de serviceaccountsleutels moet je de Google API-clientbibliotheken van je voorkeurstaal gebruiken om een OAuth-toegangstoken aan te vragen voor je serviceaccount.
Daarnaast moet het OAuth-tokenverzoek ook een beheerder van je domein nabootsen wanneer je de OAuth-token aanvraagt.
Hier zie je een voorbeeld van een code die de Java API-clientbibliotheken gebruikt om de OAuth-token op te halen.
package takeout.api.credentials;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
public final class ApiRequestHelper {
public static String getAccessToken(
String serviceAccountKeyFilePath, String adminUserToImpersonate, Collection<String> scopes)
throws IOException {
InputStream is = new FileInputStream(serviceAccountKeyFilePath);
GoogleCredential credential =
GoogleCredential.fromStream(is).toBuilder()
.setServiceAccountScopes(scopes)
.setServiceAccountUser(adminUserToImpersonate)
.build();
if (!credential.refreshToken()) {
throw new RuntimeException(
String.format(
"Failed to fetch refresh token for service account defined in '%s' for user '%s' and"
+ " scopes '%s'",
serviceAccountKeyFilePath, adminUserToImpersonate, String.join(",", scopes)));
}
return credential.getAccessToken();
}
public static void printUsage() {
System.out.println(
"Usage: get_access_token <service account key file> <admin user> [<scope,scope>]");
}
public static void main(String[] args) throws Exception {
if (args.length < 2) {
printUsage();
return;
}
String scopes =
"https://www.googleapis.com/auth/admin.directory.device.chromebrowsers";
if (args.length >= 3) {
scopes = args[2];
}
System.out.println(
getAccessToken(args[0], args[1], new ArrayList<String>(Arrays.asList(scopes.split(",")))));
}
private ApiRequestHelper() {}
}
Met deze voorbeeldcode kun je een toegangstoken ophalen die je kunt gebruiken om de API aan te roepen. Als het sleutelbestand bijvoorbeeld is opgeslagen in /home/private_key.json en het beheerdersaccount dat je wilt gebruiken om het verzoek in te dienen is beheerder@domein.com, moet je het volgende uitvoerbaar bestand uitvoeren met de volgende argumenten:
ApiRequestHelper
/home/private_key.json beheerder@domein.com
Opmerking: Het gebruikte e-mailadres voor beheerders is niet het e-mailadres van je serviceaccount (in de vorm <projectnaam>-<id>@<projectnaam>.iam.gserviceaccount.com).
Chrome-browser
Chrome-browsers die zijn ingeschreven voor Cloudbeheer voor de Chrome-browser.
Resourceweergave
De volgende json-template wordt gebruikt voor Chrome-browserresources in de Directory API:
{
"kind": "admin#directory#browserdevice",
"deviceId": tekenreeks,
"osPlatform": tekenreeks,
"osPlatformVersion": tekenreeks,
"osArchitecture":tekenreeks,
"osVersion": tekenreeks,
"machineName": tekenreeks,
"annotatedLocation": tekenreeks,
"annotatedUser": tekenreeks,
"annotatedAssetId": tekenreeks,
"annotatedNotes": tekenreeks,
"lastPolicyFetchTime": dateTime,
"lastRegistrationTime": dateTime,
"lastActivityTime":dateTime,
"lastStatusReportTime":dateTime,
"virtualDeviceId": tekenreeks,
"serialNumber": tekenreeks,
"orgUnitPath": tekenreeks,
"extensionCount":int,
"policyCount": int,
"safeBrowsingClickThroughCount": int,
"lastDeviceUser": tekenreeks,
"browserVersions": [tekenreeks],
"lastDeviceUsers":[
"userName": tekenreeks,
"lastStatusReportTime":dateTime,
]
"machinePolicies": [
"source": tekenreeks,
"name": tekenreeks,
"value": tekenreeks,
"error": tekenreeks,
]
"browsers": [
"browserVersion": tekenreeks,
"channel": tekenreeks,
"lastStatusReportTime": dateTime,
"lastPolicyFetchTime": dateTime,
"executablePath": tekenreeks,
"installedBrowserVersion": tekenreeks,
"plug-ins":[
"name": tekenreeks,
"description": tekenreeks,
"fileame" tekenreeks,
]
"profiles": [
"name": tekenreeks,
"id": tekenreeks,
"lastStatusReportTime": dateTime,
"lastPolicyFectchTime": dateTime,
"SafeBrowsingWarnings": int,
"safeBrowsingWarningsClickThrough": int,
"chromeSignedinUserEmail": tekenreeks,
"extensionPolicies": [
"extensionId": tekenreeks,
"extensionName": tekenreeks,
"policies": [
"source": tekenreeks,
"name": tekenreeks,
"value": tekenreeks,
"error": tekenreeks,
]
]
"extensions": [
"extensionId": tekenreeks,
"version": tekenreeks,
"permissions": [tekenreeks],
"name": tekenreeks,
"description":tekenreeks,
"appType": tekenreeks,
"homepageUrl": tekenreeks,
"installType": tekenreeks,
"configureAppPolicy": tekenreeks,
"disabled": booleaans,
"icons": [
"size": int,
"url": tekenreeks,
]
]
"userPolicies": [
"source": tekenreeks,
"name": tekenreeks,
"value": tekenreeks,
"error": tekenreeks,
]
"safeBrowsingWarningsResetTime": tekenreeks
]
}
De API aanroepen
Alle Chrome-browserapparaten voor een account ophalen
Beperking: de nextPageToken
die door het vermeldingsverzoek wordt geretourneerd, heeft een levensduur van 1 uur. Als je vermeldingsverzoek een groot aantal Chrome-browserapparaten bevat, kan de paginatoken verlopen voordat je alle apparaten kunt vermelden. In dit geval kun je een filter toepassen op het vermeldingsverzoek om het aantal apparaten te verminderen dat door de zoekopdracht wordt geretourneerd. Filteren op OE is vaak een goede manier om het aantal resultaten te verminderen.
Als je een lijst wilt bekijken met alle Chrome-browserapparaten die aan een account zijn toegewezen, gebruik je het volgende GET-verzoek en voeg je de machtiging toe die wordt beschreven in Autorisatie. Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken:
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/
devices/chromebrowsers?projection={FULL|BASIC}&query={query string}&orderBy={orderBy
category}&sortOrder={ASCENDING|DESCENDING}&pageToken={token for next results
page, if applicable &maxResults=max number of results per page}
- De customerId is de unieke ID van het Google-account van de klant.
- Als je de identiteit van een accountbeheerder nabootst, kun je ook de tekenreeks my_customer gebruiken. Deze vertegenwoordigt de customerId van je account. Je kunt de waarde voor customerId ook ophalen met de bewerking Retrieve a user (Een gebruiker ophalen). Gebruik je beheerdersmailadres of de unieke waarde van de gebruikers-ID van de beheerder in de padparameter userKey van de bewerking.
Hieronder volgt een verwijzing naar alle parameters van querytekenreeksen die in het verzoek kunnen worden gebruikt:
Parameter | Type | Beschrijving |
---|---|---|
maxResults | geheel getal | Maximum aantal resultaten dat wordt geretourneerd. De standaard en maximum is 100. |
orderBy | tekenreeks | Chrome-browserapparaateigenschap die wordt gebruikt om resultaten te sorteren. |
Geaccepteerde waarden voor | ||
"id": de ID van het apparaat waarop de Chrome-browser is geïnstalleerd. | ||
"last_sync": de datum en tijd waarop het Chrome-browserapparaat voor het laatst is geregistreerd, voor het laatst is gesynchroniseerd met beleidsinstellingen of een rapport heeft geüpload. | ||
"machine_name": de naam van het apparaat dat aan het apparaat is gekoppeld. | ||
"extension_count": het totale aantal gerapporteerde extensies van Chrome-browsers. | ||
"policy_count": het totale aantal gemelde beleidsregels voor de Chrome-browser. | ||
"os_version": de OS van het apparaat waarop de Chrome-browser is geïnstalleerd. | ||
"last_signed_in_user": de laatst ingelogde gebruiker van de Chrome-browser. | ||
"annotated_user": de gebruiker van het Chrome-browserapparaat zoals geannoteerd door de beheerder. | ||
"annotated_location": de apparaatlocatie van de Chrome-browser zoals geannoteerd door de beheerder. | ||
"annotated_asset_id": de apparaat-ID van de Chrome-browser, zoals geannoteerd door de beheerder. | ||
"notes": opmerkingen over Chrome-browserapparaten zoals geannoteerd door de beheerder. | ||
"browser_version_channel": de laatste Chrome-versie en het laatste door het apparaat gerapporteerde kanaal. | ||
"org_unit": de organisatie-eenheid waarin het apparaat zich bevindt. | ||
"enrollment_date": de inschrijvingsdatum van het apparaat. | ||
"save_browse_click": het aantal Safe Browsing-klikken dat door dit apparaat is gerapporteerd. | ||
"platform_major_version": OS-type en hoofdversie (bijv. Windows 10): | ||
"last_activity": de laatste activiteitstijd voor het apparaat.: | ||
"browser_version_sortable": de oudste browserversie die op het apparaat is geïnstalleerd.: | ||
"os_version_sortable": OS-type en volledige versie: | ||
orgUnitPath | tekenreeks | Het volledige pad van de organisatie-eenheid of de unieke ID ervan. |
groupId | tekenreeks | De volledige bronnaam van de groep in de vorm groups/{group} of de unieke ID. |
pageToken | tekenreeks | De queryparameter pageToken wordt gebruikt om de volgende pagina met zoekresultaten op te vragen. De queryparameter pageToken voor het vervolgverzoek is de nextPageToken uit de vorige reactie. |
projectie | tekenreeks | Informatie beperken die wordt geretourneerd door een reeks geselecteerde velden. |
Geaccepteerde waarden zijn: | ||
"BASIC": bevat alleen de basismetadatavelden (de velden die zijn gevonden in de kolommen van de browserlijst in de Beheerdersconsole zoals hierboven vermeld). | ||
"FULL": bevat alle metadatavelden (zoals hierboven vermeld) | ||
query | tekenreeks | Zoektekenreeks met behulp van de lijsttaal van de querytaal die wordt beschreven in het onderstaande gedeelte (Filter Query Language). |
sortOrder | tekenreeks | Of resultaten worden geretourneerd in oplopende of aflopende volgorde. Moet worden gebruikt met de parameter orderBy. |
Geaccepteerde waarden zijn: | ||
"ASCENDING": oplopende volgorde. | ||
"DESCENDING": aflopende volgorde. |
Voorbeeld: apparaten filteren op apparaatnaam
In dit eerste voorbeeld wordt met query=machine_name:CLIENT2012 gezocht naar een specifieke machinenaam. De reactie bevat één Chrome-browserresource, waarbij de machineName de helpdesk is:
Json-verzoek
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers?projection=BASIC&query=machine_name:CLIENT2012&orderBy=status
&sortOrder=ASCENDING&maxResults=100
JSON-reactie
Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd. Een lijst met browsers die overeenkomen met je queryparameters:
{
"kind": "directory#browserdevices",
"browsers": [
{
"deviceId": "device_id_value",
"kind": "admin#directory#browserdevice",
"osPlatform": "Windows",
"osVersion": "6.3.9600.19505",
"machineName": "CLIENT2012",
"lastRegistrationTime": "2019-11-04T00:29:17.484Z",
"lastActivityTime": "2019-11-04T00:29:17.484Z",
"virtualDeviceId": "virtual_device_id",
"orgUnitPath": "/Org-unit path",
},
],
"nextPageToken": "abcdefghijkl123"
}
Een Chrome-browserapparaat ophalen
Als je de property's van een Chrome-browserapparaat wilt ophalen, gebruik je het volgende GET-verzoek en voeg je de machtiging toe die wordt beschreven in Autorisatieverzoeken. Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken:
GET
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/
devices/chromebrowsers/deviceId?projection={FULL|BASIC}
- De customerId is de unieke ID van het Google-account van de klant.
- Als je de identiteit van een accountbeheerder nabootst, kun je ook de tekenreeks my_customer gebruiken. Deze vertegenwoordigt de customerId van je account. Je kunt de waarde voor customerId ook ophalen met de bewerking Retrieve a user (Een gebruiker ophalen). Gebruik je beheerdersmailadres of de unieke waarde van de gebruikers-ID van de beheerder in de padparameter userKey van de bewerking.
- De apparaat-ID is een unieke ID voor een apparaat en wordt gevonden in de reactie van de bewerking Alle Chrome-browserapparaten ophalen. Bekijk de API-referentie voor de querytekenreeksen, verzoek- en reactie-eigenschappen.
Hieronder volgt een verwijzing naar alle parameters van querytekenreeksen die in het verzoek kunnen worden gebruikt:
Parameter | Type | Beschrijving |
---|---|---|
deviceId | tekenreeks | De unieke ID van het apparaat. De apparaat-ID's (deviceIds) worden geretourneerd in de reactie van de methode browsersdevices.list.Opmerking: Deze parameter is verplicht. |
projectie | tekenreeks | Bepaalt of de reactie de volledige lijst van property's of alleen een subset bevat. |
Geaccepteerde waarden zijn: | ||
"BASIC": bevat alleen de basismetadatavelden (de velden in de lijsten met browsers in de Beheerdersconsole zoals hierboven vermeld). | ||
"FULL": bevat alle metadatavelden (zoals hierboven vermeld). |
Voorbeeld
Json-verzoek
Hier zie je een voorbeeldverzoek Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken:
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers/deviceId?projection=basic
JSON-reactie
Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd. Samen met de statuscode retourneert de reactie de apparaateigenschappen van de Chrome-browser:
{
"deviceId": "device_id_value",
"kind": "admin#directory#browserdevice",
"osPlatform": "Windows",
"osVersion": "6.3.9600.19542",
"machineName": "CLIENT2012",
"lastRegistrationTime": "2019-11-27T12:55:27.230Z",
"lastActivityTime": "2019-11-27T12:55:27.230Z",
"virtualDeviceId": "virtual_device_id",
"orgUnitPath": "/Org-unit path",
"deviceIdentifiersHistory": {
"records": [
{
"identifiers": {
"machineName": "CLIENT2012",
"serialNumber": "ABCD1234567890" },
"firstRecordTime": "2019-11-27T12:55:27.230Z",
"lastActivityTime": "2019-11-27T12:55:27.230Z"}
],
“has_device_id_collision”: “false”
}
}
Filter Query Language
Als je de queryparameter in een lijstverzoek gebruikt, moet elke term in de query overeenkomen met een specifiek browserapparaat om geldig te zijn.Als je geen operatoren (velden) opgeeft in de zoekopdracht, wordt er voor de zoekopdracht een browser gevonden met alle opgegeven termen in alle intern geïndexeerde tekstvelden. Als je zoekopdracht bijvoorbeeld "query=machine 73" is, wordt een browser geretourneerd die zowel de term 'machine' als '73' bevat in alle velden die op een browserapparaat als volgt kunnen worden geretourneerd:
{
"deviceId": "device_id_value",
"kind": "admin#directory#browserdevice",
"osPlatform": "Windows",
"osVersion": "6.3.9600.19542",
"machineName": "machine_name",
"browser_versions": [
"73.0.0.0",
],
"lastActivityTime": "2019-11-27T12:55:27.230Z",
"virtualDeviceId": "virtual_device_id",
"orgUnitPath": "/Org-unit path",
}
Opmerking 1 : Er wordt gezocht naar woordgrenzen (interpunctie of spatie), zodat je geen gedeeltelijke overeenkomsten voor woorden kunt maken. In het bovenstaande voorbeeld zou je geen query kunnen uitvoeren op ='mach 73'.
Opmerking 2: Overeenkomende zoekwoorden zijn niet-hoofdlettergevoelig, dus een zoekopdracht met 'machine' komt overeen met 'Machine' en met 'machine'.
Je kunt de volgende velden specificeren om de zoekopdracht te targeten op specifieke velden (Opmerking: Hoewel de zoektermen niet hoofdlettergevoelig zijn, zijn de veldnamen hoofdlettergevoelig).
Veld | Beschrijving |
---|---|
machine_name | De naam van het apparaat van het Chrome-browserapparaat. |
os_platform | Het OS-platform voor het Chrome-browserapparaat. (bijvoorbeeld Windows) |
arch | De CPU-architectuur voor het Chrome-browserapparaat. (bijvoorbeeld x86_64) |
os_version | De OS-versie van het Chrome-browserapparaat. (bijvoorbeeld 10.0.16299.904) |
locatie | De geannoteerde locatie voor het Chrome-browserapparaat. |
gebruiker | De geannoteerde gebruiker voor het Chrome-browserapparaat. |
asset_id | De geannoteerde item-ID voor het Chrome-browserapparaat. |
note | De geannoteerde notitie voor het Chrome-browserapparaat. |
register | De registratietijd voor het Chrome-browserapparaat. |
os | Het gecombineerde OS-platform en de hoofd-OS-versie voor het Chrome-browserapparaat (bijv. Windows 10) |
browser_version | Een gemelde Chrome-browser die is geïnstalleerd op het Chrome-browserapparaat (bijv. 73) |
enrollment_token | De inschrijftoken die is gebruikt om het Chrome-browserapparaat te registreren. |
report | De laatste rapportagetijd voor het Chrome-browserapparaat |
synchroniseren | De laatste beleidssynchronisatietijd voor het Chrome-browserapparaat. |
num_extensions | Het aantal extensies dat is gerapporteerd door het Chrome-browserapparaat. |
num_policies | Het aantal beleidsregels dat is gemeld door het Chrome-browserapparaat. |
machine_user | De laatst gemelde gebruiker van het Chrome-browserapparaat. |
last_activity | De laatste keer dat Chrome-browseractiviteit activiteit heeft getoond (beleid ophalen of rapporteren). |
has_device_id_collision | De apparaat-ID wordt gedeeld door meerdere apparaten die de Chrome-browser identificeert als hetzelfde apparaat. Ondersteunde waarden zijn true en false . |
Voor velden die tijd accepteren (registreren, rapporteren, synchroniseren, laatste_activiteit), is de tijdnotatie JJJJ-MM-DDTuu:mm:ss (bijv. 2020-01-01T12:00:00). Je kunt ook open of gesloten bereiken weergeven voor deze periode.
Formulier |
Betekenis |
Voorbeelden |
datetime |
precies op de gegeven datum of tijd |
2011-03-23 2011-04-26T14:23:05 |
datetime..datetime |
binnen de gegeven datum- of tijdsinterval (inclusief de gegeven begin- en einddatum) |
2011-03-23..2011-04-26 |
datetime.. |
op of na de gegeven datum of tijd |
2011-04-26T14:23:05.. |
..datetime |
op of voor de gegeven datum of tijd |
..2011-04-26T14:23:05 |
Voorbeelden van filterquery's
Opmerking 1: Alle opgegeven voorbeelden gebruiken de parameter query
in het verzoek. Deze parameterwaarde moet op de juiste manier worden voorafgegaan door een escape in de URL (bijvoorbeeld door ruimtes te escapen met verzoeken met meerdere voorwaarden).
Opmerking 2: Alle query's kunnen verder worden gefilterd naar een bepaalde organisatie-eenheid door de queryparameter orgUnitPath
toe te voegen aan het verzoek.
- Zoek alle apparaten met een machinenaam die een woord bevatten:
machine_name:LIX
- Zoek alle apparaten met een machinenaam die een woord bevatten dat na een bepaalde datum is geregistreerd:
machine_name:LIX register:2011-04-26..
machine_name:LIX-register:..2011-04-26
Momenteel niet-ondersteunde query's:
- Zoek alle apparaten waarop minder dan een bepaald aantal extensies is geïnstalleerd (bereikquery's voor numerieke waarden worden niet ondersteund).
- Zoek alle apparaten die een machinenaam hebben die één van twee mogelijke woorden bevat (met OF in zoekopdrachten).
Een Chrome-browserapparaat updaten
Als je de geannoteerde velden van een Chrome-browserapparaat wilt updaten dat is toegewezen aan een account, gebruik je het volgende PUT-verzoek en neem je de toegangstoken op die je in het gedeelte Autorisatie hebt gekregen.
PUT
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/
devices/chromebrowsers/{deviceId}
- De customerId is de unieke ID van het Google-account van de klant.
- Als je de identiteit van een accountbeheerder nabootst, kun je ook de tekenreeks my_customer gebruiken. Deze vertegenwoordigt de customerId van je account. Je kunt de waarde voor customerId ook ophalen met de bewerking Retrieve a user (Een gebruiker ophalen). Gebruik je beheerdersmailadres of de unieke waarde van de gebruikers-ID van de beheerder in de padparameter userKey van de bewerking.
- De apparaat-ID is een unieke ID voor een apparaat en wordt gevonden in de reactie van de bewerking Alle Chrome-browserapparaten ophalen. Bekijk de API-referentie voor de querytekenreeksen, verzoek- en reactie-eigenschappen.
Hier zie je een overzicht van alle payload-parameters die je kunt gebruiken in het verzoek:
Parameter | Vereist | Type | Beschrijving |
---|---|---|---|
deviceId | vereist | tekenreeks | De unieke ID van het apparaat. De apparaat-ID's (deviceIds) worden geretourneerd in de reactie van de methode browsersdevices.list.Opmerking: Deze parameter is verplicht. |
annotatedUser | optioneel | tekenreeks | De gebruiker van het apparaat zoals geannoteerd door de beheerder. |
annotatedLocation | optioneel | tekenreeks |
Adres of locatie van het apparaat zoals geannoteerde door de beheerder. |
annotatedNotes | optioneel | tekenreeks | Opmerkingen over dit apparaat zoals geannoteerd door de beheerder |
annotatedAssetId | optioneel | tekenreeks |
Item-ID zoals geannoteerd door de beheerder of opgegeven tijdens de inschrijving. |
Voorbeeld
Json-verzoek
Hier zie je een voorbeeldverzoek Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken:
PUT https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers/device_id_value
{
"deviceId": "device_id_value",
"annotatedUser": "user 1"
}
JSON-reactie
Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd. Samen met de statuscode retourneert de reactie de apparaateigenschappen van de Chrome-browser:
{
"deviceId": "device_id_value",
"kind": "admin#directory#browserdevice",
"osPlatform": "Windows",
"osVersion": "6.3.9600.19542",
"machineName": "CLIENT2012",
"lastRegistrationTime": "2019-11-27T12:55:27.230Z",
"lastActivityTime": "2019-11-27T12:55:27.230Z",
"virtualDeviceId": "virtual_device_id",
"orgUnitPath": "/Org-unit path",
"annotatedUser": "user 1"
}
Een Chrome-browserapparaat verwijderen
Als je een Chrome-browserapparaat wilt verwijderen dat aan een account is toegewezen, gebruik je het volgende DELETE-verzoek en voeg je het toegangstoken toe dat in het gedeelte Autorisatie wordt verkregen.
DELETE
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/devices
chromebrowsers/{deviceId}
- De customerId is de unieke ID van het Google-account van de klant.
- Als je de identiteit van een accountbeheerder nabootst, kun je ook de tekenreeks my_customer gebruiken. Deze vertegenwoordigt de customerId van je account. Je kunt de waarde voor customerId ook ophalen met de bewerking Retrieve a user (Een gebruiker ophalen). Gebruik je beheerdersmailadres of de unieke waarde van de gebruikers-ID van de beheerder in de padparameter userKey van de bewerking.
- De apparaat-ID is een unieke ID voor een apparaat en wordt gevonden in de reactie van de bewerking Alle Chrome-apparaten ophalen. Bekijk de API-referentie voor de querytekenreeksen, verzoek- en reactie-eigenschappen.
Voorbeeld
Hier zie je een voorbeeldverzoek
DELETE https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers/device_id_value
JSON-reactie
Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd.
Een Chrome-browserapparaat verplaatsen tussen organisatie-eenheden
Als je Chrome-browserapparaten die aan een account zijn toegewezen wilt verplaatsen van de ene organisatie-eenheid naar de andere, gebruik je het volgende POST-verzoek en voeg je de toegangstoken toe die wordt verkregen door het gedeelte Autorisatie te volgen.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/devices/chromebrowsers/moveChromeBrowsersToOu
- De customerId is de unieke ID van het Google-account van de klant.
- Als je de identiteit van een accountbeheerder nabootst, kun je ook de tekenreeks my_customer gebruiken. Deze vertegenwoordigt de customerId van je account. Je kunt de waarde voor customerId ook ophalen met de bewerking Retrieve a user (Een gebruiker ophalen). Gebruik je beheerdersmailadres of de unieke waarde van de gebruikers-ID van de beheerder in de padparameter userKey van de bewerking.
Hier zie je een overzicht van alle payload-parameters die je kunt gebruiken in het verzoek:
Parameter | Type | Beschrijving |
---|---|---|
resource_ids | Lijst met tekenreeksen |
Lijst met unieke apparaat-ID's van Chrome-browserapparaten die moeten worden verplaatst. Per verzoek kunnen maximaal 600 browsers worden verplaatst. |
org_unit_path | tekenreeks |
Bestemmingsorganisatie-eenheid waarnaar de apparaten moeten worden verplaatst.Volledig pad van de organisatie-eenheid of de bijbehorende ID met het voorvoegsel 'id:' |
Voorbeeld
Hier zie je een voorbeeldverzoek
POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers/moveChromeBrowsersToOu
{
"org_unit_path": "/new-path",
"resource_ids": ["device_id_value_1","device_id_value_2"],
}
JSON-reactie
Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd.