Usar a API Chrome Browser Enrollment Token

Autorização

A autorização necessária para acessar a API Enrollment Token está detalhada no guia Chrome Browser Cloud Management'sTakeout API Service Script. Os usuários precisam seguir as mesmas etapas para recuperar um token de acesso.

ChromeEnrollmentToken

O ChromeEnrollmentToken é uma string usada para identificar o registro de um navegador Chrome.

Representação de recurso

O modelo JSON a seguir é usado no recurso ChromeEnrollmentToken na 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": duração

  }

"creatorId": string,

"creationTime": dateTime,

"revokerId": string,

"revokeTime": dateTime,

"tokenType": enum {

    "chromeBrowser"

  }

}

Chamar a API

Listar todos os tokens de registro para uma conta

Para listar todos os tokens de registro do Chrome de uma conta em uma unidade organizacional, use a seguinte solicitação GET e inclua o token de acesso obtido na seção "Autorização". 

Observação: para facilitar a leitura, esta amostra de código tem retornos de linha.

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}

  • O "customerId" é um identificador exclusivo da Conta do Google do cliente.
  • Ao representar um administrador de conta, você também pode usar a string "my_customer", que representa o "customerId" da sua conta. Também é possível consultar o valor de "customerId" usando a operação Recuperar um usuário. Use seu endereço de e-mail ou código de usuário único de administrador no parâmetro de caminho "userKey" da operação.

Veja a lista de todos os parâmetros de payload que podem ser usados na solicitação:

Parâmetro Obrigatório Tipo Descrição
orgUnitPath opcional string Listar apenas os tokens de registro criados em uma unidade organizacional específica.  Quando este campo não é especificado, todos os tokens de registro do cliente são listados.
pageSize opcional int Número máximo de resultados a serem retornados. O valor mais alto e padrão é 100.
pageToken opcional string O parâmetro de consulta "pageToken" é usado para solicitar a próxima página de resultados. O parâmetro "pageToken" da solicitação subsequente é o "nextPageToken" da resposta anterior. Observação: as solicitações com o campo "page_token" precisam ter o mesmo valor em "query" e em "org_unit_path" que a solicitação que gerou o "page_token".
query opcional string String de pesquisa para filtrar os tokens listados. O formato da linguagem de consulta da página da lista é descrito na seção "Filtrar linguagem de consulta" abaixo.

Exemplo

Exemplo de solicitação:

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

Resposta JSON

Uma solicitação bem-sucedida retorna um código de status HTTP 200. Junto com o código, a resposta retorna as propriedades do token de registro do 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"
}

Filtrar linguagem de consulta

Ao usar o parâmetro "query" em uma solicitação de lista, cada termo da consulta deve corresponder a um dos parâmetros a seguir para que os resultados sejam considerados uma correspondência. Você pode especificar que os tokens retornados sejam limitados para corresponder ao valor do campo no termo. Se você não especificar operadores (campos) na consulta, a pesquisa encontrará todos os tokens de registro.

Por exemplo:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED"
A consulta acima retornará tokens de registro como a seguir:

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

Você pode especificar os seguintes campos para restringir a pesquisa a um campo específico:

Campo Descrição
device_type O tipo de dispositivo para que os tokens de registro são usados. No momento, apenas "CHROME_BROWSER" é compatível.
token_state O estado de um token de registro. Os valores aceitos são "REVOKED", "ACTIVE" e "EXPIRED".

Criar um token de registro

Para criar um token de registro do Chrome em uma unidade organizacional, use a seguinte solicitação POST e inclua o token de acesso obtido na seção "Autorização".

Observação: para facilitar a leitura, esta amostra de código tem retornos de linha.

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

  • O "customerId" é um identificador exclusivo da Conta do Google do cliente.
  • Ao representar um administrador de conta, você também pode usar a string "my_customer", que representa o "customerId" da sua conta. Também é possível consultar o valor de "customerId" usando a operação Recuperar um usuário. Use seu endereço de e-mail ou código de usuário único de administrador no parâmetro de caminho "userKey" da operação.

Veja a lista de todos os parâmetros de payload que podem ser usados na solicitação:

Parâmetro Obrigatório Tipo Descrição
expire_time opcional string Prazo de validade do token de registro criado, no formato "aaaa-MM-ddThh:mm:ssZ". Quando este campo não é especificado, o token de registro é válido até ser revogado pelos usuários.
org_unit_path opcional string A unidade organizacional para a qual será criado um token de registro. Quando este campo não é especificado, o token é criado para a unidade organizacional raiz.
token_type obrigatório string Tipo de dispositivo Chrome para o qual será criado o token de registro. No momento, apenas "CHROME_BROWSER" é compatível.
ttl opcional string Duração do token de registro criado, codificada em segundos com o sufixo "s". Por exemplo, para que o token seja válido por uma hora, defina o campo como "3600s". Quando este campo não é especificado, o token de registro é válido até ser revogado pelos usuários.

Exemplo

Exemplo de solicitação:

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

Resposta JSON

Uma solicitação bem-sucedida retorna um código de status HTTP 200. Junto com o código, a resposta retorna as propriedades do token de registro do 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",
}

Revogar um token de registro

Para revogar um token de registro, use a seguinte solicitação POST e inclua o token de acesso obtido na seção "Autorização". 

Observação: para facilitar a leitura, esta amostra de código tem retornos de linha.

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

  • O "customerId" é um identificador exclusivo da Conta do Google do cliente.
  • Ao representar um administrador de conta, você também pode usar a string "my_customer", que representa o "customerId" da sua conta. Também é possível consultar o valor de "customerId" usando a operação Recuperar um usuário. Use seu endereço de e-mail ou código de usuário único de administrador no parâmetro de caminho "userKey" da operação.
  • O "tokenPermanentId" é um identificador exclusivo de um token de registro, encontrado no campo “tokenPermanentId” das respostas de "List" ou "Create".

Exemplo

Exemplo de solicitação:

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

Resposta JSON

Uma solicitação bem-sucedida retorna um código de status HTTP 200.

Isso foi útil?

Como podemos melhorá-lo?
Pesquisa
Limpar pesquisa
Fechar pesquisa
Google Apps
Menu principal