Chrome Browser Registry Token API verwenden

Autorisierung

Die erforderliche Autorisierung für den Zugriff auf die Enrollment Token API ist im Leitfaden Chrome Enterprise Core's Takeout API Service Script aufgeführt. Nutzer müssen dann dieselben Schritte ausführen, um ein Zugriffstoken abzurufen.

ChromeEnrollmentToken

ChromeEnrollmentToken ist ein String, mit dem die Registrierung eines Chrome-Browsers identifiziert wird.

Ressourcenrepräsentation

Die folgende JSON-Vorlage wird für die ChromeEnrollmentToken-Ressource in der Directory API verwendet:

{

"kind": "admin#directory#chromeEnrollmentToken",

"orgUnitPath": string,

"token": string,

"tokenPermanentId": string,

"customerId": string,

"orgUnitPath": string,

"state": enum {
    "active",

    "expired",

    "revoked",

}

"expiration": oneof {

    "expireTime": dateTime,

    "ttl": duration

  }

"creatorId": string,

"creationTime": dateTime,

"revokerId": string,

"revokeTime": dateTime,

"tokenType": enum {

    "chromeBrowser"

  }

}

API aufrufen

Alle Registrierungstokens für ein Konto auflisten

Wenn Sie alle Chrome-Registrierungstokens für ein Konto in einer Organisationseinheit auflisten möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie das Zugriffstoken ein, das Sie im Abschnitt "Autorisierung" erhalten haben. 

Hinweis: Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche.

GET
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens?query=
{query_string}&pageSize={number_of_results_to_return}
&pageToken={page_token_from_previous_request}&orgUnitPath={/org-unit-path}

• "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	Erforderlich	Typ	Beschreibung
orgUnitPath	optional	String	Es werden nur Registrierungstokens aufgelistet, die für eine bestimmte Organisationseinheit erstellt wurden.  Wenn das Feld nicht angegeben ist, werden alle Registrierungstokens des Kunden aufgelistet.
pageSize	optional	Ganzzahl	Maximale Anzahl der zurückzugebenden Ergebnisse. Höchst- und Standardwert ist 100.
pageToken	optional	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. Hinweis: Anfragen mit dem Feld "page_token" müssen denselben Wert für das Feld "query" und "org_unit_path" haben wie die Anfrage, mit der der Parameter "page_token" generiert wurde.
query	optional	String	Suchstring zum Filtern der aufgelisteten Tokens. Das Format der Abfragesprache der Listenseite wird unten im Abschnitt "Sprache der Filterabfrage" beschrieben.

Beispiel

Beispielabfrage

GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath=”/Org-unit-path”

JSON-Antwort

Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften des Chrome-Registrierungstokens zurückgegeben:

{
  kind: "admin#directory#chromeEnrollmentTokens",
  "chrome_enrollment_tokens": [
    {
      "tokenId": "token_id_value",
      "tokenPermanentId": "token_Permanent_id_value",
      "kind": "admin#directory#chromeEnrollmentToken",
      "orgUnitPath": "/Org-unit-path",
      "state": "active",
      "creator_id": “unique_id_of_user",
      "create_time": "2020-04-30T19:22:44Z",
      "tokenType": "chromeBrowser",
    }
  ],
  "nextPageToken": "abcdefghijkl123"
}

Sprache der Filterabfrage

Wenn Sie in einer Listenanfrage den Parameter "query" verwenden, muss jeder Begriff in der Abfrage mit einem der folgenden Parameter übereinstimmen, damit die Ergebnisse als Übereinstimmung angesehen werden. Sie können angeben, dass die zurückgegebenen Tokens eingegrenzt werden sollen, damit sie mit dem Feldwert des Begriffs übereinstimmen. Wenn Sie in der Abfrage keine Operatoren (Felder) angeben, werden bei der Suche alle Registrierungstokens gefunden.

Beispiel: Ihre Abfrage lautet so:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
Dadurch werden Registrierungstokens wie diese zurückgegeben:

{
  "tokenId": "token_id_value",
  "tokenPermanentId": "token_Permanent_id_value",
  "kind": "admin#directory#chromeEnrollmentToken",
  "orgUnitPath": "/Org-unit-path",
  “tokenState”: “revoked”,
  “creatorId”: “unique_id_of_user”,
  "create_time": "2020-04-30T19:22:44Z",
  "tokenType": "chromeBrowser",
}

Sie können folgende Felder angeben, um Ihre Suche auf ein bestimmtes Feld auszurichten:

Feld	Beschreibung
device_type	Der Gerätetyp, für den die Registrierungstokens verwendet werden. Derzeit wird nur "CHROME_BROWSER" unterstützt.
token_state	Der Status eines Registrierungstokens. Folgende Werte werden unterstützt: "REVOKED" (Widerrufen), "ACTIVE" (Aktiv), "EXPIRED" (Abgelaufen).

Registrierungstoken erstellen

Verwenden Sie zum Erstellen eines Chrome-Registrierungstokens für eine Organisationseinheit die folgende POST-Anfrage und fügen Sie das Zugriffstoken ein, das Sie im Abschnitt „Autorisierung“ erhalten haben.

Hinweis: Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche.

POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens

• "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	Erforderlich	Typ	Beschreibung
expire_time	optional	String	Ablaufzeit des erstellten Registrierungstokens im Format "JJJJ-MM-TTThh:mm:ssZ". Wenn dieses Feld nicht angegeben ist, bleibt das Registrierungstoken gültig, bis Nutzer es widerrufen.
org_unit_path	optional	String	Die Organisationseinheit, für die das Registrierungstoken erstellt werden soll. Wenn das Feld nicht angegeben ist, wird das Registrierungstoken für die Stammorganisationseinheit erstellt.
token_type	erforderlich	String	Der Typ des Chrome-Geräts, für das das Registrierungstoken erstellt werden soll. Derzeit wird nur "CHROME_BROWSER" unterstützt.
ttl	optional	String	Die Gültigkeitsdauer des erstellten Registrierungstokens in Sekunden und mit dem Suffix "s". Wenn ein Token beispielsweise eine Stunde lang gültig sein soll, muss dieses Feld auf "3600s" gesetzt werden. Wenn dieses Feld nicht angegeben ist, bleibt das Registrierungstoken gültig, bis Nutzer es widerrufen.

Beispiel

Beispielabfrage

POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens
{
  "token_type": "CHROME_BROWSER",
  "org_unit_path": "/org-unit-path",
  "expire_time": "2021-04-30T19:22:44Z",
}

JSON-Antwort

Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften des Chrome-Registrierungstokens zurückgegeben:

{
  "tokenId": "token_id_value",
  "tokenPermanentId": "token_Permanent_id_value",
  "kind": "admin#directory#chromeEnrollmentToken",
  "orgUnitPath": "/Org-unit-path",
  "state": "active",
  "creatorId”: "unique_id_of_user",
  "create_time": "2020-04-30T19:22:44Z",
  "expire_time": "2021-04-30T19:22:44Z",
  "tokenType": "chromeBrowser",
}

Registrierungstoken widerrufen

Wenn Sie ein Registrierungstoken widerrufen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie das Zugriffstoken ein, das Sie im Abschnitt „Autorisierung“ erhalten haben. 

Hinweis: Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche.

POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke

• "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.
• Der Wert "tokenPermanentId" ist eine eindeutige Kennung für ein Registrierungstoken und befindet sich im Feld "tokenPermanentId" in den Antworten einer "List"‑ (Auflisten) oder "Create"-Aktion (Erstellen).

Beispiel

Beispielabfrage

POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke

JSON-Antwort

Bei einer erfolgreichen Abfrage wird der Statuscode "HTTP 200" zurückgegeben.