apigee-ssoadminapi.sh を使用する

Apigee SSO モジュールでは、次の 2 種類のアカウントがサポートされています。

apigee-ssoadminapi.sh ユーティリティを使用すると、管理者とマシンを管理できます。 ユーザー アカウントも付与されています。

apigee-ssoadminapi.sh ユーティリティを使用して、次のことを行います。

  • 管理者/マシンユーザーのリストを表示する
  • 管理者/マシンユーザーを追加または削除する
  • 管理者/マシンユーザーのパスワードを変更する

管理者ユーザーについて

Apigee SSO モジュールの管理者アカウントのプロパティを管理するには、 説明します。

デフォルトでは、Apigee SSO モジュールをインストールすると、 次の認証情報が必要です。

  • username: SSO_ADMIN_NAME 構成ファイルを定義します。デフォルトは ssoadmin. です。
  • password: オブジェクトの SSO_ADMIN_SECRET プロパティで定義されます。 構成ファイルを定義します。

マシンユーザーについて

マシンユーザーは、パスコードを指定しなくても OAuth2 トークンを取得できます。つまり、 Edge を使用して OAuth2 トークンを取得および更新するプロセスを完全に自動化できます。 管理 API を使用できます。

通常、マシンユーザーは次の目的で使用します。

  • Edge と通信するように Apigee Developer Services ポータル（略して「ポータル」）を構成する
  • 開発環境で、一般的な開発タスクの自動化をサポートしている場合（テスト、 CI/CD を使用します。

詳細については、外部 IDP のタスクを自動化するをご覧ください。

apigee-ssoadminapi.sh のインストール

Edge Management Server ノードに apigee-ssoadminapi.sh ユーティリティをインストールします。 Apigee SSO モジュールをインストールします。通常は、 apigee-ssoadminapi.sh ユーティリティ。

apigee-ssoadminapi.sh ユーティリティをまだインストールしていない場合:

  1. Management Server ノードにログインします。このノードには、すでにマシンが apigee-service をインストール済み Edge apigee-setup ユーティリティをインストールします。
  2. 管理者とマシンの管理に使用する apigee-ssoadminapi.sh ユーティリティをインストールします。 ユーザーを追加するには、次のコマンドを実行します。 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. シェルからログアウトし、再度ログインして apigee-ssoadminapi.sh ユーティリティをパスに追加します。

のヘルプ情報を表示する apigee-ssoadminapi.sh

このユーティリティで使用できるコマンドは次のとおりです。

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add（次を含むすべての IdP に saml コマンドを使用します。 LDAP と SAML）
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword
で確認できます。

これらのコマンドに関する情報は、 /opt/apigee/apigee-ssoadminapi/README.md ファイル。さらに、kubectl の 「-h」オプションを追加して使用状況の情報を表示することもできます。

たとえば、次のコマンドを実行します。

apigee-ssoadminapi.sh admin list -h

戻り値:

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

apigee-ssoadminapi.sh ユーティリティを呼び出す

apigee-ssoadminapi.sh ユーティリティを呼び出すには、すべてのプロパティを プロンプトに応答することでインタラクティブ モードで実行することもできます。

たとえば、コマンドラインで必要なすべての情報を指定して、 ユーザー:

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

戻り値:

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

管理者パスワードなどの必要な情報を省略すると、入力を求めるメッセージが表示されます。

この例では、--port と --ssl の値を省略しています。これは、次のためです。 Apigee SSO モジュールでは、--port にはデフォルト値の 9099、 --ssl。インストールでこれらのデフォルトを使用しない場合は、指定してください。

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

または、すべての情報を求めるインタラクティブ フォームを使用します。

apigee-ssoadminapi.sh admin list

その後、必要な情報をすべて入力するよう求められます。

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