apigee-ssoadminapi.sh を使用する

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

apigee-ssoadminapi.sh ユーティリティを使用すると、Apigee SSO モジュールに関連付けられている管理者アカウントとマシン ユーザー アカウントを管理できます。

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

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

管理者ユーザーについて

モジュールのプロパティを管理するには、Apigee SSO モジュールの管理者アカウントが必要です。

デフォルトでは、Apigee SSO モジュールをインストールすると、次の認証情報を持つ管理者アカウントが作成されます。

  • username: Apigee SSO モジュールの構成に使用される構成ファイルの SSO_ADMIN_NAME プロパティで定義されます。デフォルト値は ssoadmin. です。
  • password: Apigee SSO モジュールの構成に使用される構成ファイルの SSO_ADMIN_SECRET プロパティで定義されます。

マシンユーザーについて

マシンユーザーは、パスコードを指定せずに OAuth2 トークンを取得できます。つまり、Edge Management API を使用して、OAuth2 トークンの取得と更新のプロセスを完全に自動化できます。

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

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

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

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

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

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

  1. Management Server ノードにログインします。Edge apigee-setup ユーティリティのインストールの説明に沿って、そのノードに apigee-service がすでにインストールされている必要があります。
  2. 次のコマンドを実行して、Apigee SSO モジュールの管理者ユーザーとマシンユーザーの管理に使用する 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（LDAP や SAML を含むすべての IDP に saml コマンドを使用）
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

これらのコマンドに関する情報は、/opt/apigee/apigee-ssoadminapi/README.md ファイルで確認できます。また、各コマンドに「-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 に http を使用するためです。インストールでこれらのデフォルトを使用しない場合は、次のように指定します。

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