このページは Cloud Translation API によって翻訳されました。

apigee-ssoadminapi.sh の使用

Edge for Private Cloud v4.18.01

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

管理者
マシンユーザー

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

apigee-ssoadminapi.sh ユーティリティを使用すると、次の操作を行うことができます。

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

管理者ユーザーについて

Edge SSO モジュールのプロパティを管理するには、このモジュールの管理者アカウントが必要です。また、API BaaS またはモジュールに接続するポータルを構成するには、管理者アカウントの認証情報も必要です。

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

username: Google Cloud コンソールの SSO_ADMIN_NAME プロパティで定義されます。構成ファイルを定義します。デフォルトは ssoadmin. です。
パスワード: Edge SSO モジュールの構成に使用する構成ファイル内の SSO_ADMIN_SECRET プロパティで定義されます。

マシンユーザーについて

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

通常、マシンユーザーは次の場合に使用します。

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

詳細については、自動タスクでの SAML の使用をご覧ください。

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

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

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

Management Server ノードにログインします。このノードには、次の説明に従って apigee-service がすでにインストールされている Edge apigee-setup をインストールするユーティリティです。
Edge SSO モジュールの管理者とマシンユーザーを管理するために使用する apigee-ssoadminapi.sh ユーティリティをインストールします。
> /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
シェルからログアウトし、再度ログインして apigee-ssoadminapi.sh ユーティリティをパスに追加します。

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

このユーティリティでは、次のコマンドを使用できます。

管理者による追加
管理者による削除
管理者リスト
管理者設定パスワード
SAML マシンユーザーの追加
SAML マシンユーザーの削除
aaml machineuser list
SAML マシンユーザーの 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 には 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