De Enrollment Token API voor de Chrome-browser gebruiken

Autorisatie

De autorisatie die u nodig heeft voor toegang tot de Enrollment Token API vindt u in de Chrome Browser Cloud Management'sTakeout API Service Script-handleiding. Gebruikers moeten daar dezelfde stappen volgen om een toegangstoken op te halen.

ChromeEnrollmentToken

ChromeEnrollmentToken is een tekenreeks waarmee de inschrijving van een Chrome-browser wordt geïdentificeerd.

Resourceweergave

De volgende json-template wordt gebruikt voor de resource ChromeEnrollmentToken in de Directory API:

{

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

"orgUnitPath": tekenreeks,

"token": tekenreeks,

"tokenPermanentId": tekenreeks,

"customerId": tekenreeks,

"orgUnitPath": tekenreeks,

"state": enum {
"active",

"expired",

"revoked",

}

"expiration": een van {

"expireTime": dateTime,

"ttl": duur

}

"creatorId": tekenreeks,

"creationTime": dateTime,

"revokerId": tekenreeks,

"revokeTime": dateTime,

"tokenType": enum {

"chromeBrowser"

}

De API aanroepen

Alle inschrijftokens van een account weergeven

Als u alle Chrome-inschrijftokens voor een account in een organisatie-eenheid wilt vermelden, gebruikt u het volgende GET-verzoek en voegt u de toegangstoken toe die wordt verkregen door het gedeelte Autorisatie te volgen.

Opmerking: Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken.

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}

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	Vereist	Type	Beschrijving
orgUnitPath	optioneel	tekenreeks	Alleen inschrijftokens weergeven die zijn gemaakt in een specifieke organisatie-eenheid. Als dit veld leeg is, worden alle inschrijftokens van deze klant weergegeven.
pageSize	optioneel	geheel getal	Maximum aantal resultaten dat wordt geretourneerd. De maximum en standaard is 100.
pageToken	optioneel	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. Opmerking: Verzoeken waarvoor het veld page_token is opgegeven, moeten dezelfde query en waarde in het veld org_unit_path hebben als het verzoek waarmee de page_token is gegenereerd.
query	optioneel	tekenreeks	Zoektekenreeks om de opgegeven tokens te filteren. De indeling van querytaal op de lijstpagina staat in het gedeelte hieronder (FilterQueryLanguage).

Voorbeeld

Hier zie je een voorbeeldverzoek

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

JSON-reactie

Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd. Daarnaast worden de property's van de Chrome-inschrijftoken geretourneerd:

{ 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" }

Filter Query Language

Als u de parameter query in een lijstverzoek gebruikt, moet elke term in de query overeenkomen met een van de volgende parameters om te worden gezien als een overeenkomst. U kunt opgeven dat de geretourneerde tokens worden beperkt tot de veldwaarde van de term.Als u geen operators (velden) opgeeft in de zoekopdracht, worden alle inschrijftokens geretourneerd.

Stel dat u de volgende query invoert:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED".
Dan worden er inschrijftokens als deze geretourneerd:

{ "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", }

Je kunt de volgende velden opgeven om een zoekopdracht te richten op een specifiek veld:

Veld	Beschrijving
device_type	Het apparaattype waarvoor de inschrijftokens worden gebruikt. Momenteel wordt alleen CHROME_BROWSER ondersteund.
token_state	De status van een inschrijftoken. Ondersteunde waarden zijn: REVOKED, ACTIVE, EXPIRED.

Een inschrijftoken maken

Als u een Chrome-inschrijftoken wilt maken voor een organisatie-eenheid, gebruikt u het volgende POST-verzoek en voegt u de toegangstoken toe die wordt verkregen door het gedeelte Autorisatie te volgen.

Opmerking: Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken.

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

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	Vereist	Type	Beschrijving
expire_time	optioneel	tekenreeks	De vervaltijd van de gemaakte inschrijftoken, met de indeling jjjj-MM-ddTuu:mm:ssZ. Als dit veld leeg is, blijft de inschrijftoken actief totdat een gebruiker het intrekt.
org_unit_path	optioneel	tekenreeks	De organisatie-eenheid waarvoor je een inschrijftoken wilt maken. Als dit veld leeg is, wordt de inschrijftoken gemaakt voor de organisatie op het hoogste niveau.
token_type	vereist	tekenreeks	Het type Chrome-apparaat waarvoor de inschrijftoken moet worden gemaakt. Momenteel wordt alleen CHROME_BROWSER ondersteund.
ttl	optioneel	tekenreeks	De levensduur van de gemaakte inschrijftoken, in seconden gecodeerd met het achtervoegsel 's'. Bijvoorbeeld: Als je wilt dat een token één uur actief blijft, stel je '3600s' in dit veld in. Als dit veld leeg is, blijft de inschrijftoken actief totdat een gebruiker het intrekt.

Voorbeeld

Hier zie je een voorbeeldverzoek

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-reactie

Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd. Daarnaast worden de property's van de Chrome-inschrijftoken geretourneerd:

{ "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", }

Een inschrijftoken intrekken

Als u een inschrijftoken wilt intrekken, gebruikt u het volgende POST-verzoek en voegt u de toegangstoken toe die wordt verkregen door het gedeelte Autorisatie te volgen.

Opmerking: Dit codevoorbeeld bevat regeleinden om het beter leesbaar te maken.

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

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 tokenPermanentId is een unieke ID van een inschrijftoken. Deze staat in het veld tokenPermanentId in de reacties van een lijst- of maakverzoek.

Voorbeeld

Hier zie je een voorbeeldverzoek

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

JSON-reactie

Als een verzoek is geslaagd, wordt er een HTTP 200-statuscode geretourneerd.

Was dit nuttig?

Hoe kunnen we dit verbeteren?