Portalı harici IdP'leri kullanacak şekilde yapılandırma

Apigee Developer Services portalı (veya daha basit bir şekilde ifade etmek gerekirse portal), Apigee Edge'in müşterisidir. Bu durum, portalın bağımsız bir sistem olarak çalışmadığı anlamına gelir. Bunun yerine portal tarafından kullanılan bilgilerin çoğu aslında Edge'de depolanıyor. Portal, gerektiğinde Edge'den bilgi almak veya Edge'e bilgi göndermek için istekte bulunur.

Portal her zaman tek bir Edge kuruluşuyla ilişkilendirilir. Portalı yapılandırırken, kuruluştaki bir hesabın Edge ile iletişim kurmak için kullandığı temel kimlik doğrulama kimlik bilgilerini (kullanıcı adı ve şifre) belirtebilirsiniz.

Edge kimlik doğrulaması için SAML veya LDAP gibi harici bir IDP'yi etkinleştirmeyi seçerseniz portalı, Edge'e istekte bulunurken bu kimlik doğrulamasını kullanacak şekilde yapılandırabilirsiniz. Portalı harici bir IdP kullanacak şekilde yapılandırılması, Edge kuruluşunda otomatik olarak yeni bir makine kullanıcısı hesabı oluşturur. Portalı bu hesap Edge'e istekte bulunmak için kullanılır. Makine kullanıcıları hakkında daha fazla bilgi için Harici IdP'ler için görevleri otomatikleştirme bölümüne bakın.

Portalın harici IDP desteği için Apigee TOA modülünü önceden yüklemiş ve Uç Yönetim Sunucusu düğümüne yapılandırmış olmanız gerekir. Portal için harici bir IdP'yi etkinleştirmeyle ilgili genel süreç şu şekildedir:

  1. Apigee TOA modülünü Yüksek kullanılabilirlik için Apigee TOA'yı yükleme bölümünde açıklandığı şekilde yükleyin.
  2. Portalı yükleyin ve yüklemenizin düzgün çalıştığından emin olun. Portalı yükleme bölümüne bakın.
  3. Portalda SAML veya LDAP'yi bu bölümde açıklandığı şekilde yapılandırın.
  4. (İsteğe bağlı) Edge'de Temel kimlik doğrulamayı devre dışı bırakma bölümünde açıklandığı gibi, Edge'de Temel kimlik doğrulamayı devre dışı bırakın.

Portal için makine kullanıcısı oluşturun

Harici bir IdP etkinleştirildiğinde Edge, makine kullanıcılarının kullanımı aracılığıyla otomatik OAuth2 jetonu oluşturmayı destekler. Makine kullanıcıları, şifre kodu belirtmek zorunda kalmadan OAuth2 jetonları alabilir. Bu sayede, OAuth2 jetonları alma ve yenileme işlemini tamamen otomatikleştirebilirsiniz.

Portalın IDP yapılandırma süreci, portalla ilişkili kuruluşta otomatik olarak bir makine kullanıcısı oluşturur. Daha sonra portal, Edge'e bağlanmak için bu makine kullanıcısı hesabını kullanır. Makine kullanıcıları hakkında daha fazla bilgi için Harici IdP'ler için görevleri otomatikleştirme başlıklı makaleye bakın.

Portal geliştirici hesapları için kimlik doğrulama hakkında

Portalı harici bir IdP kullanacak şekilde yapılandırdığınızda portalın Edge'e istek gönderebilmesi için portalın Edge ile kimlik doğrulaması yapmak üzere SAML veya LDAP kullanmasına izin verirsiniz. Bununla birlikte, portal geliştiriciler adlı bir kullanıcı türünü de destekler.

Geliştiriciler, API'lerinizi kullanarak uygulama oluşturan kullanıcı topluluğunu oluşturur. Uygulama geliştiriciler API'leriniz hakkında bilgi edinmek, API'lerinizi kullanan uygulamaları kaydetmek, geliştirici topluluğuyla etkileşimde bulunmak ve uygulama kullanımlarıyla ilgili istatistiksel bilgileri bir kontrol panelinde görüntülemek için portalı kullanırlar.

Bir geliştirici portala giriş yaptığında geliştiricinin kimliğini doğrulamak ve rol tabanlı izinleri zorunlu kılmak sorumlu olan portaldır. Portal, portal ve Edge arasında IdP kimlik doğrulamasını etkinleştirmenizden sonra bile geliştiricilerle Temel kimlik doğrulamasını kullanmaya devam eder. Daha fazla bilgi için Portal ile Edge arasında iletişim kurma bölümüne bakın.

Portalı, geliştiricilerin kimliğini doğrulamak için SAML veya LDAP kullanacak şekilde yapılandırmak da mümkündür. Üçüncü taraf Drupal modüllerini kullanarak SAML'yi etkinleştirmeyle ilgili örnek için Developer Portal ile SAML üzerinden TOA Entegrasyonu bölümüne bakın.

Portal için IDP yapılandırma dosyası

Portal için harici bir IdP yapılandırmak için portalın ayarlarını tanımlayan bir yapılandırma dosyası oluşturmanız gerekir.

Aşağıdaki örnekte IDP destekli bir portal yapılandırma dosyası gösterilmektedir:

# 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

Portalda harici IdP desteğini etkinleştirmek için:

  1. Edge kullanıcı arayüzünde, DEVPORTAL_ADMIN_EMAIL tarafından belirtilen makine kullanıcısını portalla ilişkilendirilen kuruluşa Kuruluş Yöneticisi olarak ekleyin.
  2. Portalda harici IdP'yi yapılandırmak için aşağıdaki komutu yürütün: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile

    Burada configFile, yukarıda açıklanan yapılandırma dosyasıdır.

  3. Portala portal yöneticisi olarak giriş yapın.
  4. Ana Drupal menüsünde Yapılandırma > Geliştirici Portalı'nı seçin. Harici IdP ayarlarını da içeren portal yapılandırma ekranı görünür:

    Aşağıdakileri göz önünde bulundurun:

    • Bu kuruluş SAML özellikli kutusu işaretli
    • Apigee TOA modülü için uç nokta doldurulur
    • Oauth istemcisi portalının API anahtarı ve Tüketici gizli anahtarı alanları doldurulur
    • Bağlantıyı Test Et düğmesinin altında Bağlantı Başarılı mesajı görünür.
  5. Bağlantıyı istediğiniz zaman yeniden test etmek için Bağlantıyı Test Et düğmesini tıklayın.

Bu değerleri daha sonra değiştirmek için yapılandırma dosyasını güncelleyin ve bu prosedürü tekrar yürütün.

Portalda harici bir IdP'yi devre dışı bırakma

Portal ile Edge arasındaki iletişim için harici IDP'nizi devre dışı bırakmayı seçerseniz portal artık Edge'e istek yapamaz. Geliştiriciler portala giriş yapabilir ancak ürünü görüntüleyemez veya uygulama oluşturamazlar.

Portalda harici IdP kimlik doğrulamasını devre dışı bırakmak için:

  1. Harici IDP'yi etkinleştirmek için daha önce kullandığınız yapılandırma dosyasını açın.
  2. DEVPORTAL_SSO_ENABLED özelliğinin değerini aşağıdaki örnekte gösterildiği gibi n olarak ayarlayın: 
    DEVPORTAL_SSO_ENABLED=n
  3. Aşağıdaki komutu yürüterek portalı yapılandırın: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile