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

Apigee Developer Services portalı (veya kısaca portal), Apigee Edge'in istemcisi olarak çalışır. Yani portal, bağımsız bir sistem olarak çalışmaz. Bunun yerine, portal tarafından kullanılan bilgilerin çoğu aslında Edge'de depolanır. 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, portalın Edge ile iletişim kurmak için kullandığı kuruluştaki bir hesabın temel kimlik doğrulama 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 istek gönderirken bu kimlik doğrulamasını kullanacak şekilde yapılandırabilirsiniz. Portalı harici bir IdP kullanacak şekilde yapılandırdığınızda Edge kuruluşunda otomatik olarak yeni bir makine kullanıcı hesabı oluşturulur. Portal, Edge'e istek göndermek için bu hesabı 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ı makaleyi inceleyin.

Portal için harici IdP desteği, Edge Yönetim Sunucusu düğümüne Apigee TOA modülünü yükleyip yapılandırmış olmanızı gerektirir. Portal için harici bir IdP'yi etkinleştirmeyle ilgili genel süreç aşağıdaki gibidir:

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

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

Harici bir IdP etkinleştirildiğinde Edge, makine kullanıcıları 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ını alma ve yenileme sürecini tamamen otomatikleştirebilirsiniz.

Portal için IdP yapılandırma işlemi, portalla ilişkili kuruluşta otomatik olarak bir makine kullanıcısı oluşturur. Portal daha sonra Edge'e bağlanmak için bu makine kullanıcı 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ı makaleyi inceleyin.

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'de kimlik doğrulaması yapmak için SAML veya LDAP kullanmasını sağlarsınız. Böylece portal, Edge'e istek gönderebilir. Ancak portal, geliştiriciler adı verilen bir kullanıcı türünü de destekler.

Geliştiriciler, API'lerinizi kullanarak uygulama geliştiren 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şim kurmak ve uygulama kullanımlarıyla ilgili istatistiksel bilgileri bir kontrol panelinde görüntülemek için portalı kullanır.

Bir geliştirici portalda oturum açtığında geliştiricinin kimliğini doğrulamaktan ve role dayalı izinleri uygulamaktan portal sorumludur. Portal, portal ile Edge arasında IDP kimlik doğrulamasını etkinleştirseniz bile geliştiricilerle temel kimlik doğrulamasını kullanmaya devam eder. Daha fazla bilgi için Portal ile Edge arasında iletişim kurma başlıklı makaleyi inceleyin.

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 bir örnek için Geliştirici Portalı ile SAML Üzerinden TOA Entegrasyonu başlıklı makaleyi inceleyin.

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

Portal için harici bir IdP yapılandırmak istiyorsanız 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şkili kuruluşa Kuruluş Yöneticisi olarak ekleyin.
  2. Portalda harici IdP'yi yapılandırmak için aşağıdaki komutu çalıştırın: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile

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

  3. Portalda portal yöneticisi olarak oturum açın.
  4. Ana Drupal menüsünde Configuration > Dev Portal'ı (Yapılandırma > Geliştirici Portalı) seçin. Harici IdP ayarlarını içeren portal yapılandırma ekranı görünür:

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

    • This org is SAML-enabled (Bu kuruluşta SAML etkin) kutusu işaretlenir.
    • Apigee TOA modülünün uç noktası doldurulur.
    • Portal OAuth istemcisinin 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 uygulayı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 gönderemez. Geliştiriciler portala giriş yapabilir ancak ürünleri görüntüleyemez veya uygulama oluşturamaz.

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. Aşağıdaki örnekte gösterildiği gibi DEVPORTAL_SSO_ENABLED özelliğinin değerini n olarak ayarlayın: 
    DEVPORTAL_SSO_ENABLED=n
  3. Aşağıdaki komutu çalıştırarak portalı yapılandırın: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile