Konfigurasi Jira Cloud

Pratinjau publik: Fitur penelusuran dan tindakan gabungan tersedia dalam pratinjau publik. Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum di Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Halaman ini menjelaskan cara menyiapkan dan mengonfigurasi konfigurasi pihak ketiga sebelum membuat penyimpanan data Jira Cloud.

Menyiapkan autentikasi dan izin

Anda harus menyiapkan autentikasi dan izin di pusat akun administrator Atlassian. Hal ini sangat penting agar konektor dapat mengakses dan menyinkronkan data. Konektor Jira Cloud mendukung berbagai metode autentikasi, seperti kredensial klien OAuth atau token API.

Membuat aplikasi OAuth 2.0

Untuk membuat aplikasi OAuth 2.0 untuk autentikasi, ikuti langkah-langkah berikut untuk menyiapkan aplikasi di Konsol Developer Atlassian dan mendapatkan ID klien serta rahasia klien yang diperlukan.

Memverifikasi akses administrator organisasi Jira

Untuk memverifikasi akses administrator organisasi Jira, lakukan hal berikut:

1. Login ke Atlassian dengan kredensial pengguna Anda.

2. Pilih aplikasi Jira.

3. Klik Setelan.

   Jika Anda melihat opsi Sistem di bagian setelan Jira, Anda memiliki akses administrator organisasi Jira. Atau, minta administrator organisasi Jira Anda untuk memberikan akses.

Membuat aplikasi OAuth 2.0

Untuk membuat aplikasi OAuth 2.0, lakukan hal berikut:

1. Login ke Atlassian Developer Console.

2. Klik ikon profil, lalu pilih Konsol developer.

3. Di halaman Console, klik Create, lalu pilih OAuth 2.0 Integration.

4. Di halaman pembuatan aplikasi, lakukan hal berikut:

   1. Masukkan nama untuk aplikasi.

   2. Centang kotak untuk menyetujui persyaratan developer Atlassian.

   3. Klik Create.

5. Di halaman aplikasi, lakukan hal berikut:

   1. Dari menu navigasi, klik Otorisasi.

   2. Di tabel Authorization type, pilih Add untuk OAuth 2.0 (3LO).

6. Di kolom URL Callback, masukkan https://vertexaisearch.cloud.google.com/console/oauth/jira_oauth.html.

7. Klik Simpan perubahan.

Mendapatkan client ID dan rahasia klien

Untuk mendapatkan client ID dan rahasia klien, lakukan hal berikut:

1. Di halaman aplikasi, dari menu navigasi, klik Distribusi.

2. Di halaman Distribution, lakukan tindakan berikut:

   1. Di bagian Kontrol distribusi, pilih Edit.
   2. Di bagian Status distribusi, pilih Berbagi untuk mengaktifkan pengeditan kolom lainnya.
   3. Masukkan informasi di kolom wajib diisi berikut:
      1. Untuk Vendor, masukkan Google.
      2. Untuk Kebijakan privasi, masukkan https://policies.google.com.
      3. Untuk Apakah aplikasi Anda menyimpan data pribadi?, pilih Ya.
      4. Centang kotak Saya mengonfirmasi bahwa saya telah menerapkan API pelaporan data pribadi. Untuk mengetahui informasi selengkapnya, lihat API pelaporan data pribadi.
   4. Klik Simpan perubahan.

3. Di halaman aplikasi, lakukan hal berikut:

   1. Dari menu navigasi, klik Setelan.
   2. Dari halaman setelan, salin Client ID dan Rahasia klien Anda.

Mendapatkan ID instance dan URL instance

1. Dapatkan ID instance:

   1. Buka tab baru, salin URL instance, dan tambahkan /_edge/tenant_info ke URL instance. Contoh, https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info.
   2. Buka link untuk menemukan nilai cloudId. cloudId adalah ID instance Anda.

2. Dapatkan URL instance:

   1. Buka atlassian.net, lalu login dengan akun administrator Anda.
   2. Pilih aplikasi yang ingin Anda sinkronkan. Misalnya, sinkronkan aplikasi pertama.
   3. Temukan URL instance (subdomain di kolom URL).

Memberikan peran administrator

Untuk memberikan peran Editor Discovery Engine kepada administrator Jira di konsol Google Cloud , lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman Gemini Enterprise.

2. Buka IAM.

   Buka IAM

3. Temukan akun pengguna yang memiliki akses administrator di Jira, lalu klik ikon Edit .

4. Berikan peran Editor Discovery Engine kepada administrator.

Untuk memberikan peran administrator kepada pengguna di Atlassian, lakukan hal berikut:

1. Login ke Atlassian menggunakan akun administrator organisasi.

2. Klik ikon menu, lalu pilih organisasi Anda. Atau, Anda dapat membuka admin.atlassian.com.

3. Di halaman Admin, klik produk, lalu pilih tombol Kelola pengguna.

   

   Mengelola pengguna

4. Klik Grup di bagian Pengelolaan pengguna.

5. Di halaman Grup:

   1. Klik Buat grup.
   2. Masukkan nama untuk grup.

   

   Buat grup

Grup ini menerima izin yang diperlukan oleh konektor. Pengguna yang ditambahkan ke grup ini akan mewarisi izin ini. Konektor menggunakan grup ini untuk mengautentikasi dan mengambil dokumen.

1. Di halaman Grup, klik Tambahkan produk.

2. Pilih Admin akses pengguna sebagai peran untuk Jira.

3. Pilih Admin produk sebagai peran untuk administrasi Jira.

   

   Administrator akses pengguna Jira

4. Klik Grant Access.

5. Klik Tambahkan anggota grup untuk menambahkan akun pengguna atau anggota grup yang digunakan konektor untuk mengautentikasi dan mengakses resource yang diperlukan.

   

   Menambahkan anggota grup

Mengelola visibilitas pengguna

Agar email pengguna dapat dilihat oleh siapa saja di akun Atlassian, lakukan hal berikut:

1. Login ke Atlassian Developer Console.

2. Klik ikon profil, lalu pilih Konsol developer.

3. Klik ikon profil pengguna, lalu pilih Kelola akun.

   

   Mengelola akun

4. Buka Profil dan visibilitas.

   

   Profil dan visibilitas

5. Buka Kontak dan tetapkan Siapa yang dapat melihat ini sebagai Siapa saja.

   

   Kontak

Agar email pengguna dapat dilihat oleh siapa pun di Jira, lakukan hal berikut:

1. Login ke Atlassian dengan kredensial pengguna Anda.

2. Pilih aplikasi Jira.

3. Klik Setelan > Sistem.

4. Pilih Konfigurasi Umum di panel kiri.

5. Klik Edit Settings.

6. Untuk Visibilitas email pengguna, pilih Publik.

   

   Pilih visibilitas email

7. Klik Update.

Mengonfigurasi cakupan aplikasi minimum

Untuk melakukan tindakan yang ditentukan, Anda perlu menyiapkan izin berikut untuk konektor Jira Cloud di platform Atlassian.

1. Di halaman aplikasi, klik Izin.

2. Buka Jira API, lalu klik Add.

   Catatan: Setelah menambahkan Jira API, tombol Konfigurasi mungkin memerlukan waktu beberapa saat untuk muncul. Jika tidak langsung muncul, coba muat ulang halaman atau tunggu beberapa detik.

3. Klik Configure.

4. Buka tab Cakupan klasik.

5. Klik Edit cakupan dan pilih cakupan klasik sesuai kebutuhan Anda dari tabel berikut:

Mode koneksi	Izin	Tujuan
Penelusuran dan tindakan gabungan	read:jira-user, read:jira-work	Diperlukan untuk mengambil dan menampilkan hasil penelusuran dan detail pengguna secara real-time.
	write:jira-work	Memungkinkan asisten mengubah item kerja (misalnya, memperbarui kolom masalah) dan mengelola komentar atau masalah.
Khusus penelusuran gabungan	read:jira-user, read:jira-work	Diperlukan untuk menelusuri dan melihat masalah, project, dan profil pengguna.
Penyerapan dan tindakan data	read:jira-work	Diperlukan untuk crawling dan pengindeksan data item kerja yang luas.
	write:jira-work	Diperlukan untuk melakukan tindakan tulis (pembuatan, pembaruan, komentar) pada item tugas dalam lingkungan yang diproses.
Penyerapan data	read:jira-work	Diperlukan untuk meng-crawl dan mengindeks konten Jira agar tersedia untuk penelusuran.

1. Pastikan semua cakupan dipilih, lalu klik Simpan.

2. Buka tab Cakupan terperinci.

3. Klik Edit cakupan dan pilih cakupan terperinci sesuai kebutuhan Anda dari tabel berikut:

Mode koneksi	Izin	Tujuan
Penelusuran dan tindakan gabungan	write:comment:jira	Memungkinkan asisten memposting komentar atau balasan baru langsung dari antarmuka penelusuran.
	write:issue:jira	Diperlukan untuk membuat masalah baru atau melakukan pengeditan besar pada masalah yang ada.
Penyerapan dan tindakan data	read:user:jira, read:group:jira, read:avatar:jira	Diperlukan untuk menyinkronkan metadata pengguna/grup dan menampilkan profil pengguna.
	read:issue-security-level:jira, read:issue-security-scheme:jira	Penting untuk kontrol akses; memastikan data yang di-ingest mematuhi batas keamanan Jira.
	read:audit-log:jira	Digunakan untuk melacak perubahan dan melakukan sinkronisasi inkremental agar data yang di-ingest tetap terbaru.
	write:comment:jira	Diperlukan untuk menambahkan komentar ke masalah menggunakan asisten.
	write:issue:jira	Memungkinkan pembuatan atau modifikasi masalah.
Penyerapan data	read:user:jira, read:group:jira, read:avatar:jira	Diperlukan untuk meng-crawl dan mengindeks konten Jira serta hubungan pengguna.
	read:issue-security-level:jira, read:issue-security-scheme:jira	Diperlukan untuk memetakan izin sehingga hanya pengguna yang diberi otorisasi yang dapat menelusuri data yang di-ingest.
	read:audit-log:jira	Diperlukan agar mesin sinkronisasi dapat mengidentifikasi item mana yang telah diperbarui atau dihapus.

1. Pastikan semua cakupan dipilih, lalu klik Simpan.

Catatan: Jika Anda ingin melewati tindakan dan menggunakan penyimpanan data untuk penelusuran, Anda dapat membatasi izin hanya untuk izin read. Izin write hanya diperlukan untuk melakukan tindakan yang disebutkan dalam Tindakan yang didukung.

Menginstal Pengakses Identitas Pengguna

Untuk menginstal aplikasi User Identity Accessor for Jira Cloud di situs Jira Cloud Anda, ikuti langkah-langkah berikut:

1. Buka Atlassian Developer Console.

2. Tinjau izin Baca Alamat Email dan cakupan Penyimpanan Aplikasi, lalu klik Dapatkan aplikasi.

   

   Meninjau izin dan mendapatkan aplikasi

3. Dari daftar Pilih situs tempat menginstal aplikasi ini, pilih situs Jira tempat Anda ingin menginstal aplikasi. Daftar ini hanya menampilkan situs yang akses administrator-nya Anda miliki.

   Catatan: Anda harus menjadi administrator setidaknya satu situs Jira untuk menginstal aplikasi.

4. Klik Instal untuk menyelesaikan penginstalan aplikasi.

Mengonfigurasi Pengakses Identitas Pengguna

Setelah menginstal aplikasi User Identity Accessor for Jira Cloud, konfigurasi kunci API yang digunakan sistem eksternal Anda (misalnya, Jira Cloud Connector) untuk memanggil pemicu web aplikasi secara aman guna mengambil email.

Mengakses halaman konfigurasi

Untuk mengakses halaman konfigurasi aplikasi User Identity Accessor for Jira Cloud, lakukan langkah berikut:

1. Di instance Jira Cloud Anda, klik ikon Setelan ⚙️ di menu navigasi.
2. Pilih Aplikasi dari menu.
3. Di halaman Administrasi aplikasi, temukan aplikasi Anda, User Identity Accessor for Jira Cloud, dalam daftar Kelola aplikasi.

4. Klik Konfigurasi atau link yang terkait dengan aplikasi Anda. Halaman konfigurasi khusus aplikasi akan terbuka di Jira Cloud.

   

   Mengonfigurasi aplikasi User Identity Accessor untuk Jira Cloud

Menyiapkan kunci API

Untuk menyiapkan kunci API di halaman konfigurasi, lakukan hal berikut:

1. Di bagian Konfigurasi Kunci API, tentukan kunci rahasia untuk mengautentikasi permintaan ke pemicu web aplikasi. Anda dapat mengautentikasi permintaan menggunakan salah satu metode berikut:

   • Masukkan kunci Anda sendiri: Ketik atau tempel kunci API yang kuat dan unik ke kolom Kunci API. Gunakan kunci minimal 20–30 karakter dengan kombinasi huruf besar, huruf kecil, angka, dan simbol.

     

     Masukkan kunci Anda sendiri

   • Buat kunci: Klik tombol Buat Kunci Baru. Sistem membuat dan menampilkan kunci acak yang kuat di kolom.

     

     Buat kunci

     Penting: Segera salin kunci API yang ditampilkan di kolom. Karena alasan keamanan, Anda mungkin tidak dapat melihat kunci lengkap lagi setelah menyimpan atau keluar. Jika hilang, Anda harus menyetel atau membuat yang baru.

2. Klik Save API Key. Pesan sukses mengonfirmasi bahwa kunci telah disimpan dengan aman.

Catatan: Kunci API yang dihasilkan atau dibuat di bagian ini berfungsi sebagai nilai untuk kolom Jira Identity Sync Forge Client Secret di bagian Advanced Options selama penyiapan Konektor.

Menguji konfigurasi aplikasi

Verifikasi apakah aplikasi User Identity Accessor for Jira Cloud dikonfigurasi dengan benar dengan mengirim permintaan dari sistem eksternal Anda dan mengonfirmasi bahwa alamat email pengguna berhasil ditampilkan.

Mendapatkan URL pemicu web

1. Di halaman Administrasi aplikasi, temukan bagian URL Webtrigger, yang menampilkan URL unik khusus untuk situs Jira Anda dan penginstalan aplikasi ini:
   • Sistem eksternal Anda harus memanggil URL ini untuk meminta email pengguna.
   • Contoh URL: https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, dengan YOUR_INSTANCE_ID adalah ID instance Jira Cloud Anda dan WEBTRIGGER_ID adalah ID unik untuk endpoint pemicu web yang dibuat untuk aplikasi Anda.
2. Klik tombol Salin URL atau salin seluruh URL.

Mengonfigurasi sistem eksternal Anda

• Konfigurasi sistem eksternal yang perlu mengambil email pengguna Jira dengan kunci API dan URL pemicu web yang diperoleh pada langkah sebelumnya.

• Endpoint URL: URL pemicu web yang Anda salin.

• Metode HTTP: POST

• Header Wajib:

  • Content-Type: application/json

  • X-Api-Key: YOUR_API_KEY

    Ganti YOUR_API_KEY dengan kunci API yang Anda tetapkan atau buat di bagian Siapkan kunci API.

Contoh perintah curl

Contoh ini menunjukkan cara memanggil pemicu web User Identity Accessor for Jira Cloud, yang menerima array ID akun dan menampilkan alamat email.

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

Ganti:

• YOUR_INSTANCE_ID dengan ID instance Jira Cloud Anda
• ENDPOINT_PATH dengan jalur endpoint API
• YOUR_API_KEY dengan kunci API yang Anda tetapkan atau buat di bagian Siapkan kunci API
• ACCOUNT_ID dengan ID akun Atlassian yang ingin Anda targetkan

Respons yang diharapkan

[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

Ganti:

• ACCOUNT_ID_X dengan ID akun Atlassian yang sebenarnya
• USER_EMAIL_X dengan alamat email pengguna yang ditampilkan dari panggilan API Anda

Menerapkan praktik terbaik keamanan

Untuk mengonfirmasi keamanan kunci API Anda, ikuti rekomendasi berikut:

• Simpan kunci API dengan aman dalam konfigurasi Jira Cloud Connector Anda.
• Pastikan semua komunikasi dengan URL webhook terjadi melalui HTTPS. Ini adalah setelan default untuk pemicu web User Identity Accessor for Jira Cloud.

Dukungan untuk Pengakses Identitas Pengguna untuk Jira Cloud

Penawaran dukungan tersedia dari Google untuk aplikasi User Identity Accessor for Jira Cloud yang dapat mencakup pemeliharaan dan update rutin agar aplikasi tetap terbaru. Jika Anda mengalami masalah atau memiliki pertanyaan khusus tentang fungsi aplikasi, hubungi Google Cloud Dukungan. Untuk mengetahui informasi selengkapnya, lihat Mendapatkan Cloud Customer Care.