Autoryzacja
Aby używać interfejsu Enrollment Token API, użytkownicy muszą wykonać te same czynności autoryzacji, które są wymagane w przypadku interfejsu Takeout API, i pobrać token dostępu.
Wywoływanie interfejsu API
Wyświetlanie listy wszystkich tokenów rejestracji dla konta
Aby wyświetlić wszystkie tokeny rejestracji Chrome dla konta w jednostce organizacyjnej, użyj poniższego żądania GET i dołącz autoryzację opisaną w artykule „Autoryzowanie żądań”.
Uwaga: przykładowy kod zawiera łamania wierszy, by można go było łatwiej czytać.
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}
- Wartość customerId to unikalny identyfikator konta Google klienta.
- Podczas odgrywania roli administratora konta możesz też użyć ciągu znaków my_customer, który reprezentuje identyfikator klienta (customerId) Twojego konta. Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika administratora w parametrze ścieżki userKey operacji.
Poniżej znajdziesz odnośniki do wszystkich parametrów ładunków, których można użyć w żądaniu:
| Parametr | Wymagany | Typ | Opis |
|---|---|---|---|
| orgUnitPath | opcjonalny | tekst | Wymień tylko tokeny rejestracji utworzone w określonej jednostce organizacyjnej. Jeśli nie określisz wartości tego pola, wymienione będą wszystkie tokeny rejestracji tego klienta. |
| pageSize (rozmiar_strony) | opcjonalny | liczba całkowita | Maksymalna liczba wyników do zwrócenia. Wartość maksymalna i domyślna to 100. |
| pageToken (token_strony) | opcjonalny | tekst | Parametr zapytania pageToken służy do wywołania następnej strony z wynikami zapytania. Parametr zapytania pageToken następnego żądania to parametr nextPageToken z poprzedniej odpowiedzi. Uwaga: żądania z polem page_token muszą mieć takie samo zapytanie i wartość pola org_unit_path (ścieżka_do_jednostki_organizacyjnej), co żądanie, które wygenerowało page_token. |
| query | opcjonalny | tekst | Ciąg tekstowy wyszukiwania pozwalający przefiltrować wyświetlone tokeny. Format zapytań na stronie listy opisano w sekcji poniżej (Język zapytań filtrowania). |
Przykład
Przykładowe żądanie
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath=”/Org-unit-path”
Odpowiedź JSON
Pomyślne żądanie zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też właściwości tokena rejestracji 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"
}
Język zapytań filtrowania
Gdy używasz parametru „query” w żądaniu listy, wszystkie terminy w zapytaniu muszą być dopasowane w jednym z poniższych parametrów, by zostały zaakceptowane. Jeśli w zapytaniu nie określisz żadnych operatorów (pól), wyszukiwanie znajdzie wszystkie tokeny rejestracji.
Jeśli zapytanie to na przykład:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
zwrócone zostaną te tokeny rejestracji:
{
"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",
}
Możesz określić następujące pola, by ukierunkować wyszukiwanie na określone pole:
| Pole | Opis |
|---|---|
| device_type | Typ urządzenia, na którym używane są tokeny rejestracji. Obecnie obsługiwana jest tylko wartość CHROME_BROWSER. |
| token_state | Stan tokena rejestracji. Obsługiwane wartości to: REVOKED (anulowany), ACTIVE (aktywny) i EXPIRED (wygasł). |
Tworzenie tokena rejestracji
Aby utworzyć token rejestracji Chrome w jednostce organizacyjnej, użyj poniższego żądania POST i dołącz autoryzację opisaną w artykule „Autoryzowanie żądań”.
Uwaga: przykładowy kod zawiera łamania wierszy, by można go było łatwiej czytać.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens
- Wartość customerId to unikalny identyfikator konta Google klienta.
- Podczas odgrywania roli administratora konta możesz też użyć ciągu znaków my_customer, który reprezentuje identyfikator klienta (customerId) Twojego konta. Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika administratora w parametrze ścieżki userKey operacji.
Poniżej znajdziesz odnośniki do wszystkich parametrów ładunków, których można użyć w żądaniu:
| Parametr | Wymagany | Typ | Opis |
|---|---|---|---|
| expire_time | opcjonalny | tekst | Czas wygaśnięcia utworzonego tokena rejestracji w formacie „rrrr-mm-ddTgg:mm:ssZ”. Jeśli nie określisz tego pola, token rejestracji będzie obowiązywał do momentu jego unieważnienia przez użytkowników. |
| org_unit_path | opcjonalny | tekst | Jednostka organizacyjna, dla której chcesz utworzyć token rejestracji. Jeśli to pole nie zostanie określone, token rejestracji jest tworzony dla głównej jednostki organizacyjnej. |
| token_type | wymagany | tekst | Typ urządzenia z Chrome, dla którego ma zostać utworzony token rejestracji. Obecnie obsługiwana jest tylko wartość „CHROME_BROWSER”. |
| ttl | opcjonalny | tekst | Czas aktywności utworzonego tokena rejestracji (określony w sekundach), z przyrostkiem „s”. Jeśli np. token ma być aktywny przez godzinę, w tym polu należy ustawić wartość „3600”. Jeśli nie określisz wartości tego pola, token rejestracji będzie aktywny do momentu jego unieważnienia przez użytkowników. |
Przykład
Przykładowe żądanie
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",
}
Odpowiedź JSON
Pomyślne żądanie zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też właściwości tokena rejestracji 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",
}
Unieważnianie tokena rejestracji
Aby unieważnić token rejestracji, użyj tego żądania POST i dołącz autoryzację opisaną w artykule „Autoryzowanie żądań”.
Uwaga: przykładowy kod zawiera łamania wierszy, by można go było łatwiej czytać.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke
- Wartość customerId to unikalny identyfikator konta Google klienta.
- Podczas odgrywania roli administratora konta możesz też użyć ciągu znaków my_customer, który reprezentuje identyfikator klienta (customerId) Twojego konta. Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika administratora w parametrze ścieżki userKey operacji.
- Wartość tokenPermanentId to unikalny identyfikator tokenu rejestracji, który znajduje się w polu „tokenPermanentId” w odpowiedziach „List” (Lista) lub „Create” (Utwórz).
Przykład
Przykładowe żądanie
POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke
Odpowiedź JSON
Pomyślne żądanie zwraca kod stanu HTTP 200.