OAuthプロバイダー

OAuth 2.0サポート（REST API認証）

OAuthプロバイダーをApplications Managerで設定することにより、
アクセストークンを作成し、REST API監視でOAuth2.0によって保護されたAPIエンドポイントを認証するために使用することができます。
以下の3つのタイプをサポートしています。

  • 認可コード
  • クライアント認証情報
  • リソースオーナーの認証情報

REST APIエンドポイントでOAuthトークンを使用して認証を行う場合には、以下の手順でOAuthプロバイダーを設定します。


OAuthプロバイダー設定手順

  1. ［設定］→［ディスカバリとデータ収集］→［OAuthプロバイダー］画面を表示し、［OAuthプロバイダーを追加する］をクリック
  2. プロバイダー名を入力
    OAuthプロバイダーの名前を入力します。
  3. 付与タイプを選択
    認可コード、クライアント認証情報、リソースオーナーの認証情報の中から選択
    ※選択する付与タイプに応じて、以降の設定項目が異なります。
    • ［認可コード］を選択した場合、以下の各項目を入力します。
      ・リダイレクトURI
      ・クライアントID
      ・クライアントシークレット
      ・認可エンドポイントURL
      ・スコープ
      ・クエリパラメーター
      ・トークンエンドポイントURL
      ・トークンリクエストメソッド（Basic認証/POSTリクエストbody）
      ・リクエストbody
      ・認証リクエストメソッド（Basic認証/POSTリクエストbody）
      OAuthプロバイダー
    • ［クライアント認証情報］を選択した場合、以下の各項目を入力します。
      ・クライアントID
      ・クライアントシークレット
      ・スコープ
      ・トークンエンドポイントURL
      ・トークンリクエストメソッド（Basic認証/POSTリクエストbody）
      ・リクエストbody
      ・認証リクエストメソッド（Basic認証/POSTリクエストbody）
      OAuthプロバイダー
    • ［リソースオーナーの認証情報］を選択した場合、以下の各項目を入力します。
      ・クライアントID
      ・クライアントシークレット
      ・スコープ
      ・トークンエンドポイントURL
      ・トークンリクエストメソッド（Basic認証/POSTリクエストbody）
      ・リクエストbody
      ・リソースオーナーの認証情報
      ・認証リクエストメソッド（Basic認証/POSTリクエストbody）
      OAuthプロバイダー
  4. 各種設定項目を入力後［認可］をクリックし、プロバイダー情報を保存
  • クライアントIDとクライアントシークレット：
    Applications Managerをクライアントとして登録する際に、OAuthプロバイダーから受信する一意の英数字文字列
  • 認可エンドポイントURL：
    OAuthプロバイダーのAPI認可エンドポイント
  • スコープ：
    Applications ManagerがREST APiリソースへのアクセスを要求するために必要なOAuthスコープ。監視中に必要となるアクセスレベルに応じて、複数のスコープを指定できます。
  • クエリパラメーター：
    「redirect_uri」や「response_type」などの標準パラメーターに加え、認可エンドポイントURLに必要なクエリパラメーター
  • トークンリクエストメソッド：
    アクセストークンを取得するために、クライアントIDとシークレットを送信するメソッド
    Basic認証ではデータを認可ヘッダーとして送信し、POSTリクエストbodyではPOSTペイロードとして送信します。

プロバイダー情報を設定すると、［OAuthプロバイダー］一覧に以下の各情報が表示されます。

  • プロバイダー名：
    利用中のOAuthプロバイダー（IdP）名
  • アクセストークン：
    APIにアクセスるために使用する文字列またはJSON Webトークン
  • リフレッシュトークン：
    アクセストークンを新たに取得する際に使用する認証情報
  • アクセストークン有効期限：
    アクセストークンの有効日時