Notificación

Planning your return to office strategy? See how ChromeOS can help.

Usa la API de Enrollment Token para el navegador Chrome

Autorización

La autorización necesaria para acceder a la API de Enrollment Token se detalla en la guía Chrome Browser Cloud Management'sTakeout API Service Script. Los usuarios deben seguir los mismos pasos para recuperar un token de acceso.

ChromeEnrollmentToken

ChromeEnrollmentToken es una cadena que se utiliza para identificar la inscripción de un navegador Chrome.

Representación de recursos

Se usa la siguiente plantilla JSON para el recurso ChromeEnrollmentToken en la API de 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"

  }

}

Llama a la API

Enumera todos los tokens de inscripción de una cuenta

Para enumerar todos los tokens de inscripción de Chrome de una cuenta de una unidad organizativa, usa la siguiente solicitud GET e incluye el token de acceso obtenido a través de la sección “Autorización”.

Nota: Para facilitar la lectura, esta muestra de código tiene saltos de línea.

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 valor customerId es un identificador único de la Cuenta de Google del cliente.
  • Cuando se suplanta la identidad de un administrador de cuenta, también puedes utilizar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa tu dirección de correo electrónico de administrador o el valor de ID de usuario único de administrador en el parámetro de ruta userKey de la operación.

La siguiente es una referencia de todos los parámetros de carga útil que se pueden usar en la solicitud:

Parámetro Obligatorio Tipo Descripción
orgUnitPath opcional string Solo enumera los tokens de inscripción creados en una unidad organizativa específica.  Si no se especifica este campo, se mostrarán todos los tokens de inscripción de este cliente.
pageSize opcional int Cantidad máxima de resultados que se devolverán. La cantidad máxima y predeterminada es 100.
pageToken opcional string El parámetro de consulta pageToken se usa para solicitar la siguiente página de resultados de la búsqueda. El parámetro de consulta pageToken de la solicitud de seguimiento es el nextPageToken de tu respuesta anterior. Nota: Las solicitudes con el campo page_token proporcionado deben tener el mismo valor de campo de query y de org_unit_path que la solicitud que generó el page_token.
consulta opcional string Cadena de búsqueda para filtrar los tokens de la lista. El formato del lenguaje de consulta de la página de lista se describe en la siguiente sección (Filtra el lenguaje de las consultas).

Ejemplo

Una solicitud de ejemplo

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

Respuesta JSON

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

Filtra el lenguaje de las consultas

Cuando se usa el parámetro “query” 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 que se devuelven se restrinjan para que coincidan con el valor del campo del término. Si no especificas operadores (campos) en la consulta, la búsqueda encontrará todos los tokens de inscripción.

Por ejemplo, si tu consulta es:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
se devolverán tokens de inscripción 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 segmentar tu búsqueda a campos específicos:

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

Crea un token de inscripción

Para crear un token de inscripción de Chrome en una unidad organizativa, usa la siguiente solicitud POST y agrega el token de acceso obtenido en la sección “Autorización”.

Nota: Para facilitar la lectura, esta muestra de código tiene saltos de línea.

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

  • El valor customerId es un identificador único de la Cuenta de Google del cliente.
  • Cuando se suplanta la identidad de un administrador de cuenta, también puedes utilizar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa tu dirección de correo electrónico de administrador o el valor de ID de usuario único de administrador en el parámetro de ruta userKey de la operación.

La siguiente es una referencia de todos los parámetros de carga útil que se pueden usar en la solicitud:

Parámetro Obligatorio Tipo Descripción
expire_time opcional string Hora de vencimiento del token de inscripción creado, en formato “yyyy-MM-ddThh:mm:ssZ”. Si no se especifica este campo, el token de inscripción permanecerá  activo hasta que lo revoquen los usuarios.
org_unit_path opcional string La unidad organizativa para la que se creará un token de inscripción. Si no se especifica este campo, se crea el token de inscripción para la unidad organizativa raíz.
token_type necesarios string Tipo de dispositivo Chrome para el que se crea el token de inscripción. Actualmente, solo se admite “CHROME_BROWSER”.
ttl opcional string La vida útil del token de inscripción creado, codificado en segundos, con un sufijo “s”. P. ej., para que un token se publique durante 1 hora, este campo se debe establecer en “3600s”. Si no se especifica este campo, el token de inscripción permanecerá activo hasta que lo revoquen los usuarios.

Ejemplo

Una solicitud de ejemplo

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 JSON

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

Revoca un token de inscripción

Para revocar un token de inscripción, usa la siguiente solicitud POST e incluye el token de acceso obtenido en la sección “Autorización”.

Nota: Para facilitar la lectura, esta muestra de código tiene saltos de línea.

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

  • El valor customerId es un identificador único de la Cuenta de Google del cliente.
  • Cuando se suplanta la identidad de un administrador de cuenta, también puedes utilizar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa tu dirección de correo electrónico de administrador o el valor de ID de usuario único de administrador en el parámetro de ruta userKey de la operación.
  • El tokenPermanentId es un identificador único para un token de inscripción y se encuentra en el campo "tokenPermanentId" en las respuestas de una solicitud “Enumerar” o “Crear”.

Ejemplo

Una solicitud de ejemplo

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

Respuesta JSON

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

¿Te resultó útil esto?

¿Cómo podemos mejorarla?
true
Búsqueda
Borrar búsqueda
Cerrar la búsqueda
Menú principal
6266057122067535347
true
Buscar en el Centro de asistencia
true
true
true
true
true
410864
false
false