OAuth 認証方法の構成
OAuth 認証方法を設定するには、データを送信する各インスタンスの OAuth 認証レコード、プロデューサーおよびコンシューマーアプリケーションレジストリを作成し、ユーザー、OAuth 認証レコード、およびコンシューマーアプリケーションレジストリを スキャンエンジンを使用するインスタンスにインポートする必要があります。
始める前に
必要なロール:スキャンエンジンアドミン (sn_se.scan_engine_admin)
手順
-
ユーザー (複数可) に統合ロール (sn_se.internal_rest_integration) を割り当てるには、次の場所に移動します すべて > システムセキュリティ > ユーザーとグループ > ユーザーをクリックし、 新規 を選択します。
新しいユーザーの作成の詳細については、「 」を参照してください。
-
OAuth 認証レコードを作成するには、[
sys_auth_profile_oauth2.list] に移動し、[ 新規] を選択します。レコードが以下を実行していることを確認します。- スキャンエンジン スコープで作成されます
- ステップ 1 でユーザーに設定したものと同じユーザー名とパスワードが含まれています
-
ユーザー (ステップ 1) と OAuth 認証レコード (ステップ 2) をエクスポートし、 スキャンエンジン 統合を使用するすべてのインスタンスにインポートします。
エクスポートプロセス中にロールは転送されないため、エクスポートされたら、統合ロールを再アサインする必要があります。また、インポート/エクスポートプロセス中にパスワードフィールドが破損する可能性があるため、パスワードフィールドが正確であることを確認してください。
-
インスタンス間に正常な接続を確立するには、少なくとも 1 つのプロバイダーと 2 つのコンシューマーアプリケーションレジストリを作成する必要があります。
プロバイダーはエンドポイントとして機能します。開発インスタンスから本番インスタンスに移る接続を作成するには、本番インスタンスにプロバイダーを作成する必要があります。
対照的に、本番インスタンスから開発インスタンスに渡る接続を作成するには、開発インスタンスでプロバイダーを作成する必要があります。これらのプロバイダーは、自身を含めて、通信するすべてのインスタンスに対応するコンシューマーアプリケーションレジストリを持ちます。他の環境 (テストや Q&A など) にも同じロジックが適用されます。
-
プロバイダーアプリケーションレジストリを構成するには:
- 本番インスタンスで、次の場所に移動します すべて > システム OAuth > アプリケーションレジストリーをクリックし、 新規 を選択します。
- [外部クライアント用の OAuth API エンドポイントを作成します] を選択します。
- 新しいアプリケーションレジストリレコードフォームを構成するには、[ 名前 ] を [インスタンス名] – プロバイダーに設定し、 次にクライアントシークレットを設定します。
- [クライアント ID] と [クライアントシークレット] のエントリは、コンシューマー OAuth アプリケーションレジストリに入力するときに必要になるので、メモしておきます。
- レコードを保存します。
-
コンシューマーアプリケーションレジストリを設定します。
- 開発インスタンスで、 すべて > システム OAuth > アプリケーションレジストリーをクリックし、 新規 を選択します。
- [サードパーティ OAuth プロバイダーに接続] を選択します。
-
新しいアプリケーションレジストリレコードフォームを設定します。
- プロバイダーアプリケーションレジストリのクライアント ID とクライアントシークレットを入力します。
- OAuth API スクリプトを OAuthUtil に設定します。
- デフォルトの権限許可タイプがリソース所有者のパスワード認証情報であることを確認します。
- トークン URL を [プロバイダーインスタンス URL]/oauth_token.do に設定します。
- レコードを保存します。
-
プロバイダーインスタンスとコンシューマーインスタンス間の接続を開始します。
-
コンシューマーアプリケーションレジストリレコードをコンシューマーインスタンスにエクスポートします。
コンシューマーレコードは、プロバイダーインスタンスとコンシューマーインスタンスの両方に存在する必要があります。プロバイダー (本番) インスタンスでこの手順を開始してから、コンシューマー (開発) インスタンスで手順を完了します。重要:コンシューマーインスタンスにレコードをインポートしたら、 クライアントシークレット が以前に作成したものと一致していることを確認します。
- 移動先 すべて > 影響 > 設定 (Configuration) > スキャンエンジンのプロパティをクリックし、[ 自分の SN インスタンス ] 関連リストを開きます。
-
次のフィールドにプロバイダーインスタンスからの情報を入力します。
- インスタンス名:プロバイダーインスタンス名 (プロバイダーインスタンスの URL から派生)。
- インスタンス URL:プロバイダーインスタンスの URL。
- 環境:プロバイダーの環境タイプ。
- 認証タイプ:OAuth
- OAuth アプリケーションレジストリ:「
[プロバイダーインスタンス] – コンシューマー。 - OAuth ユーザープロファイル:以前に作成した OAuth 認証レコード。
-
レコードを保存し、 接続を検証します。
[接続ステータス] が [ 接続有効] に更新されるはずです。
-
コンシューマーアプリケーションレジストリレコードをコンシューマーインスタンスにエクスポートします。
-
[My SN] レコードをプロバイダーインスタンスにエクスポートします。
注:適切に構成するにはシステム ID が一致する必要があるため、個別に作成するのではなく、エクスポートする必要があります。
-
双方向通信で構成するすべての追加インスタンスについて OAuth 認証方法の構成 の手順 6 と 7 を繰り返しますが、準本番インスタンスをプロバイダーとして、本番インスタンスをコンシューマーとして指定します。
名前や URL などの情報は、準本番インスタンスから取得されます。
開発インスタンスでは、ステータスフィールドに [Connection Valid (接続が有効)] と表示されます。これは、セットアップが完了し、統合が双方向に移動することを示します。
注:[自分の SN インスタンス] 関連リストでインスタンスを設定する場合は、各インスタンスがそれぞれの OAuth アプリケーションレジストリに接続されていることを確認します。開発者インスタンスは、[開発者インスタンス] – コンシューマーに接続する必要があります。プロバイダーインスタンスは、[本番インスタンス] – コンシューマーに接続する必要があります。