Mengonfigurasi portal untuk menggunakan SAML untuk berkomunikasi dengan Edge

Edge for Private Cloud v4.18.05

Portal Layanan Developer Apigee (atau portal) berfungsi sebagai klien Apigee Edge. Artinya, portal tidak berfungsi sebagai sistem mandiri. Sebagai gantinya, sebagian besar informasi yang digunakan oleh portal 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 SAML untuk autentikasi Edge, Anda dapat mengonfigurasi portal untuk menggunakan autentikasi SAML saat membuat permintaan ke Edge. Mengonfigurasi portal untuk menggunakan SAML akan otomatis membuat akun pengguna mesin baru di organisasi Edge yang kemudian digunakan portal untuk membuat permintaan ke Edge. Untuk mengetahui informasi selengkapnya tentang pengguna mesin, lihat Menggunakan SAML dengan tugas otomatis.

Dukungan SAML untuk portal mengharuskan Anda telah menginstal dan mengonfigurasi modul SSO Edge di node Edge Management Server. Proses umum untuk mengaktifkan SAML untuk portal adalah:

  1. Konfigurasi SAML di Edge seperti yang dijelaskan dalam Penginstalan dan konfigurasi SAML untuk Edge. Catatan: Autentikasi Dasar masih harus diaktifkan di Edge untuk menginstal portal. Jangan nonaktifkan Autentikasi Dasar di Edge hingga Anda mengonfigurasi portal untuk menggunakan SAML.
  2. Instal portal dan pastikan penginstalan Anda berfungsi dengan benar. Lihat Menginstal portal Edge for Private Cloud.
  3. Konfigurasikan SAML di portal.
  4. Sekarang Anda dapat menonaktifkan Autentikasi Dasar di Edge.

Membuat pengguna mesin untuk portal

Jika SAML diaktifkan, Edge 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 untuk mendapatkan dan memperbarui token OAuth2.

Proses konfigurasi SAML untuk portal akan otomatis membuat pengguna mesin di organisasi yang terkait dengan portal. Portal kemudian menggunakan akun pengguna mesin ini untuk terhubung ke Edge. Untuk mengetahui informasi selengkapnya tentang pengguna mesin, lihat Menggunakan SAML dengan tugas otomatis.

Tentang autentikasi untuk akun developer portal

Saat mengonfigurasi portal untuk menggunakan SAML, Anda mengaktifkan portal untuk menggunakan SAML guna mengautentikasi dengan Edge sehingga portal dapat membuat permintaan ke Edge. Namun, portal ini juga mendukung jenis pengguna yang disebut developer.

Developer membentuk komunitas pengguna yang mem-build aplikasi 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 yang bertanggung jawab untuk mengautentikasi developer dan menerapkan izin berbasis peran. Portal akan terus menggunakan autentikasi dasar dengan developer meskipun setelah Anda mengaktifkan SAML antara portal dan Edge. Untuk mengetahui informasi selengkapnya, lihat Berkomunikasi antara portal dan Edge.

Anda juga dapat mengonfigurasi portal untuk menggunakan SAML guna mengautentikasi developer. Untuk contoh cara mengaktifkan SAML menggunakan modul Drupal pihak ketiga, lihat Integrasi SSO melalui SAML dengan Portal Developer.

Mengonfigurasi SAML di portal untuk berkomunikasi dengan Edge

Untuk mengonfigurasi SAML untuk portal, Anda harus membuat file konfigurasi untuk mengonfigurasi portal:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about 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

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth 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 chars. 
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 SAML. 
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 new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

Untuk mengaktifkan dukungan SAML di portal:

  1. Di UI Edge, tambahkan pengguna mesin yang ditentukan oleh DEVPORTAL_ADMIN_EMAIL ke organisasi yang terkait dengan portal sebagai Administrator Organisasi.
  2. Jalankan perintah berikut untuk mengonfigurasi SAML di portal: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    Dengan samlConfigFile adalah file konfigurasi SAML.

  3. Login ke portal sebagai admin portal.
  4. Di menu Drupal utama, pilih Konfigurasi > Portal Dev. Layar konfigurasi portal akan muncul, termasuk setelan SAML:

    Perhatikan bahwa kotak untuk Organisasi ini mengaktifkan SAML dicentang, endpoint untuk modul SSO Edge diisi, kolom Kunci API dan Rahasia konsumen untuk klien Oauth portal diisi, dan pesan Koneksi Berhasil muncul di bawah tombol Uji Koneksi.

  5. Anda dapat menekan tombol Test Connection untuk menguji ulang koneksi kapan saja.

Untuk mengubah nilai ini nanti, perbarui file konfigurasi dan jalankan perintah lagi.

Menonaktifkan SAML di portal

Jika Anda memilih untuk menonaktifkan SAML untuk komunikasi antara portal dan Edge, portal tidak akan lagi dapat membuat permintaan ke Edge. Developer dapat login ke portal, tetapi tidak akan dapat melihat produk atau membuat aplikasi.

Untuk menonaktifkan SAML di portal:

  1. Edit file konfigurasi yang Anda gunakan untuk mengonfigurasi SAM guna menetapkan: 
    DEVPORTAL_SSO_ENABLED=n
  2. Konfigurasi portal: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile