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ợ hai loại tài khoản:

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

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

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

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

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

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

Theo mặc định, khi bạn cài đặt mô-đun SSO của Edge, mô-đun này sẽ tạo một tài khoản quản trị viên có thông tin đăng nhập sau:

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

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 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 bằng cách sử dụng API quản lý Edge.

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

  • Định cấu hình cổng thông tin Dịch vụ dành cho nhà phát triển của Apigee (hoặc đơn giản là cổng thông tin) để giao tiếp với Edge
  • Khi môi trường phát triển hỗ trợ 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ặ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 bài viết Sử dụng SAML với các tác vụ tự động.

Đang 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 Edge. Thông thường, bạn sẽ cài đặt tiện ích apigee-ssoadminapi.sh khi 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 cài đặt apigee-service như mô tả trong phần Cài đặt tiện ích apigee-setup của Edge.
  2. Cài đặt tiện ích apigee-ssoadminapi.sh dùng để quản lý người dùng quản trị và người dùng máy cho mô-đun SSO của Edge: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Đăng xuất khỏi shell, sau đó đăng nhập lại để thêm tiện ích apigee-ssoadminapi.sh vào đường dẫn của bạn.

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

Các lệnh có sẵn cho tiện ích này là:

  • 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 tệp /opt/apigee/apigee-ssoadminapi/README.md. Ngoài ra, bạn có thể chỉ định tuỳ chọn "-h" cho mỗi lệnh để xem thông tin về việ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ả thuộc tính dưới dạng đối số dòng lệnh hoặc ở chế độ tương tác bằng cách phản hồi lời nhắc.

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

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ạn 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, 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 các giá trị mặc định là 9099 cho --port và http cho --ssl. Nếu bản 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 các giá trị đó:

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

Ngoài ra, bạn có thể sử dụng biểu mẫu tương tác, trong đó 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