Menggunakan Chrome Browser Enrollment Token API

Otorisasi

Otorisasi yang diperlukan untuk mengakses Enrollment Token API dijelaskan dalam panduan Chrome Enterprise Core's Takeout API Service Script. Pengguna harus mengikuti langkah-langkah yang sama dari sana untuk mengambil token akses.

ChromeEnrollmentToken

ChromeEnrollmentToken adalah string yang digunakan untuk mengidentifikasi pendaftaran browser chrome.

Representasi Resource

Template JSON berikut digunakan untuk resource ChromeEnrollmentToken di Directory API:

{

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

  }

}

Memanggil API

Mencantumkan semua token pendaftaran untuk akun

Untuk mencantumkan semua token pendaftaran Chrome bagi akun di unit organisasi, gunakan permintaan GET berikut dan sertakan token akses yang diperoleh dengan mengikuti bagian "Otorisasi". 

Catatan: Agar mudah dibaca, contoh kode ini diberi pemisahan baris.

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 adalah ID unik akun Google pelanggan.
• Saat meniru administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Mengambil pengguna. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.

Berikut adalah referensi untuk semua parameter payload yang dapat digunakan dalam permintaan:

Parameter	Wajib	Jenis	Deskripsi
orgUnitPath	opsional	string	Hanya mencantumkan token pendaftaran yang dibuat di unit organisasi tertentu.  Jika kolom ini tidak ditentukan, semua token pendaftaran pelanggan ini akan dicantumkan.
pageSize	opsional	int	Jumlah hasil maksimum dalam satu halaman. Nilai maksimum dan default adalah 100.
pageToken	opsional	string	Parameter kueri pageToken digunakan untuk meminta halaman hasil kueri berikutnya. Parameter kueri pageToken untuk permintaan berikutnya adalah nextPageToken dari respons Anda sebelumnya. Catatan: Permintaan yang memuat kolom page_token harus memiliki kueri dan nilai kolom org_unit_path yang sama dengan permintaan yang menghasilkan page_token.
query	opsional	string	String penelusuran untuk memfilter token yang dicantumkan. Format bahasa kueri halaman daftar dijelaskan di bagian bawah (Filter Bahasa Kueri).

Contoh

Contoh permintaan

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

Respons JSON

Permintaan yang berhasil akan menampilkan kode status HTTP 200. Bersama dengan kode status, respons menampilkan properti Token Pendaftaran 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"
}

Filter Bahasa Kueri

Saat menggunakan parameter "query" dalam permintaan daftar, setiap istilah dalam kueri harus cocok dengan salah satu parameter berikut agar hasilnya dianggap cocok. Anda dapat menentukan bahwa token yang ditampilkan akan dipersempit agar cocok dengan nilai kolom pada istilah. Jika Anda tidak menetapkan operator (kolom) dalam kueri, penelusuran akan menemukan semua token pendaftaran.

Misalnya, jika kueri Anda adalah:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
kueri ini akan menampilkan token pendaftaran seperti berikut:

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

Anda dapat menentukan kolom berikut untuk menargetkan penelusuran Anda ke kolom tertentu:

Kolom	Deskripsi
device_type	Jenis perangkat yang digunakan sebagai token pendaftaran. Saat ini hanya CHROME_BROWSER yang didukung.
token_state	Status token pendaftaran. Nilai yang didukung: REVOKED, ACTIVE, EXPIRED.

Membuat token pendaftaran

Untuk membuat token pendaftaran Chrome di unit organisasi, gunakan permintaan POST berikut dan sertakan token akses yang diperoleh dengan mengikuti penjelasan di bagian "Otorisasi".

Catatan: Agar mudah dibaca, contoh kode ini diberi pemisahan baris.

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

• customerId adalah ID unik akun Google pelanggan.
• Saat meniru administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Mengambil pengguna. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.

Berikut adalah referensi untuk semua parameter payload yang dapat digunakan dalam permintaan:

Parameter	Wajib	Jenis	Deskripsi
expire_time	opsional	string	Masa berlaku token pendaftaran yang dibuat, menggunakan format "yyyy-MM-ddThh:mm:ssZ". Jika kolom ini tidak ditentukan, token pendaftaran akan aktif hingga pengguna mencabutnya.
org_unit_path	opsional	string	Unit organisasi tujuan token pendaftaran dibuat. Jika kolom ini tidak ditentukan, token pendaftaran akan dibuat untuk unit organisasi root.
token_type	wajib	string	Jenis perangkat chrome tujuan token pendaftaran dibuat. Saat ini hanya "CHROME_BROWSER" yang didukung.
ttl	opsional	string	Masa pakai token pendaftaran yang dibuat, dienkode dalam hitungan detik dengan akhiran "s". Misalnya, agar token aktif selama 1 jam, kolom ini harus ditetapkan ke “3600s”. Jika kolom ini tidak ditentukan, token pendaftaran akan berlaku hingga pengguna mencabutnya.

Contoh

Contoh permintaan

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

Respons JSON

Permintaan yang berhasil akan menampilkan kode status HTTP 200. Bersama dengan kode status, respons menampilkan properti Token Pendaftaran 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",
}

Mencabut token pendaftaran

Untuk mencabut token pendaftaran, gunakan permintaan POST berikut dan sertakan token akses yang diperoleh dengan mengikuti penjelasan di bagian "Otorisasi". 

Catatan: Agar mudah dibaca, contoh kode ini diberi pemisahan baris.

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

• customerId adalah ID unik akun Google pelanggan.
• Saat meniru administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Mengambil pengguna. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.
• tokenPermanentId adalah ID unik untuk token pendaftaran, dan ditemukan di kolom "tokenPermanentId" dalam respons terhadap "List" (Cantumkan) atau "Create" (Buat).

Contoh

Contoh permintaan

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

Respons JSON

Permintaan yang berhasil akan menampilkan kode status HTTP 200.