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 perlu 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 guna menyiapkan aplikasi di Atlassian Developer Console dan mendapatkan client ID 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 System di bagian Jira settings, Anda memiliki akses organization administrator 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 Callback URL, masukkan URL sesuai dengan mode koneksi penyimpanan data Anda.

   • Penelusuran dan tindakan gabungan: https://vertexaisearch.cloud.google.com/oauth-redirect.

   • Penyerapan dan tindakan data: 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 Distribution.

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 menyatakan 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, lalu 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).

Mendapatkan kunci project

Untuk mendapatkan kunci project, lakukan tindakan berikut:

1. Login ke akun Jira Cloud Anda.

2. Dari menu navigasi, pilih Ruang.

3. Pilih project yang ID project-nya Anda perlukan.

4. Buka masalah apa pun dalam project tersebut, lalu klik more_horiz Tindakan.

5. Klik Export XML dan download file.

6. Buka file XML yang didownload dan telusuri tag yang berisi project id. Salin nilai yang terkait dengan tag ini untuk digunakan nanti.

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 Discovery Engine Editor 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 tersebut. Konektor menggunakan grup ini untuk mengautentikasi dan mengambil dokumen.

1. Di halaman Grup, klik Tambahkan produk.

2. Pilih User access admin sebagai peran untuk Jira.

3. Pilih Product admin sebagai peran untuk Jira administration.

   

   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 Developer console.

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

   

   Kelola 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 saja di Jira, lakukan hal berikut:

1. Login ke Atlassian dengan kredensial pengguna Anda.

2. Pilih aplikasi Jira.

3. Klik Setelan > Sistem.

4. Pilih General Configuration 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 Permissions.

2. Buka Jira API, lalu klik Add.

   Catatan: Setelah menambahkan Jira API, tombol Configure 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 scopes dan pilih cakupan klasik sesuai kebutuhan Anda dari tabel berikut:

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

6. Konfirmasi bahwa semua cakupan telah dipilih, lalu klik Simpan.

7. Buka tab Cakupan terperinci.

8. 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 penyimpanan data memposting komentar atau balasan baru langsung dari antarmuka penelusuran.
   	write:issue:jira	Memungkinkan penyimpanan data membuat masalah baru atau melakukan pengeditan besar pada masalah yang ada.
   	write:attachment:jira	Memungkinkan penyimpanan data menambahkan lampiran ke masalah Jira.
   	read:issue:jira	Mengizinkan penyimpanan data membaca masalah.
   	read:issue-type:jira	Mengizinkan penyimpanan data untuk membaca jenis masalah.
   	read:comment:jira	Mengizinkan penyimpanan data membaca komentar.
   	read:comment.property:jira	Mengizinkan penyimpanan data membaca properti komentar masalah.
   	read:project:jira	Memungkinkan penyimpanan data membaca project.
   	read:priority:jira	Mengizinkan penyimpanan data membaca prioritas.
   	read:issue.transition:jira	Mengizinkan penyimpanan data membaca transisi masalah.
   	read:issue-meta:jira	Mengizinkan penyimpanan data membaca metadata masalah.
   	read:board-scope.admin:jira-software	Memungkinkan penyimpanan data membaca konfigurasi, fitur project, filter, properti, dan filter cepat untuk papan.
   	read:board-scope:jira-software	Memungkinkan penyimpanan data membaca board, masalah di board, masalah dari backlog, laporan, dan versi.
   	read:issue-details:jira	Mengizinkan penyimpanan data membaca detail masalah.
   	read:jql:jira	Memungkinkan penyimpanan data membaca kueri Jira Query Language (JQL).
   Hanya penelusuran gabungan	read:issue:jira	Mengizinkan penyimpanan data membaca masalah.
   	read:issue-type:jira	Mengizinkan penyimpanan data untuk membaca jenis masalah.
   	read:comment:jira	Mengizinkan penyimpanan data membaca komentar.
   	read:comment.property:jira	Mengizinkan penyimpanan data membaca properti komentar masalah.
   	read:project:jira	Memungkinkan penyimpanan data membaca project.
   	read:priority:jira	Mengizinkan penyimpanan data membaca prioritas.
   	read:issue.transition:jira	Mengizinkan penyimpanan data membaca transisi masalah.
   	read:issue-meta:jira	Mengizinkan penyimpanan data membaca metadata masalah.
   	read:board-scope.admin:jira-software	Memungkinkan penyimpanan data membaca konfigurasi, fitur project, filter, properti, dan filter cepat untuk papan.
   	read:board-scope:jira-software	Memungkinkan penyimpanan data membaca board, masalah di board, masalah dari backlog, laporan, dan versi.
   	read:issue-details:jira	Mengizinkan penyimpanan data membaca detail masalah.
   	read:jql:jira	Memungkinkan penyimpanan data membaca kueri Jira Query Language (JQL).
   Penyerapan dan tindakan data	read:user:jira, read:group:jira, read:avatar:jira	Memungkinkan sinkronisasi metadata pengguna/grup dan menampilkan profil pengguna.
   	read:issue-security-level:jira, read:issue-security-scheme:jira	Memungkinkan kontrol akses, sehingga memastikan data yang di-ingest mematuhi batas keamanan Jira.
   	read:audit-log:jira	Memungkinkan pelacakan perubahan dan melakukan sinkronisasi inkremental untuk menjaga agar data yang di-ingest tetap terbaru.
   	write:comment:jira	Memungkinkan penambahan komentar ke masalah menggunakan penyimpanan data.
   	write:issue:jira	Memungkinkan asisten membuat atau mengubah masalah.
   Penyerapan data	read:user:jira, read:group:jira, read:avatar:jira	Mengizinkan crawling dan pengindeksan konten Jira dan hubungan pengguna.
   	read:issue-security-level:jira, read:issue-security-scheme:jira	Memungkinkan pemetaan izin sehingga hanya pengguna yang diizinkan yang dapat menelusuri data yang diserap.
   	read:audit-log:jira	Memungkinkan mesin sinkronisasi mengidentifikasi item mana yang telah diperbarui atau dihapus.

9. Konfirmasi bahwa semua cakupan telah 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, ikuti langkah-langkah berikut:

1. Buka Atlassian Marketplace.

2. Klik Dapatkan sekarang.

   

   Dapatkan sekarang

3. Dari daftar Select a site, pilih situs Jira tempat Anda ingin menginstal aplikasi.

   Catatan: Anda harus memiliki hak istimewa administrator untuk situs Jira yang dipilih agar dapat menginstal aplikasi.

4. Klik Tinjau untuk mengizinkan izin yang diperlukan dan menyetujui persyaratan dan ketentuan.

5. Klik Dapatkan sekarang untuk menyelesaikan penginstalan aplikasi.

   Setelah penginstalan berhasil, pesan konfirmasi akan muncul: "Aplikasi Anda telah ditambahkan ke instance Anda dan siap digunakan".

Mengonfigurasi Pengakses Identitas Pengguna

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

Mengakses halaman konfigurasi

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

1. Di instance Jira Cloud, klik ikon Settings ⚙️ di menu navigasi.
2. Pilih Aplikasi dari menu.
3. Di halaman Apps administration, temukan aplikasi Anda, User Identity Accessor for Jira Cloud, dalam daftar Manage apps.

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

   

   Mengonfigurasi aplikasi User Identity Accessor for 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 yang terdiri dari minimal 20–30 karakter dengan kombinasi huruf besar, huruf kecil, angka, dan simbol.

     

     Masukkan kunci Anda sendiri

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

     

     Membuat 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 menetapkan atau membuat yang baru.

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

Menguji konfigurasi aplikasi

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

Mendapatkan URL pemicu web

1. Di halaman Apps administration, temukan bagian Webtrigger URL, 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

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

• URL Endpoint: 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 Menyiapkan kunci API
• ACCOUNT_ID dengan ID akun Atlassian yang ingin Anda targetkan

Respons yang seharusnya

[{"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 terkait fungsi aplikasi, hubungi DukunganGoogle Cloud . Untuk mengetahui informasi selengkapnya, lihat Mendapatkan Cloud Customer Care.