Manual Administrator – Konfigurasi Rest API pada Directory Hub

PBI/Modul: Identity – Directory Hubs – Detail – Rest API
Versi Dokumen: 1.0
Tanggal: 05 Mei 2026
Aplikasi: IdProo
Ditujukan untuk: Administrator

Dalam artikel ini

Gambaran Umum
Mengonfigurasi Koneksi Rest API
Penjelasan Izin Akses (Permissions)
Solusi Masalah yang Sering Ditemui

Gambaran Umum

Rest API pada halaman detail Directory Hub digunakan untuk mengatur koneksi antara sistem IdProo dan Active Directory melalui antarmuka Rest API. Konfigurasi ini memungkinkan IdProo untuk mengambil dan memperbarui data direktori secara terus-menerus.

Rest API harus dipasang pada server yang telah tergabung dalam domain Active Directory (sesuai dengan persyaratan pada tab Installation).

Fungsi koneksi Rest API:

Membaca data pengguna dan direktori (query users and directory data).
Membuat pengguna baru pada direktori.
Memperbarui atribut pengguna dan kata sandi.
Mengelola status pengguna (aktif/nonaktif) dan memperbarui kebijakan.

⚠️ Peringatan: Informasi Api Key bersifat rahasia. Jangan membagikan nilai ini kepada pihak yang tidak berwenang. Apabila Api Key diduga bocor, segera perbarui konfigurasi dan ganti kunci tersebut.

1. Mengonfigurasi Koneksi Rest API

Alur Proses

Buka Directory Hubs → Pilih hub → Klik Rest API → Isi konfigurasi → Atur Permissions → Klik Save

Langkah-Langkah

Pada panel navigasi kiri, klik menu Directory Hubs di bawah bagian IDENTITY.
Dari daftar Directory Hub, klik nama hub yang ingin dikonfigurasi.
Pada panel navigasi kiri halaman detail, klik Rest API di bawah bagian MANAGE.
Panel kanan akan menampilkan form konfigurasi Rest API.
Isi seluruh field yang tersedia sesuai dengan konfigurasi Rest API yang telah dipasang.
Atur izin akses (Permissions) yang diperlukan dengan mencentang pilihan yang sesuai.
Klik tombol Save untuk menyimpan konfigurasi.

Tab Rest API pada Halaman Detail Directory Hub

Gambar 1: Tab Rest API – form konfigurasi koneksi Rest API

Penjelasan Field Konfigurasi

Field	Wajib Diisi	Keterangan
Name	Ya	Nama identifikasi untuk konfigurasi Rest API ini (contoh: Hub APIs)
Version	Ya	Versi Rest API yang digunakan (contoh: v1)
URL	Ya	Alamat URL tempat Rest API dipasang pada server Active Directory
Api Key	Ya	Kunci autentikasi untuk mengamankan koneksi antara IdProo dan Rest API. Ditampilkan dalam format tersembunyi.

Catatan: Nilai URL harus dapat dijangkau oleh sistem IdProo melalui jaringan. Pastikan tidak ada firewall yang memblokir koneksi dari IdProo ke alamat URL tersebut.

2. Penjelasan Izin Akses (Permissions)

Bagian Permissions menentukan operasi apa saja yang diizinkan dilakukan oleh IdProo terhadap data direktori melalui koneksi Rest API. Setiap izin dapat diaktifkan atau dinonaktifkan secara terpisah.

Izin Akses	Keterangan
Read — query users and directory data	Mengizinkan IdProo untuk membaca dan mengambil data pengguna serta informasi direktori
Create — create new users	Mengizinkan IdProo untuk membuat pengguna baru pada direktori Active Directory
Update — update user attributes and password	Mengizinkan IdProo untuk memperbarui atribut pengguna (seperti nama dan surel) serta mengubah kata sandi
Manage — enable/disable users and update policies	Mengizinkan IdProo untuk mengaktifkan atau menonaktifkan akun pengguna serta memperbarui kebijakan yang berlaku

Rekomendasi: Aktifkan hanya izin yang benar-benar diperlukan sesuai dengan kebutuhan integrasi. Memberikan izin yang tidak diperlukan dapat meningkatkan risiko keamanan.

Catatan: Apabila suatu izin tidak dicentang, operasi yang berkaitan dengan izin tersebut tidak akan dapat dilakukan oleh IdProo meski koneksi Rest API sudah terhubung.

3. Solusi Masalah yang Sering Ditemui

Masalah	Kemungkinan Penyebab	Solusi
Konfigurasi tidak tersimpan setelah klik Save	Salah satu field wajib (Name, Version, URL, atau Api Key) belum terisi	Pastikan seluruh field wajib telah diisi dengan benar sebelum menyimpan
Sinkronisasi data pengguna gagal setelah konfigurasi disimpan	URL Rest API tidak dapat dijangkau oleh sistem atau Api Key salah	Verifikasi URL dapat diakses dari jaringan dan pastikan Api Key yang dimasukkan sudah benar
Operasi tertentu tidak berjalan (contoh: pengguna tidak bisa dibuat)	Izin yang diperlukan belum diaktifkan pada bagian Permissions	Periksa dan aktifkan izin yang sesuai, lalu simpan kembali konfigurasi
Api Key tidak dikenali oleh server Rest API	Api Key sudah kedaluwarsa atau telah diubah di sisi server	Perbarui nilai Api Key pada form dengan kunci yang berlaku saat ini
Tab Rest API tidak dapat diakses	Hak akses administrator tidak mencukupi	Pastikan akun yang digunakan memiliki peran administrator yang sesuai untuk mengakses konfigurasi Directory Hub