Sử dụng apigee-ssoadminapi.sh

Edge for Private Cloud phiên bản 4.18.05

Mô-đun SSO của Edge hỗ trợ 2 loại tài khoản:

  • quản trị viên
  • người dùng máy

Tiện ích apigee-ssoadminapi.sh giúp bạn quản lý người quản trị và máy người dùng liên quan đến mô-đun SSO của Edge.

Sử dụng tiện ích apigee-ssoadminapi.sh để:

  • Xem danh sách quản trị viên/người dùng máy
  • Thêm hoặc xoá quản trị viên/người dùng máy
  • Thay đổi mật khẩu của quản trị viên/người dùng máy

Giới thiệu về người dùng quản trị

Bạn cần có tài khoản quản trị viên trong mô-đun SSO của Edge để quản lý các thuộc tính của .

Theo mặc định, khi bạn cài đặt mô-đun SSO của Edge sẽ tạo tài khoản quản trị viên bằng các thông tin xác thực sau:

  • username: được xác định bởi thuộc tính SSO_ADMIN_NAME trong tệp cấu hình được dùng để định cấu hình mô-đun SSO của cạnh. Giá trị mặc định là ssoadmin.
  • password (mật khẩu): do thuộc tính SSO_ADMIN_SECRET xác định trong tệp cấu hình được dùng để định cấu hình mô-đun SSO của cạnh.

Giới thiệu về 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 mã thông báo OAuth2 bằng cách sử dụng Edge API Quản lý của chúng tôi.

Bạn thường sử dụng người dùng máy cho:

  • Định cấu hình cổng Dịch vụ dành cho nhà phát triển Apigee (hoặc đơn giản là cổng) để giao tiếp với Edge
  • Khi môi trường phát triển hỗ trợ tính năng tự động hoá cho các tác vụ phát triển phổ biến, chẳng hạn như kiểm thử tự động hoá hoặc Tích hợp liên tục/Triển khai liên tục (CI/CD).

Để biết thêm thông tin, hãy xem phần Sử dụng SAML với thao tác tự động.

Cài đặt apigee-ssoadminapi.sh

Cài đặt tiện ích apigee-ssoadminapi.sh trên nút Máy chủ quản lý Edge nơi bạn đã cài đặt mô-đun SSO của cạnh. Thông thường, bạn cài đặt Tiện ích apigee-ssoadminapi.sh khi bạn cài đặt mô-đun SSO của Edge.

Nếu bạn chưa cài đặt tiện ích apigee-ssoadminapi.sh:

  1. Đăng nhập vào nút Máy chủ quản lý. Nút đó phải có apigee-service đã được cài đặt như mô tả tại Cài đặt trình thiết lập apigee của Edge tiện ích.
  2. Cài đặt tiện ích apigee-ssoadminapi.sh dùng để quản lý quản trị viên và người dùng máy đối với mô-đun SSO của cạnh: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Đăng xuất khỏi shell và sau đó đăng nhập lại để thêm Tiện ích apigee-ssoadminapi.sh đến đường dẫn của bạn.

Xem thông tin trợ giúp cho apigee-ssoadminapi.sh

Sau đây là các lệnh có thể dùng cho phần mềm tiện ích này:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Bạn có thể xem thông tin về các lệnh này trong /opt/apigee/apigee-ssoadminapi/README.md . Ngoài ra, bạn có thể chỉ định "-h" vào mỗi lệnh để xem thông tin về mức sử dụng.

Ví dụ: lệnh sau:

apigee-ssoadminapi.sh admin list -h

Trả về:

admin list
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

Gọi tiện ích apigee-ssoadminapi.sh

Bạn có thể gọi tiện ích apigee-ssoadminapi.sh bằng cách truyền tất cả các thuộc tính dưới dạng đối số của dòng lệnh hoặc ở chế độ tương tác bằng cách phản hồi các lời nhắc.

Ví dụ: để chỉ định tất cả thông tin bắt buộc trên dòng lệnh để xem danh sách quản trị viên người dùng:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

Trả về:

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

Nếu bỏ qua bất kỳ thông tin bắt buộc nào, chẳng hạn như mật khẩu quản trị viên, thì bạn sẽ được nhắc.

Trong ví dụ này, bạn bỏ qua các giá trị cho --port và --ssl vì mô-đun SSO của Edge sử dụng giá trị mặc định là 9099 cho --port và http cho --ssl. Nếu quá trình cài đặt của bạn không sử dụng các giá trị mặc định này, hãy chỉ định chúng:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123
  --host 35.197.94.184 --port 9443 --ssl https

Ngoài ra, hãy sử dụng biểu mẫu tương tác nơi bạn được nhắc cung cấp tất cả thông tin:

apigee-ssoadminapi.sh admin list

Sau đó, bạn sẽ được nhắc cung cấp tất cả thông tin bắt buộc:

SSO admin name (current): ssoadmin
SSO Admin secret (current):
SSO host: 35.197.94.184