Yetkilendirme
Enrollment Token API'ye erişmek için gerekli yetkilendirme Chrome Enterprise Core's Takeout API Service Script kılavuzunda ayrıntılı olarak açıklanmıştır. Bir erişim jetonu almak için kullanıcıların oradan da aynı adımları uygulaması gerekir.
ChromeEnrollmentToken
ChromeEnrollmentToken, Chrome Tarayıcı'nın kaydını tanımlamak için kullanılan bir dizedir.
Kaynak Temsili
Directory API'de ChromeEnrollmentToken kaynağı için aşağıdaki JSON şablonu kullanılır:
{
"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'yi çağırma
Bir hesaba ilişkin tüm kayıt jetonlarını listeleme
Bir kuruluş birimindeki hesabın tüm Chrome kayıt jetonlarını listelemek için aşağıdaki GET isteğini kullanın ve aşağıdaki "Yetkilendirme" bölümünden alınan erişim jetonunu dahil edin.
Not: Okunabilirliği artırmak açısından bu kod örneğine satır sonları eklenmiştir.
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, müşterinin Google hesabının benzersiz bir tanımlayıcısıdır.
- Bir hesap yöneticisinin kimliğine büründüğünüzde, hesabınızın müşteri kimliğini temsil eden my_customer dizesini de kullanabilirsiniz. customerId değerini almanın bir diğer yolu da Kullanıcı alma işlemini kullanmaktır. İşlemin userKey yolu parametresinde yönetici e-posta adresinizi veya yöneticinizin benzersiz kullanıcı kimliği değerini kullanın.
Aşağıda, istekte kullanılabilecek tüm yük parametreleri belirtilmiştir:
Parametre | Zorunlu | Tür | Açıklama |
---|---|---|---|
orgUnitPath | isteğe bağlı | dize | Yalnızca belirli bir kuruluş biriminde oluşturulan kayıt jetonlarını listeler. Bu alan belirtilmezse bu müşterinin tüm kayıt jetonları listelenir. |
pageSize | isteğe bağlı | tam sayı | Döndürülecek maksimum sonuç sayısı. Maksimum ve varsayılan değer 100'dür. |
pageToken | isteğe bağlı | dize | pageToken sorgu parametresi, sorgu sonuçlarının bir sonraki sayfasını istemek için kullanılır. Takip eden isteğin pageToken sorgu parametresi, önceki yanıtınızdaki nextPageToken parametresidir. Not: page_token alanına sahip istekler, page_token öğesini oluşturan istekle aynı sorguyu ve org_unit_path alan değerini içermelidir. |
query | isteğe bağlı | dize | Listelenen jetonları filtrelemek için kullanılan arama dizesi. Liste sayfası sorgu dilinin biçimi aşağıdaki bölümde (Filtre Sorgusu Dili) açıklanmıştır. |
Örnek
Bir istek örneği
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath=”/Org-unit-path”
JSON yanıtı
Başarılı bir istek HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte Chrome Kayıt Jetonu özelliklerini döndürür:
{
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"
}
Filtre Sorgu Dili
Bir liste isteğinde "query" parametresini kullandığınızda isteğin eşleşme olarak değerlendirilmesi için sorgudaki her terimin aşağıdaki parametrelerden biriyle eşleşmesi gerekir. Döndürülen jetonların, terimdeki alan değeriyle eşleşecek şekilde daraltılmasını seçebilirsiniz. Sorguda operatör (alan) belirtmezseniz arama tüm kayıt jetonlarını bulur.
Örneğin,
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED"
,
sorgusu, aşağıdakiler gibi kayıt jetonları döndürecektir:
{
"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",
}
Aramanızı belirli bir alana odaklamak için aşağıdaki alanları belirtebilirsiniz:
Alan | Açıklama |
---|---|
device_type | Kayıt jetonlarının kullanıldığı cihaz türü. Şu an yalnızca CHROME_BROWSER desteklenmektedir. |
token_state | Kayıt jetonunun durumu. Desteklenen değerler: REVOKED, ACTIVE, EXPIRED. |
Kayıt jetonu oluşturma
Bir kuruluş biriminde Chrome kayıt jetonu oluşturmak için aşağıdaki POST isteğini kullanın ve aşağıdaki "Yetkilendirme" bölümünden alınan erişim jetonunu dahil edin.
Not: Okunabilirliği artırmak açısından bu kod örneğine satır sonları eklenmiştir.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens
- customerId, müşterinin Google hesabının benzersiz bir tanımlayıcısıdır.
- Bir hesap yöneticisinin kimliğine büründüğünüzde, hesabınızın müşteri kimliğini temsil eden my_customer dizesini de kullanabilirsiniz. customerId değerini almanın bir diğer yolu da Kullanıcı alma işlemini kullanmaktır. İşlemin userKey yolu parametresinde yönetici e-posta adresinizi veya yöneticinizin benzersiz kullanıcı kimliği değerini kullanın.
Aşağıda, istekte kullanılabilecek tüm yük parametreleri belirtilmiştir:
Parametre | Zorunlu | Tür | Açıklama |
---|---|---|---|
expire_time | isteğe bağlı | dize | Oluşturulan kayıt jetonunun geçerlilik süresi, "yyyy-AA-ggTss:dd:ssZ" biçimindedir. Bu alan belirtilmezse kullanıcılar iptal edene kadar kayıt jetonu kullanılır. |
org_unit_path | isteğe bağlı | dize | Kayıt jetonu oluşturulacak kuruluş birimi. Bu alan belirtilmezse kök kuruluş birimi için kayıt jetonu oluşturulur. |
token_type | zorunlu | dize | Kayıt jetonunun oluşturulacağı Chrome cihazın türü. Şu an yalnızca "CHROME_BROWSER" desteklenmektedir. |
ttl | isteğe bağlı | dize | "s" son eki ile saniye cinsinden kodlanmış, oluşturulan kayıt jetonunun kullanım süresi. Örneğin, bir jetonun 1 saat kullanılabilmesi için bu alan "3600s" olarak ayarlanmalıdır. Bu alan belirtilmezse kullanıcılar iptal edene kadar kayıt jetonu kullanılır. |
Örnek
Bir istek örneği
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 yanıtı
Başarılı bir istek HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte Chrome Kayıt Jetonu özelliklerini döndürür:
{
"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",
}
Kayıt jetonunu iptal etme
Bir kayıt jetonunu iptal etmek için aşağıdaki POST isteğini kullanın ve aşağıdaki "Yetkilendirme" bölümünden alınan erişim jetonunu dahil edin.
Not: Okunabilirliği artırmak açısından bu kod örneğine satır sonları eklenmiştir.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke
- customerId, müşterinin Google hesabının benzersiz bir tanımlayıcısıdır.
- Bir hesap yöneticisinin kimliğine büründüğünüzde, hesabınızın müşteri kimliğini temsil eden my_customer dizesini de kullanabilirsiniz. customerId değerini almanın bir diğer yolu da Kullanıcı alma işlemini kullanmaktır. İşlemin userKey yolu parametresinde yönetici e-posta adresinizi veya yöneticinizin benzersiz kullanıcı kimliği değerini kullanın.
- tokenPermanentId, kayıt jetonunun benzersiz tanımlayıcısıdır ve "List" veya "Create" yanıtlarındaki "tokenPermanentId" alanında yer alır.
Örnek
Bir istek örneği
POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke
JSON yanıtı
Başarılı bir istek HTTP 200 durum kodu döndürür.