Utilizzare l'API Enrollment Token del browser Chrome

Autorizzazione

L'autorizzazione necessaria per accedere all'API Enrollment Token è descritta in dettaglio nella guida Chrome Browser Cloud Management'sTakeout API Service Script. Gli utenti devono seguire gli stessi passaggi per recuperare un token di accesso.

ChromeEnrollmentToken

ChromeEnrollmentToken è una stringa utilizzata per identificare la registrazione di un browser Chrome.

Rappresentazione delle risorse

Per la risorsa ChromeEnrollmentToken, nell'API Directory viene utilizzato il seguente modello JSON:

{

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

}

Chiamare l'API

Elencare tutti i token di registrazione per un account

Per elencare tutti i token di registrazione di Chrome per un account di un'unità organizzativa, utilizza la seguente richiesta GET e includi il token di accesso ottenuto come indicato nella sezione "Autorizzazione".

Nota: per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo.

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}

Il customerid è un identificatore univoco dell'Account Google del cliente.
Quando svolgi il ruolo di amministratore di account, puoi anche utilizzare la stringa my_customer, che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione per richiamare un utente. Utilizza l'indirizzo email dell'amministratore o il valore ID utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.

Di seguito è riportato un riferimento a tutti i parametri del payload che possono essere utilizzati nella richiesta:

Parametro	Obbligatorietà	Tipo	Descrizione
orgUnitPath	facoltativo	stringa	Elenca solo i token di registrazione creati in un'unità organizzativa specifica. Se questo campo non viene specificato, vengono elencati tutti i token di registrazione del cliente.
pageSize	facoltativo	int	Il numero massimo di risultati da restituire. Per impostazione predefinita, il massimo è 100.
pageToken	facoltativo	stringa	Il parametro della query pageToken viene utilizzato per richiedere la pagina successiva dei risultati della query. Il parametro della query pageToken della richiesta successiva è il nextPageToken della tua risposta precedente. Nota: le richieste in cui è stato specificato il campo page_token devono avere lo stesso valore del campo query e org_unit_path della richiesta che ha generato il page_token.
query	facoltativo	stringa	Cerca la stringa per filtrare i token elencati. Il formato del linguaggio della query della pagina elenco è descritto nella sezione FilterQueryLanguage, riportata di seguito.

Esempio

Esempio di richiesta

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

Risposta JSON

Una richiesta riuscita restituisce un codice di stato HTTP 200. Oltre al codice di stato, la risposta restituisce le proprietà del token di registrazione di Chrome:

{ 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

Quando utilizzi il parametro "query" in una richiesta di elenco, ogni termine della query deve corrispondere a uno dei seguenti parametri per far sì che i risultati vengano considerati corrispondenze. Puoi specificare che i token restituiti debbano essere limitati in modo da corrispondere al valore del campo del termine. Se nella query non specifichi operatori (campi), la ricerca troverà tutti i token di registrazione.

Ad esempio, se la tua query è:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
verranno restituiti i token di registrazione come illustrato di seguito:

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

Per restringere la ricerca a un determinato campo, puoi specificare i seguenti campi:

Campo	Descrizione
device_type	Il tipo di dispositivo per il quale vengono utilizzati i token di registrazione. Al momento è supportato solo CHROME_BROWSER.
token_state	Lo stato di un token di registrazione. I valori supportati sono: REVOKED, ACTIVE, EXPIRED.

Creare un token di registrazione

Per creare un token di registrazione di Chrome su un'unità organizzativa, utilizza la seguente richiesta POST e includi il token di accesso ottenuto come indicato nella sezione "Autorizzazione".

Nota: per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo.

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

Il customerid è un identificatore univoco dell'Account Google del cliente.
Quando svolgi il ruolo di amministratore di account, puoi anche utilizzare la stringa my_customer, che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione per richiamare un utente. Utilizza l'indirizzo email dell'amministratore o il valore ID utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.

Di seguito è riportato un riferimento a tutti i parametri del payload che possono essere utilizzati nella richiesta:

Parametro	Obbligatorietà	Tipo	Descrizione
expire_time	facoltativo	stringa	Scadenza del token di registrazione creato, nel formato "yyyy-MM-ddThh:mm:ssZ". Se questo campo non viene specificato, il token di registrazione rimane attivo finché gli utenti non lo revocano.
org_unit_path	facoltativo	stringa	L'unità organizzativa per cui creare un token di registrazione. Se questo campo non viene specificato, il token di registrazione viene creato per l'unità organizzativa principale.
token_type	obbligatorio	stringa	Tipo di dispositivo Chrome per cui creare il token di registrazione. Al momento è supportato solo "CHROME_BROWSER".
ttl	facoltativo	stringa	Durata del token di registrazione creato, codificata in secondi con il suffisso "s". Ad esempio, per pubblicare un token per un'ora, questo campo deve essere impostato su "3600s". Se questo campo non viene specificato, il token di registrazione rimane attivo finché gli utenti non lo revocano.

Esempio

Esempio di richiesta

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

Risposta JSON

Una richiesta riuscita restituisce un codice di stato HTTP 200. Oltre al codice di stato, la risposta restituisce le proprietà del token di registrazione di Chrome:

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

Revocare un token di registrazione

Per revocare un token di registrazione, utilizza la seguente richiesta POST e includi il token di accesso ottenuto come indicato nella sezione "Autorizzazione".

Nota: per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo.

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

Il customerid è un identificatore univoco dell'Account Google del cliente.
Quando svolgi il ruolo di amministratore di account, puoi anche utilizzare la stringa my_customer, che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione per richiamare un utente. Utilizza l'indirizzo email dell'amministratore o il valore ID utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.
Il tokenPermanentId è un identificatore univoco di un token di registrazione e si trova nel campo "tokenPermanentId" nelle risposte di un "Elenco" o di "Crea".

Esempio

Esempio di richiesta

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

Risposta JSON

Una richiesta riuscita restituisce un codice di stato HTTP 200.

È stato utile?

Come possiamo migliorare l'articolo?