Themen
Autorisierung
Bevor Sie alle Chrome Enterprise Core APIs verwenden können, müssen Sie die Admin SDK API (falls noch nicht aktiviert) in der Google Developer Console aktivieren. Klicken Sie dazu auf diesen Link und wählen Sie das Projekt aus, für das Sie die API aktivieren möchten.
Sie haben dann zwei Möglichkeiten, ein Token für den Zugriff auf die API zu erhalten:
- OAuth2.0 mit Identitätsübertragung mithilfe eines Dienstkontos (siehe Abschnitt unten „Autorisierung per Identitätsübertragung“)
- Dreibeiniges OAuth2.0 ohne Identitätsübertragung (Sie können Ihre Anfragen gemäß der OAuth2-Richtlinie autorisieren)
Die folgenden Zugriffsbereiche sind erforderlich, um Ihren Zugriff auf die Chrome Enterprise Core API zu autorisieren:
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly
oder
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers
Autorisierung per Identitätsübertragung
Damit Sie ein Dienstkonto für die Identitätsübertragung verwenden können, müssen Sie Folgendes tun:
- Erstellen Sie ein Dienstkonto mit den erforderlichen Dienstkontoschlüsseln für dieses Dienstkonto. Folgen Sie dieser Anleitung, um ein Dienstkonto und die erforderlichen Dienstkontoschlüssel zu erstellen.
- Die Client-ID für dieses Dienstkonto muss für die oben aufgeführten OAuth-Bereiche autorisiert sein. Rufen Sie dazu in der Admin-Konsole Sicherheit -> API-Steuerung -> Domainweite Delegierung verwalten auf. Anschließend fügen Sie einen neuen Client hinzu. In diesem Dialogfeld entspricht die Client-ID der eindeutigen ID Ihres Dienstkontos.
Mit den Dienstkontoschlüsseln müssen Sie die Google API-Clientbibliotheken Ihrer bevorzugten Sprache verwenden, um ein OAuth-Zugriffstoken für Ihr Dienstkonto anzufordern.
Außerdem muss die OAuth-Token-Anfrage bei der Anforderung des OAuth-Tokens die Identität eines Administratornutzers in Ihrer Domain übernehmen.
Im Folgenden finden Sie Beispielcode, in dem das OAuth-Token mithilfe der Java API-Clientbibliotheken abgerufen wird.
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() {}
}
Mit diesem Beispielcode können Sie ein Zugriffstoken abrufen, mit dem Sie die API aufrufen können. Wenn sich Ihre Schlüsseldatei beispielsweise unter /home/private_key.json befindet und das Administratorkonto, mit dem Sie die Anfrage stellen möchten, admin@domain.com lautet, führen Sie das ausführbare Programm mit den folgenden Argumenten aus:
ApiRequestHelper
/home/private_key.json admin@domain.com
Hinweis: Die verwendete E-Mail-Adresse ist nicht die E-Mail-Adresse Ihres Dienstkontos (im Format <Projektname>-<ID>@<Projektname>.iam.gserviceaccount.com).
Chrome-Browser
Chrome-Browser, die für Chrome Enterprise Core registriert sind.
Ressourcenrepräsentation
Die folgende JSON-Vorlage wird für Chrome-Browserressourcen in der Directory API verwendet:
{
"kind": "admin#directory#browserdevice",
"deviceId": string,
"osPlatform": string,
"osPlatformVersion": string,
"osArchitecture":string,
"osVersion": string,
"machineName": string,
"annotatedLocation": string,
"annotatedUser": string,
"annotatedAssetId": string,
"annotatedNotes": string,
"lastPolicyFetchTime": dateTime,
"lastRegistrationTime": dateTime,
"lastActivityTime":dateTime,
"lastStatusReportTime":dateTime,
"virtualDeviceId": string,
"serialNumber": string,
"orgUnitPath": string,
"extensionCount":int,
"policyCount": int,
"safeBrowsingClickThroughCount": int,
"lastDeviceUser": string,
"browserVersions": [string],
"lastDeviceUsers":[
"userName": strin,
"lastStatusReportTime":dateTime,
]
"machinePolicies": [
"source": string,
"name": string,
"value": string,
"error": string,
]
"browsers": [
"browserVersion": string,
"channel": string,
"lastStatusReportTime": dateTime,
"lastPolicyFetchTime": dateTime,
"executablePath": string,
"installedBrowserVersion": string,
"plugins":[
"name": string,
"description": string,
"fileame" string,
]
"profiles": [
"name": string,
"id": string,
"lastStatusReportTime": dateTime,
"lastPolicyFectchTime": dateTime,
"safeBrowsingWarnings": int,
"safeBrowsingWarningsClickThrough": int,
"chromeSignedinUserEmail": string,
"extensionPolicies": [
"extensionId": string,
"extensionName": string,
"policies": [
"source": string,
"name": string,
"value": string,
"error": string,
]
]
"extensions": [
"extensionId": string,
"version": string,
"permissions": [string],
"name": string,
"description":string,
"appType": string,
"homepageUrl": string,
"installType": string,
"configuredAppPolicy": string,
"disabled": boolean,
"icons": [
"size": int,
"url": string,
]
]
"userPolicies": [
"source": string,
"name": string,
"value": string,
"error": string,
]
"safeBrowsingWarningsResetTime": string
]
}
API aufrufen
Alle Chrome-Geräte für ein Konto abrufen
Einschränkung: Die Gültigkeitsdauer des nextPageToken
, das von der Listenanfrage zurückgegeben wird, beträgt eine Stunde. Wenn Ihre Anfrage mehrere Chrome-Geräte umfasst, läuft das Seitentoken möglicherweise ab, bevor Sie alle Geräte auflisten können. In diesem Fall können Sie einen Filter auf Ihre Listenanfrage anwenden, um die Anzahl der Geräte zu reduzieren, die bei der Anfrage zurückgegeben werden. In der Regel ist das Filtern nach OE eine gute Möglichkeit, die Anzahl der Ergebnisse zu reduzieren.
Wenn Sie eine Liste aller Chrome-Geräte zurückgeben möchten, die einem Konto zugewiesen sind, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Autorisierung beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche:
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/
devices/chromebrowsers?projection={FULL|BASIC}&query={Abfragestring}&orderBy={orderBy
category}&sortOrder={ASCENDING|DESCENDING}&pageToken={Token für nächste
Ergebnisseite, falls zutreffend &maxResults=max. Anzahl Ergebnisse pro Seite}
- "customerId" ist die eindeutige Kennung für das Google-Konto des Kunden.
- Wenn Sie sich als Kontoadministrator ausgeben, können Sie auch den String "my_customer" verwenden. Das ist die eindeutige Kennung (customerId) Ihres Kontos. Sie können den Wert "customerId" auch mit der Aktion Retrieve a user (Nutzer abrufen) abrufen. Verwenden Sie für die Aktion im Pfadparameter "userKey" Ihre Administrator-E-Mail-Adresse oder Ihre eindeutige Administrator-Nutzer-ID.
In der folgenden Tabelle finden Sie eine Übersicht über alle Abfragestring-Parameter, die in der Anfrage verwendet werden können:
Parameter | Typ | Beschreibung |
---|---|---|
maxResults | Ganzzahl | Maximale Anzahl der zurückzugebenden Ergebnisse. Höchst- und Standardwert ist 100. |
orderBy | String | Eigenschaft von Chrome-Geräten, die zum Sortieren der Ergebnisse verwendet werden soll. |
Zulässige Werte sind | ||
"id": ID des Geräts, auf dem der Chrome-Browser installiert ist. | ||
"last_sync": Datum und Uhrzeit der letzten Registrierung des Chrome-Geräts, der letzten Synchronisierung mit den Richtlinieneinstellungen oder des Hochladens eines Berichts. | ||
"maschine_name": Der Name der Maschine, die mit dem Gerät verknüpft ist. | ||
"extension_count": Die Gesamtzahl der gemeldeten Erweiterungen des Chrome-Geräts. | ||
"policy_count": Die Gesamtzahl der gemeldeten Richtlinien des Chrome-Geräts. | ||
"os_version": Betriebssystem des Geräts, auf dem der Chrome-Browser installiert ist. | ||
"last_signed_in_user": Letzter Nutzer des Chrome-Geräts. | ||
"annotated_user": Der Nutzer des Chrome-Geräts, wie vom Administrator festgelegt. | ||
"annotated_location": Standort des Chrome-Geräts, wie vom Administrator angegeben. | ||
"annotated_asset_id": Asset-ID des Chrome-Geräts, wie vom Administrator festgelegt. | ||
"notes": Hinweise zum Chrome-Gerät, wie vom Administrator festgelegt. | ||
"browser_version_channel": Die letzte vom Gerät gemeldete Chrome-Version und der letzte Kanal. | ||
"org_unit": Die Organisationseinheit, zu der das Gerät gehört. | ||
"enrollment_date": Das Registrierungsdatum des Geräts. | ||
"save_browsing_clickthrough": Anzahl der Safe Browsing-Klicks, die auf diesem Gerät erfasst wurden. | ||
"platform_major_version": Betriebssystemtyp und Hauptversion (z. B. Windows 10).: | ||
"last_activity": Letzte Aktivität dieses Geräts.: | ||
"browser_version_sortable": Die älteste Browserversion auf dem Gerät.: | ||
"os_version_sortable": Betriebssystemtyp und Vollversion.: | ||
orgUnitPath | String | Der vollständige Pfad der Organisationseinheit oder die eindeutige ID. |
groupId | String | Der vollständige Ressourcenname der Gruppe im Format Gruppen/{Gruppe} oder die eindeutige ID. |
pageToken | String | Der Abfrageparameter "pageToken" wird verwendet, um die nächste Seite mit Abfrageergebnissen anzufordern. Der Abfrageparameter "pageToken" der Folgeanfrage ist der Parameter "nextPageToken" der vorherigen Antwort. |
projection | String | Zurückgegebene Informationen auf eine Reihe von ausgewählten Feldern beschränken. |
Akzeptable Werte sind: | ||
"BASIC": Umfasst nur die grundlegenden Metadatenfelder (d. h. Felder, die in den Spalten der oben aufgeführten Browserliste der Admin-Konsole enthalten sind) | ||
"FULL": Umfasst alle Metadatenfelder (wie oben aufgelistet) | ||
query | String | Suchstring unter Verwendung der Abfragesprache für die Listenseite, die im Abschnitt unten beschrieben wird (Sprache der Filterabfrage). |
sortOrder | String | Ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Muss mit dem Parameter „orderBy“ verwendet werden. |
Akzeptable Werte sind: | ||
"ASCENDING": Aufsteigende Reihenfolge. | ||
"DESCENDING"": Absteigende Reihenfolge. |
Beispiel: Geräte nach Gerätenamen filtern
In diesem ersten Beispiel wird mit „query=machine_name:CLIENT2012“ nach einem bestimmten Computernamen gesucht. Die Antwort enthält eine einzelne Chrome-Ressource mit dem „maschineName“ „help desk“:
JSON-Anfrage
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-Antwort
Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben. Zusammen mit einer Liste von Browser-Geräten, die Ihren Abfrageparametern entsprechen:
{
"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"
}
Chrome-Geräte abrufen
Wenn Sie die Eigenschaften eines Chrome-Geräts abrufen möchten, verwenden Sie die folgende GET-Anfrage zusammen mit der Autorisierung, wie unter „Anfragen autorisieren“ beschrieben. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche:
GET
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/
devices/chromebrowsers/deviceId?projection={FULL|BASIC}
- "customerId" ist die eindeutige Kennung für das Google-Konto des Kunden.
- Wenn Sie sich als Kontoadministrator ausgeben, können Sie auch den String "my_customer" verwenden. Das ist die eindeutige Kennung (customerId) Ihres Kontos. Sie können den Wert "customerId" auch mit der Aktion Retrieve a user (Nutzer abrufen) abrufen. Verwenden Sie für die Aktion im Pfadparameter "userKey" Ihre Administrator-E-Mail-Adresse oder Ihre eindeutige Administrator-Nutzer-ID.
- deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort auf den Vorgang „Alle Chrome-Geräte abrufen“ zurückgegeben. Informationen zu Abfragestrings, Anfrage- und Antworteigenschaften finden Sie in der API-Referenz.
In der folgenden Tabelle finden Sie eine Übersicht über alle Abfragestring-Parameter, die in der Anfrage verwendet werden können:
Parameter | Typ | Beschreibung |
---|---|---|
deviceId | String | Die eindeutige ID des Geräts. deviceIds werden in der Antwort der browserdevices.list-Methode zurückgegeben. Hinweis: Dieser Parameter ist erforderlich. |
projection | String | Legt fest, ob die Antwort die vollständige Liste der Eigenschaften oder nur einen Teil enthält. |
Akzeptable Werte sind: | ||
"BASIC": Umfasst nur die grundlegenden Metadatenfelder (d. h. Felder, die in den Spalten der oben aufgeführten Browserliste der Admin-Konsole enthalten sind) | ||
"FULL": Umfasst alle Metadatenfelder (wie oben aufgelistet) |
Beispiel
JSON-Anfrage
Beispielabfrage. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche:
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers/deviceId?projection=basic
JSON-Antwort
Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Geräteeigenschaften des Chrome-Browsers zurückgegeben:
{
"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”
}
}
Sprache der Filterabfrage
Wenn Sie den Parameter „query“ in einer Listenanfrage verwenden, muss jeder Begriff in der Abfrage in einem bestimmten Browsergerät übereinstimmen, um gültig zu sein. Wenn Sie in der Abfrage keine Operatoren (Felder) angeben, wird bei der Suche ein Browser mit allen angegebenen Begriffen in allen intern indexierten Textfeldern gefunden. Wenn Sie beispielsweise als Abfrage „query=maschine 73“ eingeben, wird ein Browser zurückgegeben, der sowohl den Begriff „machine“ als auch „73“ in allen Feldern enthält, die in einem Browsergerät wie dem folgenden zurückgegeben werden könnten:
{
"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",
}
Hinweis 1: Ein Abgleich erfolgt an Wortgrenzen (Satzzeichen oder Leerzeichen), damit keine teilweise Übereinstimmung mit Wörtern möglich ist. Im Beispiel oben wäre Folgendes nicht möglich: query='mach 73'.
Hinweis 2: Bei der Suche nach „machine“ wird sowohl nach „Machine“ als auch nach „machine“ gesucht, da die Groß-/Kleinschreibung nicht berücksichtigt wird.
Sie können die folgenden Felder angeben, um Ihre Suche auf bestimmte Felder auszurichten. (Hinweis: Auch wenn in den Abfragewörtern die Groß-/Kleinschreibung nicht berücksichtigt wird, muss bei den Feldnamen die Groß-/Kleinschreibung beachtet werden).
Feld | Beschreibung |
---|---|
machine_name | Der Computername des Chrome-Geräts. |
os_platform | Die Betriebssystemplattform des Chrome-Geräts. (z. B. Windows) |
arch | Die CPU-Architektur des Chrome-Geräts. (z. B. x86_64) |
os_version | Die Betriebssystemversion des Chrome-Geräts. (z. B. 10.0.16299.904) |
Standort | Der festgelegte Standort des Chrome-Geräts. |
Nutzer | Der festgelegte Nutzer des Chrome-Geräts. |
asset_id | Die festgelegte Asset-ID des Chrome-Geräts. |
note | Der festgelegte Hinweis des Chrome-Geräts. |
register | Die Registrierungszeit des Chrome-Geräts. |
os | Die Betriebssystemplattform und die Hauptversion des Betriebssystems des Chrome-Geräts (z. B. „Windows 10“). |
browser_version | Ein gemeldeter Chrome-Browser, der auf dem Chrome-Gerät installiert ist (z. B. 73). |
enrollment_token | Das Registrierungstoken, mit dem das Chrome-Gerät registriert wurde. |
report | Der letzte Bericht des Chrome-Geräts. |
synchronisieren | Die letzte Richtliniensynchronisierung des Chrome-Geräts. |
num_extensions | Die Anzahl der vom Chrome-Gerät gemeldeten Erweiterungen. |
num_policies | Die Anzahl der vom Chrome-Gerät gemeldeten Richtlinien. |
machine_user | Der letzte gemeldete Nutzer des Chrome-Geräts. |
last_activity | Die letzte Aktivität des Chrome-Geräts (Richtlinienabruf oder Berichterstellung). |
has_device_id_collision | Die Geräte-ID wird von mehreren Computern gemeinsam genutzt, die der Chrome-Browser als dasselbe Gerät identifiziert. Unterstützte Werte sind true und false . |
Bei Feldern, die Zeitangaben akzeptieren (register, report, sync, last_activity), lautet das Zeitformat YYYY-MM-DDThh:mm:ss (z. B. 2020-01-01T12:00:00). Sie können auch offene oder geschlossene Zeiträume angeben:
Formular |
Bedeutung |
Beispiele |
Datum/Uhrzeit |
exakt das angegebene Datum bzw. die angegebene Uhrzeit |
2011-03-23 2011-04-26T14:23:05 |
datetime..datetime |
innerhalb (inklusive) des angegebenen Datums-/Zeitbereichs |
2011-03-23..2011-04-26 |
datetime.. |
am angegebenen Datum/an der angegebenen Uhrzeit oder danach |
2011-04-26T14:23:05.. |
..datetime |
am angegebenen Datum/an der angegebenen Uhrzeit oder davor |
..2011-04-26T14:23:05 |
Beispielfilterabfragen
Hinweis 1: In allen bereitgestellten Beispielen wird in der Anfrage der Parameter query
verwendet. Parameterwerte müssen in der URL richtig maskiert werden (um Leerzeichen bei Anfragen mit mehreren Bedingungen zu maskieren).
Hinweis 2: Sie können alle Anfragen weiter nach einer bestimmten Organisationseinheit filtern, indem Sie der Anfrage den Abfrageparameter orgUnitPath
hinzufügen.
- Alle Geräte suchen, die einen Computernamen mit einem Wort haben:
machine_name:LIX
- Alle Geräte suchen, die einen Computernamen mit einem Wort haben und nach einem bestimmten Datum registriert wurden:
machine_name:LIX register:2011-04-26..
Alle Geräte suchen, die einen Computernamen mit einem Wort haben und vor einem bestimmten Datum registriert wurden:
machine_name:LIX register:..2011-04-26
Derzeit nicht unterstützte Abfragen:
- Alle Geräte suchen, auf denen eine bestimmte Anzahl von Erweiterungen installiert ist (Bereichsabfragen für numerische Werte werden nicht unterstützt).
- Alle Geräte suchen, auf denen ein Computername mit einem von zwei möglichen Wörtern (mit OR in Suchanfragen) angegeben ist.
Chrome-Browser auf einem Gerät aktualisieren
Wenn Sie annotierte Felder eines Chrome-Geräts aktualisieren möchten, das einem Konto zugewiesen ist, verwenden Sie die folgende PUT-Anfrage zusammen mit dem Zugriffstoken (siehe Abschnitt „Autorisierung“).
PUT
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/
devices/chromebrowsers/{deviceId}
- "customerId" ist die eindeutige Kennung für das Google-Konto des Kunden.
- Wenn Sie sich als Kontoadministrator ausgeben, können Sie auch den String "my_customer" verwenden. Das ist die eindeutige Kennung (customerId) Ihres Kontos. Sie können den Wert "customerId" auch mit der Aktion Retrieve a user (Nutzer abrufen) abrufen. Verwenden Sie für die Aktion im Pfadparameter "userKey" Ihre Administrator-E-Mail-Adresse oder Ihre eindeutige Administrator-Nutzer-ID.
- deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort auf den Vorgang „Alle Chrome-Geräte abrufen“ zurückgegeben. Informationen zu Abfragestrings, Anfrage- und Antworteigenschaften finden Sie in der API-Referenz.
In der folgenden Tabelle finden Sie eine Übersicht über alle Nutzlastparameter, die in der Anfrage verwendet werden können:
Parameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
deviceId | erforderlich | String | Die eindeutige ID des Geräts. deviceIds werden in der Antwort der browserdevices.list-Methode zurückgegeben. Hinweis: Dieser Parameter ist erforderlich. |
annotatedUser | optional | String | Der Nutzer des Geräts, wie vom Administrator angegeben. |
annotatedLocation | optional | String |
Adresse oder Standort des Geräts, wie vom Administrator angegeben. |
annotatedNotes | optional | String | Hinweise zu diesem Gerät, wie vom Administrator angegeben. |
annotatedAssetId | optional | String |
Asset-ID, wie vom Administrator oder bei der Registrierung angegeben. |
Beispiel
JSON-Anfrage
Beispielabfrage. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche:
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-Antwort
Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Geräteeigenschaften des Chrome-Browsers zurückgegeben:
{
"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"
}
Chrome-Geräte löschen
Verwenden Sie zum Löschen von Chrome-Geräten, die mit einem Konto verknüpft sind, die folgende DELETE-Anfrage zusammen mit dem Zugriffstoken (siehe Abschnitt „Autorisierung“).
DELETE
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/devices
chromebrowsers/{deviceId}
- "customerId" ist die eindeutige Kennung für das Google-Konto des Kunden.
- Wenn Sie sich als Kontoadministrator ausgeben, können Sie auch den String "my_customer" verwenden. Das ist die eindeutige Kennung (customerId) Ihres Kontos. Sie können den Wert "customerId" auch mit der Aktion Retrieve a user (Nutzer abrufen) abrufen. Verwenden Sie für die Aktion im Pfadparameter "userKey" Ihre Administrator-E-Mail-Adresse oder Ihre eindeutige Administrator-Nutzer-ID.
- deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort auf den Vorgang „Alle Chrome-Geräte abrufen“ zurückgegeben. Informationen zu Abfragestrings, Anfrage- und Antworteigenschaften finden Sie in der API-Referenz.
Beispiel
Beispielabfrage:
DELETE https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/devices/
chromebrowsers/device_id_value
JSON-Antwort
Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben.
Chrome-Browser-Geräte zwischen Organisationseinheiten verschieben
Wenn Sie Chrome-Geräte, die einem Konto zugewiesen sind, von einer Organisationseinheit in eine andere verschieben möchten, verwenden Sie die folgende POST-Anfrage zusammen mit dem Zugriffstoken (siehe Abschnitt „Autorisierung“).
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/{my_customer|customerId}/devices/chromebrowsers/moveChromeBrowsersToOu
- "customerId" ist die eindeutige Kennung für das Google-Konto des Kunden.
- Wenn Sie sich als Kontoadministrator ausgeben, können Sie auch den String "my_customer" verwenden. Das ist die eindeutige Kennung (customerId) Ihres Kontos. Sie können den Wert "customerId" auch mit der Aktion Retrieve a user (Nutzer abrufen) abrufen. Verwenden Sie für die Aktion im Pfadparameter "userKey" Ihre Administrator-E-Mail-Adresse oder Ihre eindeutige Administrator-Nutzer-ID.
In der folgenden Tabelle finden Sie eine Übersicht über alle Nutzlastparameter, die in der Anfrage verwendet werden können:
Parameter | Typ | Beschreibung |
---|---|---|
resource_ids | Liste mit Strings |
Liste der eindeutigen Geräte-IDs der Chrome-Geräte, die verschoben werden sollen. Pro Anfrage können maximal 600 Browser verschoben werden. |
org_unit_path | String |
Zielorganisationseinheit, in die Geräte verschoben werden sollen. Vollständiger Pfad der Organisationseinheit oder ID mit dem Präfix „id:“ |
Beispiel
Beispielabfrage.
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-Antwort
Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben.