OAuth 接続の作成

Control Room 管理者は、ユーザーに対して OAuth 接続を作成して、認証の詳細を入力しなくてもパッケージの認証アクションでその接続を使用できるようにすることができます。

注: Salesforce のマークとロゴ、Microsoft SharePoint のマークとロゴ、Apigee のマークとロゴ、ServiceNow のマークとロゴ、Genesys のマークとロゴは、それぞれ Salesforce, Inc.、Microsoft Corp.、Google LLC、ServiceNow, Inc.、Genesys の商標または登録商標であり、識別のみを目的として使用されています。

前提条件

  • [OAuth 接続] 機能に対して [接続をマネージ] オプションが有効になっているユーザー ロールを使用していることを確認してください。「ロールに対する機能のアクセス許可」を参照してください。
  • エンタープライズ アプリケーションを構成しており、クライアント ID、クライアント シークレット、認証 URL、トークン URL、範囲を記録していることを確認してください。「エンタープライズ アプリケーションを構成する」を参照してください。

    次の表は、サポートされるエンタープライズ アプリケーションの認証 URL、トークン URL、範囲の形式を示しています。

    エンタープライズ アプリケーション 認可 URL トークン URL 範囲
    Apigee https://accounts.google.com/o/oauth2/auth?prompt=consent&access_type=offline https://accounts.google.com/o/oauth2/token https://www.googleapis.com/auth/cloud-platform
    Genesys https://login.<yourinstance>.pure.cloud/oauth/authorize https://login.<yourinstance>.pure.cloud/oauth/token 不要
    Salesforce https://<yourinstance>.salesforce.com/services/oauth2/authorize https://<yourinstance>.salesforce.com/services/oauth2/token api、refresh_token、offline_access
    ServiceNow https://<yourinstance>.service-now.com/oauth_auth.do https://<yourinstance>.service-now.com/oauth_token.do 不要
    SharePoint https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token https://<ドメイン名>/AllSites.Manage, offline_access, openid
    Google パッケージ (カレンダー、ドライブ、シート) https://accounts.google.com/o/oauth2/auth?prompt=consent&access_type=offline https://oauth2.googleapis.com/token
    • Google シート https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/spreadsheets
    • Google ドライブ https://www.googleapis.com/auth/drive
    • Google カレンダー https://www.googleapis.com/auth/calendar
注: 有効時間が長く構成されている更新トークンを使用することをお勧めします。

接続を作成するには次の手順を実行します。

手順

  1. [マネージ] > [OAuth 接続] に移動します。
  2. [接続の作成] をクリックします。
    [接続設定] 画面が表示されます。
  3. [プロバイダー タイプ] を選択します。
    注: [コールバック URL] は、Control Room に接続するためにエンタープライズ アプリケーションの構成設定で使用されます。
  4. 接続を識別するために、一意の [接続名] を入力します。
  5. オプション: 接続の [説明] を入力します。
    OAuth 接続の設定ページを表示した画像
  6. [次へ] をクリックします。
    [認証の詳細] 画面が表示されます。
  7. [認可タイプ] を選択します。
    Google Cloud Platform (GCP) アカウント用に設定する場合は、[認証コード フロー] を選択してください。Google Cloud Platform (GCP) は、PKCE による認証コード フローをサポートしていません。
  8. プロバイダーから提供された、お客様のアカウントの [クライアント ID] を入力してください。
  9. プロバイダーから提供された、お客様のアカウントの [クライアント シークレット] を入力してください。
  10. アカウントの認可コードを取得するための [認可 URL] を入力します。
    注: Apigee または Google Cloud Platform (GCP) アカウントの場合、認可 URL に &access_type=offline を追加する必要があります。次に例を示します。https://accounts.google.com/o/oauth2/v2/auth?prompt=consent&access_type=offline。
  11. 認可コードとアクセス トークンを交換するときに使用する [トークン URL] を入力します。
  12. オプション: [範囲] を入力します。
    OAuth 認証の詳細ページを表示した画像
    この情報は、アクセス トークンの請求 (ユーザーに関する情報) として使用され、リソース サーバーに転送され、アクセスを制限します。
    注: 複数の範囲を追加する場合は、区切り文字のカンマまたはスペースを使用して区切ってください。
  13. [次へ] をクリックします。
    [接続をテストして資格情報を保存] 画面が表示されます。
  14. オプション: [ログイン資格情報を保存] を選択します。
    注: このオプションは、共有トークンを生成して、ユーザー認証と同意を必要とすることなく、ユーザーがこの接続を使用できるようにする場合にのみ使用します。このオプションを選択する場合、この接続を使用する際に [共有] トークン タイプ オプションを選択する必要があります。「Control Room で OAuth 接続を構成する」を参照してください。
  15. オプション: [変更を保存して接続をテスト] をクリックします。
    OAuth テスト接続と認証情報の保存ページを表示した画像
    注: [変更を保存して接続をテスト] オプションをクリックした後、接続に成功した場合、[次へ] ボタンは無効になります。[戻る] ボタンをクリックし、再度 [クライアント シークレット] を入力して [次へ] をクリックします。以前に提供した認証情報の詳細に変更を加えない限り、接続を再度テストする必要はありません。
  16. [次へ] をクリックします。
    [ロールを招待] 画面が表示されます。
  17. オプション: この接続を使用するために招待するロールを選択します。
    OAuth 招待のロール ページを表示した画像
    注: [利用可能なロール] のリストにはカスタム ロールのみが表示されます。
    この接続を使用するときは、ユーザーにユーザー認証または同意を求める場合にのみこのオプションを使用してください。ユーザーが Bot でこの接続を使用する場合、ユーザーは接続に [ユーザー固有] トークン タイプを選択する必要があります。「Control Room で OAuth 接続を構成する」を参照してください。

    OAuth 接続を使用するようにロールを招待すると、そのロールに含まれているユーザーがイベント通知を登録している場合、割り当てられた接続について通知を受けます。「通知」を参照してください。

    注: 接続を使用できるのは、将来されたロールに含まれているユーザーのみです。他の Control Room ユーザーは [接続の選択] ウィンドウで接続を表示できますが、接続を使用することはできません。
  18. [接続の作成] をクリックします。

次のビデオでは、OAuth 接続の作成方法を紹介します。

次のステップ

OAuth 接続を使用する