Как использовать Chrome Browser Enrollment Token API

Авторизация

Действия, необходимые для получения доступа к Enrollment Token API, описаны в руководстве Chrome Browser Cloud Management'sTakeout API Service Script. Пользователям необходимо выполнить те же действия, чтобы получить токен доступа.

ChromeEnrollmentToken

ChromeEnrollmentToken – это строка, которая позволяет идентифицировать регистрацию браузера Chrome.

Представление ресурса

Ресурс ChromeEnrollmentToken представлен в Directory API следующим шаблоном кода в формате 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"

}

Вызов API

Как получить список всех токенов регистрации для выбранного аккаунта

Чтобы получить список всех токенов регистрации Chrome для отдельного аккаунта в конкретном организационном подразделении, используйте приведенный ниже GET-запрос, добавив в него токен доступа, полученный согласно инструкциям из раздела "Авторизация".

Примечание. Для удобства восприятия пример кода разделен на строки с помощью переносов.

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}

customerId – это уникальный идентификатор клиентского аккаунта Google.
Как администратор аккаунта, вы также можете использовать строку my_customer, которая представляет собой customerId вашего аккаунта. Также значение customerId можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора.

В приведенной ниже таблице представлены все значимые параметры, которые можно использовать в таком запросе.

Параметр	Обязательный	Тип	Описание
orgUnitPath	нет	строка	Выводит список токенов регистрации, созданных в конкретном организационном подразделении. Если поле не заполнено, выводятся все токены регистрации этого клиента.
pageSize	нет	целое число	Максимальное число результатов на странице. Значение не должно превышать 100 (задано по умолчанию).
pageToken	нет	строка	Для перехода к следующей странице результатов запроса используется параметр pageToken. Значение параметра pageToken в последующем запросе соответствует значению nextPageToken в данных, полученных в ответ на предыдущий запрос. Примечание. В запросах с полем page_token значения полей query и org_unit_path должны соответствовать значениям этих полей в запросе, который использовался для генерации значения в page_token.
query	нет	строка	Строка поиска, позволяющая фильтровать полученный список токенов. Формат языка запросов для фильтрации списка результатов описан ниже, в разделе "Язык запросов фильтрации данных".

Пример

Пример запроса

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

Ответ JSON

При успешном выполнении запроса будет получен код статуса HTTP 200, а вместе с ним – свойства токена регистрации 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" }

Язык запросов фильтрации данных

Если при запросе списка используется параметр "query", результаты выполнения запроса будут считаться совпадением, только если для каждого значения в запросе найдено соответствие в одном из указанных ниже параметров. Вы можете использовать значения полей, чтобы уточнить результат поиска токенов. Если в запросе отсутствуют операторы (поля), в результатах будут представлены все найденные токены регистрации.

Например, если отправить такой запрос:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
будут получены токены регистрации в следующем формате:

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

Чтобы уточнить параметры поиска, можно указать следующие поля:

Поле	Описание
device_type	Тип устройств, для которых используются токены регистрации. В настоящее время поддерживается только значение CHROME_BROWSER.
token_state	Состояние токена регистрации. Поддерживаемые значения: REVOKED, ACTIVE, EXPIRED.

Как создать токен регистрации

Чтобы создать в организационном подразделении токен регистрации Chrome, используйте приведенный ниже запрос POST, добавив в него токен доступа, полученный согласно инструкциям из раздела "Авторизация".

Примечание. Для удобства восприятия пример кода разделен на строки с помощью переносов.

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

customerId – это уникальный идентификатор клиентского аккаунта Google.
Как администратор аккаунта, вы также можете использовать строку my_customer, которая представляет собой customerId вашего аккаунта. Также значение customerId можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора.

В приведенной ниже таблице представлены все значимые параметры, которые можно использовать в таком запросе.

Параметр	Обязательный	Тип	Описание
expire_time	нет	строка	Срок действия созданного токена регистрации. Используйте следующий формат: гггг-ММ-ддTчч:мм:ссZ. Если значение в этом поле не задано, токен регистрации действует, пока не будет отозван пользователем.
org_unit_path	нет	строка	Организационное подразделение, для которого создается токен регистрации. Если значение в этом поле не задано, токен регистрации создается для корневого организационного подразделения.
token_type	да	строка	Тип устройства Chrome, для которого создается токен регистрации. В настоящее время поддерживается только значение "CHROME_BROWSER".
ttl	нет	строка	Период действия созданного токена регистрации: указывается в секундах с суффиксом "s". Например, если токен должен действовать в течение 1 часа, в поле указывается значение "3600s". Если значение в этом поле не задано, токен регистрации действует, пока не будет отозван пользователем.

Пример

Пример запроса

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

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

Как отозвать токен регистрации

Чтобы отозвать токен регистрации, используйте приведенный ниже запрос POST, добавив в него токен доступа, полученный согласно инструкциям из раздела "Авторизация".

Примечание. Для удобства восприятия пример кода разделен на строки с помощью переносов.

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

customerId – это уникальный идентификатор клиентского аккаунта Google.
Как администратор аккаунта, вы также можете использовать строку my_customer, которая представляет собой customerId вашего аккаунта. Также значение customerId можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора.
tokenPermanentId – это уникальный идентификатор токена регистрации, который находится в поле tokenPermanentId результатов, которые возвращаются по запросам "List" и "Create".

Пример

Пример запроса

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

Ответ JSON

При успешном выполнении запроса будет получен код статуса HTTP 200.

Эта информация оказалась полезной?

Как можно улучшить эту статью?