Utilizar la API Enrollment Token del navegador Chrome

Autorización

La autorización necesaria para acceder a la API Enrollment Token se indica en la guía Chrome Enterprise Core's Takeout API Service Script. Los usuarios deben seguir los mismos pasos para recuperar un token de acceso.

ChromeEnrollmentToken

ChromeEnrollmentToken es una cadena utilizada para identificar el registro de un navegador Chrome.

Representación de recursos

La siguiente plantilla JSON se utiliza para el recurso ChromeEnrollmentToken de la API Directory:

{

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

}

Llamar a la API

Mostrar todos los tokens de registro de una cuenta

Para mostrar todos los tokens de registro de Chrome de una cuenta de una unidad organizativa, utiliza la siguiente solicitud GET e incluye el token de acceso obtenido tras seguir la sección "Autorización".

Nota: Para facilitar su lectura, el código de ejemplo incluye retornos de carro.

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}

El parámetro customerId es un identificador único de la cuenta de Google del cliente.
En caso de iniciar sesión como administrador de una cuenta, también puedes usar la cadena my_customer que representa el customerId de tu cuenta. Otra manera de obtener el valor de customerId es recuperar un usuario. Usa la dirección de correo electrónico o el valor del ID de usuario único de tu administrador en el parámetro de ruta userKey para hacerlo.

A continuación, se incluye una referencia de todos los parámetros de carga útil que se pueden usar en la solicitud:

Parámetro	Valor	Tipo	Descripción
orgUnitPath	opcional	string	Solo se muestran los tokens de registro creados en una unidad organizativa concreta. Si no se especifica este campo, se mostrarán todos los tokens de registro de ese cliente.
pageSize	opcional	int	Número máximo de resultados que se devolverán. El valor máximo y predeterminado es 100.
pageToken	opcional	string	El parámetro de consulta pageToken se usa para solicitar la siguiente página de resultados de una consulta. El parámetro de consulta pageToken de la solicitud posterior es el parámetro nextPageToken de la respuesta previa. Nota: Las solicitudes donde se proporciona el campo page_token deben tener el mismo valor de campo org_unit_path y query que la solicitud que generó el page_token.
query	opcional	string	Cadena de búsqueda que se usa para filtrar los tokens mostrados. El formato del lenguaje de consultas de la página de lista se describe en un apartado posterior (FilterQueryLanguage).

Ejemplo

Ejemplo de solicitud

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

Respuesta en JSON

Una solicitud correcta devuelve un código de estado HTTP 200. Junto con el código de estado, la respuesta devuelve las propiedades de los tokens de registro de 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" }

Lenguaje de consultas de filtro

Al usar el parámetro de consulta en una solicitud de lista, cada término de la consulta debe coincidir con uno de los siguientes parámetros para que los resultados se consideren una coincidencia. Puedes especificar que los tokens devueltos se reduzcan para que coincidan con el valor del campo del término. Si no especificas ningún operador (campos) en la consulta, la búsqueda localizará todos los tokens de registro.

Por ejemplo, si tu consulta es:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
se devolverán tokens de registro como los siguientes:

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

Puedes especificar los siguientes campos para restringir la búsqueda a un campo en concreto:

Campo	Descripción
device_type	El tipo de dispositivo en el que se utilizan los tokens de registro. Actualmente solo se admite CHROME_BROWSER.
token_state	El estado de un token de registro. Los valores admitidos son REVOKED, ACTIVE y EXPIRED.

Crear un token de registro

Para crear un token de registro de Chrome en una unidad organizativa, utiliza la siguiente solicitud POST e incluye el token de acceso obtenido tras seguir la sección "Autorización".

Nota: Para facilitar su lectura, el código de ejemplo incluye retornos de carro.

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

El parámetro customerId es un identificador único de la cuenta de Google del cliente.
En caso de iniciar sesión como administrador de una cuenta, también puedes usar la cadena my_customer que representa el customerId de tu cuenta. Otra manera de obtener el valor de customerId es recuperar un usuario. Usa la dirección de correo electrónico o el valor del ID de usuario único de tu administrador en el parámetro de ruta userKey para hacerlo.

A continuación, se incluye una referencia de todos los parámetros de carga útil que se pueden usar en la solicitud:

Parámetro	Valor	Tipo	Descripción
expire_time	opcional	string	La hora de vencimiento del token de registro creado, en el formato "aaaa-MM-ddThh:mm:ssZ". Si no se especifica este campo, el token de registro permanecerá activo hasta que los usuarios lo revoquen.
org_unit_path	opcional	string	La unidad organizativa para la que se creará un token de registro. Si no se especifica este campo, el token de registro se creará para la unidad organizativa raíz.
token_type	obligatorio	string	El tipo de dispositivo Chrome para el que se creará el token de registro. Actualmente solo se admite "CHROME_BROWSER".
ttl	opcional	string	La duración del token de registro creado, codificada en segundos con un sufijo "s". Por ejemplo, para que un token dure 1 hora, este campo se debe definir como "3600s". Si no se especifica este campo, el token de registro permanecerá activo hasta que los usuarios lo revoquen.

Ejemplo

Ejemplo de solicitud

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

Respuesta en JSON

Una solicitud correcta devuelve un código de estado HTTP 200. Junto con el código de estado, la respuesta devuelve las propiedades de los tokens de registro de 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", }

Revocar un token de registro

Para revocar un token de registro, utiliza la siguiente solicitud POST e incluye el token de acceso obtenido tras seguir la sección "Autorización".

Nota: Para facilitar su lectura, el código de ejemplo incluye retornos de carro.

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

El parámetro customerId es un identificador único de la cuenta de Google del cliente.
En caso de iniciar sesión como administrador de una cuenta, también puedes usar la cadena my_customer que representa el customerId de tu cuenta. Otra manera de obtener el valor de customerId es recuperar un usuario. Usa la dirección de correo electrónico o el valor del ID de usuario único de tu administrador en el parámetro de ruta userKey para hacerlo.
El parámetro tokenPermanentId es un identificador único de un token de registro y se incluye en el campo "tokenPermanentId" de las respuestas de los parámetros "List" o "Create".

Ejemplo

Ejemplo de solicitud

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

Respuesta en JSON

Una solicitud correcta devuelve un código de estado HTTP 200.

¿Te ha resultado útil esta información?

¿Cómo podemos mejorar esta página?