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.
です。 - パスワード: Edge SSO モジュールの構成に使用する構成ファイル内の
SSO_ADMIN_SECRET
プロパティで定義されます。
マシンユーザーについて
マシンユーザーは、パスコードを指定しなくても OAuth2 トークンを取得できます。つまり、Edge Management API を使用すると、OAuth2 トークンの取得と更新のプロセスを完全に自動化できます。
通常、マシンユーザーは次の目的で使用します。
- Edge と通信するための Apigee Developer Services ポータル(略して「ポータル」)を構成する
- 開発環境が、テストの自動化や継続的インテグレーション/継続的デプロイ(CI/CD)などの一般的な開発タスクの自動化をサポートしている場合。
詳細については、自動タスクでの SAML の使用をご覧ください。
apigee-ssoadminapi.sh のインストール
Edge SSO モジュールをインストールした Edge Management Server ノードに apigee-ssoadminapi.sh
ユーティリティをインストールします。通常は、Edge SSO モジュールのインストール時に apigee-ssoadminapi.sh
ユーティリティをインストールします。
apigee-ssoadminapi.sh
ユーティリティをまだインストールしていない場合:
- Management Server ノードにログインします。このノードには、Edge apigee-setup ユーティリティのインストールの説明に従って、
apigee-service
がすでにインストールされているはずです。 - Edge SSO モジュールの管理者とマシンユーザーの管理に使用する
apigee-ssoadminapi.sh
ユーティリティをインストールします。/opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
- シェルからログアウトして再度ログインし、
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 } ]
管理者パスワードなど、必要な情報を省略すると、入力を求められます。
この例では、Edge SSO モジュールは --port
にデフォルト値の 9099、--ssl
に http を使用するため、--port
と --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