Konfigurasi Confluence Cloud

Pratinjau publik: Penelusuran 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 instance Confluence Cloud sebelum membuat penyimpanan data Confluence 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 Confluence 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 Confluence

Untuk memverifikasi akses administrator organisasi Confluence, lakukan hal berikut:

1. Login ke Atlassian dengan kredensial pengguna Anda.

2. Pilih aplikasi Confluence.

3. Klik Setelan.

   Jika Anda melihat opsi Sistem di bagian Setelan Confluence, Anda memiliki akses administrator organisasi Confluence. Jika tidak, minta administrator organisasi Confluence 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 Jenis otorisasi, pilih Tambahkan untuk OAuth 2.0 (3LO).

6. Di kolom URL Callback, masukkan https://vertexaisearch.cloud.google.com/console/oauth/confluence_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.
   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 Confluence 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 Confluence, 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.

4. Klik Grup di bagian Pengelolaan pengguna.

5. Di halaman Grup:

   1. Klik Buat grup.
   2. Masukkan nama untuk 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 Confluence.

3. Pilih Admin produk sebagai peran untuk administrasi Confluence.

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.

Mengonfigurasi cakupan aplikasi minimum

Untuk mengonfigurasi OAuth 2.0 dan mengambil kredensial yang diperlukan untuk penyiapan konektor Confluence, lakukan hal berikut:

1. Aktifkan OAuth 2.0:
   1. Klik Izin.
   2. Buka Confluence API.
   3. Klik Tambahkan.
   4. Klik Configure.
   5. Buka tab Cakupan terperinci, lalu klik Edit cakupan.
   6. Pilih cakupan berikut.
      • read:attachment:confluence
      • read:configuration:confluence
      • read:content.metadata:confluence
      • read:content-details:confluence
      • read:whiteboard:confluence
      • read:group:confluence
      • read:space:confluence
      • read:user:confluence
      • search:confluence
      • write:page:confluence
      • write:attachment:confluence
   7. Konfirmasi bahwa semua cakupan telah dipilih dan simpan perubahan Anda.

Menyiapkan token API di Confluence

Jika berencana menggunakan token API untuk autentikasi, Anda harus membuat token API tanpa cakupan. Konektor ini tidak mendukung token API dengan cakupan.

1. Login ke Konsol Atlassian.
2. Klik Create API token.
3. Masukkan nama untuk token API.
4. Pilih tanggal habis masa berlaku untuk token API. Periode habis masa berlaku token berkisar antara 1 hingga 365 hari.
5. Klik Create.
6. Simpan token untuk digunakan nanti.

Mengelola visibilitas pengguna

Agar email pengguna dapat dilihat oleh siapa saja di akun Atlassian, ikuti langkah-langkah berikut:

1. Login ke Atlassian Developer Console.

2. Klik ikon profil, lalu pilih Konsol developer.

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

4. Buka Profil dan visibilitas.

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

Untuk membuat email pengguna terlihat oleh siapa pun di Confluence, ikuti langkah-langkah berikut:

1. Login ke Atlassian dengan kredensial pengguna Anda.

2. Pilih aplikasi Confluence.

3. Klik Setelan > Sistem.

4. Pilih Konfigurasi Umum di panel kiri.

5. Klik Edit Settings.

6. Untuk Visibilitas email pengguna, pilih Publik.

7. Klik Update.

Menginstal dan mengonfigurasi User Identity Accessor untuk Confluence Cloud

Jika alamat email pengguna tidak dapat diakses secara publik secara default karena setelan privasi di Confluence Cloud, Anda harus menginstal aplikasi User Identity Accessor for Confluence Cloud untuk mengambil alamat email pengguna secara aman. Jika alamat email pengguna sudah terlihat secara publik, Anda mungkin tidak perlu menginstal aplikasi. Untuk mengetahui informasi selengkapnya tentang visibilitas email yang dibatasi, lihat Mengelola visibilitas pengguna dan memberikan peran.

Peran dan izin

Untuk menginstal dan mengonfigurasi aplikasi User Identity Accessor for Confluence Cloud, Anda harus memiliki peran administratif yang sesuai dan memberikan izin tingkat aplikasi yang diperlukan.

• Peran yang diperlukan: Anda harus menjadi Confluence Site administrator untuk menginstal dan mengonfigurasi aplikasi.
• Izin tingkat aplikasi: Anda harus memberikan izin berikut selama penginstalan aplikasi:
  • Read Email Address: Mengizinkan aplikasi mengambil alamat email pengguna secara aman, meskipun visibilitas profil dibatasi.
  • App Storage scope: Mengizinkan aplikasi membaca dan menulis ke perangkat penyimpanannya.

Menginstal User Identity Accessor untuk Confluence Cloud

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

1. Buka Atlassian Developer Console.

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

3. Dari daftar Pilih situs tempat aplikasi ini akan diinstal, pilih situs Confluence tempat Anda ingin menginstal aplikasi. Daftar ini hanya menampilkan situs yang akses administratornya Anda miliki.

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

4. Klik Instal untuk menyelesaikan penginstalan aplikasi.

Mengonfigurasi Pengakses Identitas Pengguna untuk Confluence Cloud

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

Mengakses halaman konfigurasi

Untuk mengakses halaman konfigurasi aplikasi User Identity Accessor for Confluence Cloud di Confluence Cloud, ikuti langkah-langkah berikut:

1. Di instance Confluence 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 Confluence Cloud, dalam daftar Kelola aplikasi.
4. Klik Konfigurasi atau link yang terkait dengan aplikasi Anda. Halaman konfigurasi khusus aplikasi akan terbuka di Confluence.

Menyiapkan kunci API

Untuk menyiapkan kunci API di halaman konfigurasi, ikuti langkah-langkah berikut:

1. Di bagian Konfigurasi Kunci API, tentukan kunci rahasia untuk mengautentikasi permintaan ke webtrigger 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.

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

     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 Confluence Identity Sync Forge Client Secret di bagian Advanced Options selama penyiapan Konektor.

Menguji konfigurasi aplikasi

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

Mendapatkan URL webtrigger

1. Di halaman Administrasi aplikasi, temukan bagian URL Webtrigger, yang menampilkan URL unik khusus untuk situs Confluence dan penginstalan aplikasi ini:
   • Sistem eksternal Anda harus memanggil URL ini untuk meminta email pengguna. Misalnya, https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, dengan YOUR_INSTANCE_ID adalah ID instance Confluence Cloud Anda dan WEBTRIGGER_ID adalah ID unik untuk endpoint webtrigger 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 Confluence dengan kunci API dan URL webtrigger yang diperoleh pada langkah sebelumnya.

  • Endpoint URL: URL webtrigger 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 Confluence 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 Confluence 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 Confluence Cloud Connector Anda.
• Pastikan semua komunikasi dengan URL webhook terjadi melalui HTTPS. Ini adalah setelan default untuk pemicu web User Identity Accessor for Confluence Cloud.

Dukungan untuk Pengakses Identitas Pengguna untuk Confluence Cloud

Penawaran dukungan tersedia dari Google untuk aplikasi User Identity Accessor for Confluence 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.