Đị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) đóng vai trò là một khách hàng của Apigee Edge. Điều đó 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 được cổng thông tin sử dụng thực sự được lưu trữ trên Edge. Khi cần thiết, cổng thông tin sẽ thực hiện yêu cầu truy xuất thông tin từ Edge hoặc để gửi thông tin tới 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 bạn định cấu hình phần 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 trong tổ chức mà cổng thông tin dùng để giao tiếp với Edge.

Nếu bạn chọn bật IDP bên ngoài như SAML hoặc LDAP cho phương thức xác thực Edge, thì bạn có thể định cấu hình cổng thông tin để sử dụng xác thực đó khi gửi yêu cầu đến Edge. Định cấu hình cổng thông tin để sử dụng nhà cung cấp danh tính (IDP) bên ngoài 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 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 Tự động hoá các thao tác cho nhà cung cấp danh tính bên ngoài.

Hỗ trợ IDP bên ngoài cho cổng thông tin yêu cầu bạn đã cài đặt và định cấu hình Mô-đun Đăng nhập một lần (SSO) của Apigee trên nút Máy chủ quản lý máy tính biên. Quy trình chung để bật IDP của 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 dịch vụ SSO của Apigee nếu có lưu lượng truy cập cao.
  2. Cài đặt cổng thông tin và đảm bảo rằng quá trình cài đặt đang diễn ra đúng cách. Xem Cài đặt cổng thông tin.
  3. Định cấu hình SAML hoặc Giao thức truy cập thư mục hạng nhẹ (LDAP) trên cổng thông tin, như được 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 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ạn bật một IDP bên ngoài, Edge sẽ hỗ trợ việc 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 đó 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 OAuth2 mã thông báo.

Quy trình cấu hình IDP cho cổng sẽ tự động tạo 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ử dụng tài khoản người dùng trên 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 phần Tự động hoá nhiệm vụ cho nhà cung cấp danh tính bên ngoài.

Giới thiệu về tính năng xác thực dành cho nhà phát triển cổng thông tin tài khoản

Khi định cấu hình cổng thông tin để dùng IDP bên ngoài, thì bạn sẽ bật cổng thông tin để sử dụng một trong hai SAML hoặc LDAP để xác thực với Edge để cổng thông tin có thể gửi yêu cầu đến Edge. Tuy nhiên, cổng thông tin cũng hỗ trợ loại người dùng có tên 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 để tìm hiểu về API, để đăng ký ứng dụng sử dụng API, tương tác với cộng đồng nhà phát triển cũng như để xem thông tin thống kê về mức sử dụng ứng dụng của họ trên bảng điều khiển.

Khi nhà phát triển đăng nhập vào cổng thông tin, đó chính là cổng chịu trách nhiệm cho 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 sẽ tiếp tục sử dụng Xác thực cơ bản với các nhà phát triển ngay cả sau khi bạn bật xác thực IDP giữa Portal và Edge. Để biết thêm thông tin, hãy xem bài viết Giao tiếp giữa Portal 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. Cho ví dụ về cách bật SAML bằng các mô-đun Drupal của bên thứ ba, hãy xem Tích hợp SSO qua SAML với Cổng dành cho nhà phát triển.

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

Để định cấu hình một 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 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 dịch vụ 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 Cấu hình > Cổng thông tin cho nhà phát triển. Cổng thông tin màn hình cấu hình 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 hỗ trợ SAML được đánh dấu
    • Hệ thống đã điền điểm cuối cho mô-đun SSO của Apigee
    • Trường Khoá API và Thông tin mật của người dùng cho đã điền ứng dụng OAuth
    • Thông báo Connection Success (Kết nối thành công) xuất hiện trong cửa sổ Test Nút kết nối.
  5. Nhấp vào nút Kiểm tra kết nối để kiểm tra lại kết nối tại bất cứ lúc nào.

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

Tắt 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 của mình khi có hoạt động giao tiếp giữa cổng thông tin và Edge, cổng thông tin sẽ không thể gửi yêu cầu tới Edge nữa. Nhà phát triển có thể đăng nhập vào cổng thông tin nhưng 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 IDP bên ngoài trên cổng thông tin:

  1. Mở tệp cấu hình mà bạn đã sử 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, dưới dạng ví dụ sau đây cho thấy: 
    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