Portal Layanan Developer Apigee (atau cukup, portal) bertindak sebagai klien Apigee Edge. Artinya, portal tidak berfungsi sebagai sistem mandiri. Sebaliknya, banyak informasi yang digunakan oleh portal yang sebenarnya disimpan di Edge. Jika perlu, portal akan membuat permintaan untuk mengambil informasi dari Edge atau mengirim informasi ke Edge.
Portal selalu dikaitkan dengan satu organisasi Edge. Saat mengonfigurasi portal, Anda dapat menentukan kredensial autentikasi dasar (nama pengguna dan sandi) untuk akun di organisasi yang digunakan portal untuk berkomunikasi dengan Edge.
Jika memilih untuk mengaktifkan IDP eksternal seperti SAML atau LDAP untuk autentikasi Edge, Anda dapat mengonfigurasi portal untuk menggunakan autentikasi tersebut saat membuat permintaan ke Edge. Dengan mengonfigurasi portal untuk menggunakan IDP eksternal, akan otomatis membuat akun pengguna komputer baru dalam organisasi Edge yang kemudian digunakan oleh portal untuk mengajukan permintaan ke Edge. Untuk informasi selengkapnya tentang pengguna mesin, lihat Mengotomatiskan tugas untuk IDP eksternal.
Dukungan IDP eksternal untuk portal ini mengharuskan Anda untuk sudah menginstal dan mengonfigurasi modul SSO Apigee pada node Edge Management Server. Proses yang umum guna mengaktifkan IDP eksternal untuk portal adalah sebagai berikut:
- Instal modul SSO Apigee, seperti yang dijelaskan dalam Menginstal SSO Apigee untuk ketersediaan tinggi.
- Instal portal dan pastikan penginstalan Anda berfungsi dengan baik. Lihat Menginstal portal.
- Konfigurasikan SAML atau LDAP di portal, seperti yang dijelaskan di bagian ini.
- (Opsional) Nonaktifkan autentikasi Dasar di Edge, seperti yang dijelaskan dalam Menonaktifkan Autentikasi dasar di Edge.
Membuat pengguna perangkat untuk portal
Jika IDP eksternal diaktifkan, Edge akan mendukung pembuatan token OAuth2 otomatis melalui penggunaan pengguna mesin. Pengguna mesin dapat memperoleh token OAuth2 tanpa harus menentukan kode sandi. Artinya, Anda dapat sepenuhnya mengotomatiskan proses perolehan dan pembaruan token OAuth2.
Proses konfigurasi IDP untuk portal akan otomatis membuat pengguna mesin di organisasi yang terkait dengan portal tersebut. Portal tersebut kemudian menggunakan akun pengguna perangkat ini untuk terhubung ke Edge. Untuk informasi selengkapnya tentang pengguna mesin, lihat Mengotomatiskan tugas untuk IDP eksternal.
Tentang autentikasi untuk akun developer portal
Saat mengonfigurasi portal untuk menggunakan IDP eksternal, Anda mengaktifkan portal untuk menggunakan SAML atau LDAP guna melakukan autentikasi dengan Edge, sehingga portal dapat membuat permintaan ke Edge. Namun, portal ini juga mendukung jenis pengguna yang disebut developer.
Developer membentuk komunitas pengguna yang membangun aplikasi dengan menggunakan API Anda. Developer aplikasi menggunakan portal untuk mempelajari API Anda, mendaftarkan aplikasi yang menggunakan API Anda, berinteraksi dengan komunitas developer, dan melihat informasi statistik tentang penggunaan aplikasi mereka di dasbor.
Saat developer login ke portal, portal tersebut bertanggung jawab untuk mengautentikasi developer dan menerapkan izin berbasis peran. Portal ini akan terus menggunakan Autentikasi dasar dengan developer, bahkan setelah Anda mengaktifkan autentikasi IDP antara portal dan Edge. Untuk mengetahui informasi selengkapnya, lihat Berkomunikasi antara portal dan Edge.
Anda juga dapat mengonfigurasi portal untuk menggunakan SAML atau LDAP guna mengautentikasi developer. Untuk contoh cara mengaktifkan SAML menggunakan modul Drupal pihak ketiga, lihat Integrasi SSO melalui SAML dengan Portal Developer.
File konfigurasi IDP untuk portal
Jika ingin mengonfigurasi IDP eksternal untuk portal, Anda harus membuat file konfigurasi yang menentukan setelan portal.
Contoh berikut menunjukkan file konfigurasi portal dengan dukungan IDP:
# IP address of Edge Management Server and the node on which the Apigee SSO module is installed. IP1=22.222.22.222 # URL of Edge management API. MGMT_URL=http://$IP1:8080/v1 # Organization associated with the portal. EDGE_ORG=myorg # Information about the Apigee SSO module (apigee-sso). # Externally accessible IP or DNS of apigee-sso. SSO_PUBLIC_URL_HOSTNAME=$IP1 SSO_PUBLIC_URL_PORT=9099 # Default is http. Set to https if you enabled TLS on apigee-sso. SSO_PUBLIC_URL_SCHEME=http # SSO admin credentials as set when you installed apigee-sso. SSO_ADMIN_NAME=ssoadmin SSO_ADMIN_SECRET=Secret123 # Enables or disables external IDP support. # Default is "n", which disables external IDP support. # Change it to "y" to enable external IDs support. DEVPORTAL_SSO_ENABLED=y # The name of the OAuth2 client used to connect to apigee-sso. # The default client name is portalcli. PORTALCLI_SSO_CLIENT_NAME=portalcli # OAuth client password using uppercase, lowercase, number, and special characters. PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1 # Email address and user info for the machine user created in the Edge org specified # above by EDGE_ORG. # This account is used by the portal to make requests to Edge. # Add this email as an org admin before configuring the portal to use an external IDP. DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com DEVPORTAL_ADMIN_FIRSTNAME=DevPortal DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin DEVPORTAL_ADMIN_PWD=Abcdefg@1 # If set, the existing portal OAuth client is deleted and a new one is created. # The default value is "n". # Set to "y" when you configure the external IDP and change the value of # any of the PORTALCLI_* properties. PORTALCLI_SSO_CLIENT_OVERWRITE=y
Untuk mengaktifkan dukungan IDP eksternal di portal:
- Di UI Edge, tambahkan pengguna mesin yang ditentukan oleh
DEVPORTAL_ADMIN_EMAILke organisasi yang terkait dengan portal sebagai Administrator Organisasi. - Jalankan perintah berikut untuk mengonfigurasi IDP eksternal di portal:
/opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile
Dengan configFile adalah file konfigurasi yang dijelaskan di atas.
- Login ke portal sebagai admin portal.
- Di menu utama Drupal, pilih Configuration > Dev Portal. Layar konfigurasi portal akan muncul, termasuk setelan IDP eksternal:
Perhatikan hal berikut:
- Kotak untuk Organisasi ini kompatibel dengan SAML dicentang
- Endpoint untuk modul SSO Apigee terisi
- Kolom API key dan Consumer secret untuk klien Oauth portal sudah terisi
- Pesan Connection Berhasil muncul di bawah tombol Test Connection.
- Klik tombol Uji Koneksi untuk menguji ulang koneksi kapan saja.
Untuk mengubah nilai ini nanti, perbarui file konfigurasi dan jalankan prosedur ini lagi.
Nonaktifkan IDP eksternal di portal
Jika Anda memilih menonaktifkan IDP eksternal untuk komunikasi antara portal dan Edge, portal tidak akan dapat lagi membuat permintaan ke Edge. Developer dapat login ke portal, tetapi tidak akan dapat melihat produk atau membuat aplikasi.
Untuk menonaktifkan autentikasi IDP eksternal di portal:
- Buka file konfigurasi yang Anda gunakan sebelumnya untuk mengaktifkan IDP eksternal.
- Tetapkan nilai properti
DEVPORTAL_SSO_ENABLEDken, seperti yang ditunjukkan pada contoh berikut:DEVPORTAL_SSO_ENABLED=n
- Konfigurasikan portal dengan menjalankan perintah berikut:
/opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile