id
Panduan
Instalasi
Tambah client baru
idGuidesInstallationAdd New Client

Tambah client baru

Panduan ini menjelaskan cara mendaftarkan OAuth client tambahan di NQRust-Identity, di luar client Portal yang telah dibuat pada Fase 2. Contoh menggunakan NQRust Analytics; sesuaikan nama-nama tersebut dengan nilai yang sesuai untuk aplikasi Anda.

Prasyarat

  • Fase 1 dan Fase 2 telah selesai.
  • Identity Admin Console dapat diakses dan realm nqrust sudah ada.
  • Aplikasi tujuan siap dikonfigurasi dengan Client ID dan Client Secret.

Langkah 1 — Buka Identity Admin Console

Buka Identity Admin Console di browser dan masuk:

https://<hostname>:<identity_port>/admin

Pastikan nqrust adalah Current realm (nama realm tertera pada bagian atas sidebar kiri). Jika realm lain yang tertampil, klik Manage realms lalu pilih nqrust.

Identity Admin Console dengan realm nqrust terpilih

Langkah 2 — Buat OAuth client

Wizard memiliki tiga langkah: General settings, Capability config, dan Login settings.

Untuk membuka wizard:

  1. Di sidebar kiri, klik Clients.
  2. Klik Create client.

Halaman Clients dengan tombol Create client

Langkah 2.1 — General settings

Isi form General settings:

FieldNilai
Client typeBiarkan sebagai OpenID Connect.
Client IDMasukkan nqrust-analytics. Nilai ini wajib.
NameMasukkan label tampilan, contohnya NQRust Analytics.
DescriptionOpsional. Biarkan kosong, atau masukkan deskripsi singkat seperti OAuth client untuk NQRust Analytics.
Always display in UIToggle ke On.

Klik Next untuk melanjutkan.

Create client - general settings

Langkah 2.2 — Capability config

Atur form Capability config:

  • Client authentication — toggle ke On.
  • Authorization — toggle ke On.
  • Authentication flow — pastikan opsi berikut tercentang:
    • Standard flow
    • Service accounts roles
  • PKCE Method — biarkan pada Choose... (tanpa nilai).

Klik Next untuk melanjutkan.

Capability config

Langkah 2.3 — Login settings

Isi form Login settings dengan URL aplikasi tujuan. Setiap aplikasi memiliki host, port, dan callback path-nya sendiri; sesuaikan nilainya.

FieldDeskripsi
Root URLURL dasar aplikasi, contohnya https://analytics.example.com.
Home URLBiasanya sama dengan Root URL.
Valid redirect URIsURL callback OAuth aplikasi, contohnya https://analytics.example.com/auth/callback.
Valid post logout redirect URIsURL tujuan setelah logout, contohnya https://analytics.example.com.
Web originsOrigin browser yang diizinkan memanggil Identity, contohnya https://analytics.example.com.

Klik Save.

Login settings

Langkah 3 — Copy client secret dan konfigurasi aplikasi

Klik tab Credentials pada Client details nqrust-analytics.

  1. Cari field Client secret.
  2. Klik tombol copy untuk menyalin Client Secret ke clipboard.
  3. Simpan nilai ini; nilai akan ditempelkan ke konfigurasi aplikasi pada langkah berikutnya.

Copy client secret

Tempelkan Client ID dan Client Secret ke konfigurasi aplikasi. Mekanisme persisnya bergantung pada framework atau bahasa aplikasi; lihat dokumentasi aplikasi Anda. Pola umumnya adalah membaca nilai-nilai tersebut dari environment variable:

OIDC_CLIENT_ID=nqrust-analytics
OIDC_CLIENT_SECRET=<tempel-secret-di-sini>
OIDC_ISSUER=https://<hostname>:<identity_port>/realms/nqrust
⚠️

Perlakukan client secret seperti password. Jangan bagikan atau commit ke version control.

Langkah 4 — Buat realm role untuk client

Buat realm role yang akan diberikan kepada user yang membutuhkan akses ke client ini.

  1. Di sidebar kiri, klik Realm roles.
  2. Klik Create role.
  3. Pada field Role name, masukkan nqrust-analytics.
  4. Opsional, masukkan deskripsi seperti Memberikan akses ke NQRust Analytics.
  5. Klik Save.

Buat realm role nqrust-analytics

Menyamakan nama role dengan Client ID (nqrust-analytics) menjaga konsistensi konfigurasi. Nama apa pun yang diterima logika otorisasi aplikasi tetap valid.

Langkah 5 — Assign role ke user

Berikan user role nqrust-analytics agar dapat mengakses aplikasi.

  1. Di sidebar kiri, klik Users.
  2. Klik username yang membutuhkan akses. Jika user belum ada, klik Add user untuk membuatnya terlebih dahulu (lihat Fase 2, Langkah 7 untuk panduan pembuatan user).
  3. Pada halaman User details, klik tab Role mapping.
  4. Klik Assign role. Pada dialog, pilih Realm roles.
  5. Centang role nqrust-analytics.
  6. Klik Assign.

Assign realm role nqrust-analytics ke user

⚠️

Ulangi langkah ini untuk setiap user yang membutuhkan akses ke client baru tersebut.

Client baru telah terdaftar, terkonfigurasi, dan siap digunakan untuk autentikasi user.