apigee-ssoadminapi.sh の使用

Edge for Private Cloud v4.18.05

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

• 管理者
• マシンユーザー

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

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

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

管理者ユーザーについて

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

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

• ユーザー名: Edge SSO モジュールの構成に使用する構成ファイル内の SSO_ADMIN_NAME プロパティで定義されます。デフォルトは ssoadmin. です。
• password: Edge SSO モジュールの構成に使用される構成ファイルの SSO_ADMIN_SECRET プロパティによって定義されます。

マシンユーザーについて

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

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

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

詳しくは、SAML と自動タスクの使用をご覧ください。

apigee-ssoadminapi.sh をインストールする

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

apigee-ssoadminapi.sh ユーティリティをまだインストールしていない場合は、次のコマンドを実行します。

1. Management Server ノードにログインします。Edge apigee-setup ユーティリティのインストールの説明に従って、そのノードにはすでに apigee-service がインストールされています。
2. Edge 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
• 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 の値は省略されています。Edge SSO モジュールは、--port と --ssl に対してそれぞれデフォルト値の 9099 と 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