apigee-ssoadminapi.sh の使用

Edge for Private Cloud v4.19.01

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

  • 管理者
  • マシンユーザー(SAML のみ)

apigee-ssoadminapi.sh ユーティリティを使用すると、管理者とマシンを管理できます。 ユーザーをサポートしています。

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

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

管理者ユーザーについて

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

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

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

マシンユーザーについて

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

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

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

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

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

Edge Management Server ノードに apigee-ssoadminapi.sh ユーティリティをインストールします。 Edge 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
  • 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 にはデフォルト値の 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