Định cấu hình cổng thông tin để sử dụng IDP bên ngoài

Cổng dịch vụ dành cho nhà phát triển Apigee (hoặc đơn giản là cổng thông tin) đóng vai trò là ứng dụng khách của Apigee Edge. Điều này có nghĩa là cổng thông tin không hoạt động như một hệ thống độc lập. Thay vào đó, phần lớn thông tin mà cổng thông tin sử dụng thực sự được lưu trữ trên Edge. Khi cần, cổng thông tin sẽ gửi yêu cầu truy xuất thông tin từ Edge hoặc gửi thông tin đến Edge.

Cổng thông tin luôn được liên kết với một tổ chức Edge duy nhất. Khi định cấu hình cổng thông tin, bạn có thể chỉ định thông tin xác thực cơ bản (tên người dùng và mật khẩu) cho một tài khoản trong tổ chức mà cổng thông tin sử dụng để giao tiếp với Edge.

Nếu chọn bật IDP bên ngoài như SAML hoặc LDAP để xác thực Edge, thì bạn có thể định cấu hình cổng thông tin để sử dụng phương thức xác thực đó khi gửi yêu cầu đến Edge. Việc định cấu hình cổng thông tin để sử dụng IDP bên ngoài sẽ tự động tạo một tài khoản người dùng máy mới trong tổ chức Edge mà sau đó cổng thông tin sẽ sử dụng để gửi yêu cầu đến Edge. Để biết thêm thông tin về người dùng máy, hãy xem bài viết Tự động hoá các nhiệm vụ cho nhà cung cấp danh tính bên ngoài.

Để cổng thông tin hỗ trợ IDP bên ngoài, bạn phải cài đặt và định cấu hình mô-đun SSO của Apigee trên nút Máy chủ quản lý Edge. Quy trình chung để bật IDP bên ngoài cho cổng thông tin như sau:

  1. Cài đặt mô-đun SSO của Apigee, như mô tả trong phần Cài đặt và định cấu hình SSO của Apigee.
  2. Cài đặt cổng thông tin và đảm bảo rằng quá trình cài đặt của bạn hoạt động đúng cách. Xem phần Cài đặt cổng thông tin.
  3. Định cấu hình SAML hoặc LDAP trên cổng thông tin, như mô tả trong phần này.
  4. (Không bắt buộc) Tắt tính năng Xác thực cơ bản trên Edge, như mô tả trong phần Tắt tính năng Xác thực cơ bản trên Edge.

Tạo người dùng máy cho cổng thông tin

Khi bật IDP bên ngoài, Edge hỗ trợ tạo mã thông báo OAuth2 tự động thông qua việc sử dụng người dùng máy. Người dùng máy có thể lấy mã thông báo OAuth2 mà không cần chỉ định mật mã. Điều này có nghĩa là bạn có thể tự động hoá hoàn toàn quy trình lấy và làm mới mã thông báo OAuth2.

Quy trình định cấu hình IDP cho cổng thông tin sẽ tự động tạo một người dùng máy trong tổ chức liên kết với cổng thông tin đó. Sau đó, cổng thông tin sẽ sử dụng tài khoản người dùng máy này để kết nối với Edge. Để biết thêm thông tin về người dùng máy, hãy xem bài viết Tự động hoá các tác vụ cho nhà cung cấp danh tính bên ngoài.

Giới thiệu về quy trình xác thực cho tài khoản nhà phát triển trên cổng thông tin

Khi định cấu hình cổng thông tin để sử dụng IDP bên ngoài, bạn cho phép cổng thông tin sử dụng SAML hoặc LDAP để xác thực với Edge, nhờ đó cổng thông tin có thể gửi yêu cầu đến Edge. Tuy nhiên, cổng thông tin này cũng hỗ trợ một loại người dùng gọi là nhà phát triển.

Nhà phát triển tạo nên cộng đồng người dùng xây dựng ứng dụng bằng cách sử dụng API của bạn. Nhà phát triển ứng dụng sử dụng cổng thông tin này để tìm hiểu về API của bạn, đăng ký ứng dụng sử dụng API của bạn, tương tác với cộng đồng nhà phát triển và xem thông tin thống kê về mức sử dụng ứng dụng của họ trên một trang tổng quan.

Khi nhà phát triển đăng nhập vào cổng thông tin, cổng thông tin sẽ chịu trách nhiệm xác thực nhà phát triển và thực thi các quyền dựa trên vai trò. Cổng thông tin tiếp tục sử dụng phương thức Xác thực cơ bản với nhà phát triển ngay cả sau khi bạn bật tính năng xác thực IDP giữa cổng thông tin và Edge. Để biết thêm thông tin, hãy xem phần Giao tiếp giữa cổng thông tin và Edge.

Bạn cũng có thể định cấu hình cổng thông tin để sử dụng SAML hoặc LDAP nhằm xác thực nhà phát triển. Để xem ví dụ về cách bật SAML bằng các mô-đun Drupal của bên thứ ba, hãy xem bài viết Tích hợp SSO qua SAML với Cổng thông tin cho nhà phát triển.

Tệp cấu hình IDP cho cổng thông tin

Để định cấu hình IDP bên ngoài cho cổng thông tin, bạn phải tạo một tệp cấu hình xác định chế độ cài đặt của cổng thông tin.

Ví dụ sau đây cho thấy một tệp cấu hình cổng thông tin có hỗ trợ 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

Cách bật tính năng hỗ trợ nhà cung cấp danh tính (IdP) bên ngoài trên cổng thông tin:

  1. Trong giao diện người dùng Edge, hãy thêm người dùng máy do DEVPORTAL_ADMIN_EMAIL chỉ định vào tổ chức liên kết với cổng thông tin với tư cách là Quản trị viên tổ chức.
  2. Thực thi lệnh sau để định cấu hình IDP bên ngoài trên cổng thông tin: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile

    Trong đó, configFile là tệp cấu hình được mô tả ở trên.

  3. Đăng nhập vào cổng thông tin với tư cách là quản trị viên cổng thông tin.
  4. Trong trình đơn chính của Drupal, hãy chọn Configuration > Dev Portal (Cấu hình > Cổng thông tin cho nhà phát triển). Màn hình cấu hình cổng thông tin sẽ xuất hiện, bao gồm cả chế độ cài đặt IDP bên ngoài:

    Xin lưu ý những điều sau:

    • Hộp Tổ chức này đã bật SAML được đánh dấu
    • Điểm cuối cho mô-đun SSO của Apigee đã được điền sẵn
    • Các trường Khoá API và Khoá bí mật của người dùng cho ứng dụng OAuth của cổng thông tin đã được điền sẵn
    • Thông báo Kết nối thành công sẽ xuất hiện bên dưới nút Kiểm tra kết nối.
  5. Nhấp vào nút Test Connection (Kiểm tra kết nối) để kiểm tra lại kết nối bất cứ lúc nào.

Để thay đổi các giá trị này sau, hãy cập nhật tệp cấu hình và thực hiện lại quy trình này.

Tắt nhà cung cấp danh tính (IDP) bên ngoài trên cổng thông tin

Nếu bạn chọn tắt IDP bên ngoài để liên lạc giữa cổng thông tin và Edge, thì cổng thông tin sẽ không thể gửi yêu cầu đến Edge nữa. Nhà phát triển có thể đăng nhập vào cổng thông tin nhưng sẽ không thể xem sản phẩm hoặc tạo ứng dụng.

Cách tắt tính năng xác thực bằng IDP bên ngoài trên cổng thông tin:

  1. Mở tệp cấu hình mà bạn đã dùng trước đó để bật IDP bên ngoài.
  2. Đặt giá trị của thuộc tính DEVPORTAL_SSO_ENABLED thành n, như trong ví dụ sau: 
    DEVPORTAL_SSO_ENABLED=n
  3. Định cấu hình cổng thông tin bằng cách thực thi lệnh sau: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile