サードパーティ OAuth プロバイダーレコードの作成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：8分

    • サードパーティ OAuth プロバイダーレコードを作成して、作成した API エンドポイントに各インスタンスがアクセスできるようにします。

    始める前に

    外部クライアント用の OAuth API エンドポイントの作成のタスクを完了します。

    インスタンスの右上で、アプリケーションスコープが [グローバル] に設定されていることを確認します。

    個別のブラウザタブですべてのインスタンス (開発、テスト、本番など) を開きます。本番インスタンスで以下の手順を開始します。

    必要なロール：admin

    手順

    1. 本番インスタンスで、 すべて > システム OAuth > アプリケーションレジストリ.
      ここでは、3 つのインスタンス (開発、テスト、本番) のそれぞれに 1 つずつ、合計 3 つのレコードを作成する必要があります。追加の非本番インスタンス (ステージングなど) がある場合は、ここに示す方法に従って、それぞれのインスタンスのレコードを作成します。

    2. [New (新規)] を選択します。
    3. [サードパーティ OAuth プロバイダーに接続します] を選択して、開発インスタンスのレコードを作成します。
    4. フォームのフィールドに入力します。
      表 : 1. アプリケーションレジストリフォーム
      フィールド アクション
      名前 「Dev Instance Connection」と入力します。
      クライアント ID
      1. 開発インスタンスで、[アプリケーションレジストリ] リスト (すべて > システム OAuth > アプリケーションレジストリ).
      2. [パイプライン開発クライアント] レコードを開きます。
      3. クライアント ID をコピーします。
      4. 本番インスタンスで、開発インスタンスからクライアント ID を [クライアント ID] フィールドに貼り付けます。
      クライアントシークレット
      1. 開発インスタンスで、[アプリケーションレジストリ] リスト (すべて > システム OAuth > アプリケーションレジストリ).
      2. [パイプライン開発クライアント] レコードを開きます。
      3. [クライアントシークレット] フィールドのロックを解除し、テキストをコピーします。
      4. 本番インスタンスで、開発インスタンスからクライアントシークレットを [クライアントシークレット] フィールドに貼り付けます。
      デフォルトの権限許可タイプ [認証コード] に変更します。
      認証 URL
      1. フィールドをロック解除します。
      2. 開発インスタンスの URL を入力し、その後に「oauth_auth.do」と入力します。
      3. フィールドをロックします。
      例：https://<development instance name>.service-now.com/oauth_auth.do
      トークン URL
      1. フィールドをロック解除します。
      2. 開発インスタンスの URL を入力し、その後に「oauth_token.do」と入力します。
      3. フィールドをロックします。
      例：https://<development instance name>.service-now.com/oauth_token.do
    5. [送信] を選択します。
    6. [New (新規)] を選択します。
    7. [サードパーティ OAuth プロバイダーに接続します] を選択して、テストインスタンスのレコードを作成します。
    8. フォームのフィールドに入力します。
      表 : 2. アプリケーションレジストリフォーム
      フィールド アクション
      名前 「Test Instance Connection」と入力します。
      クライアント ID
      1. テストインスタンスで、[アプリケーションレジストリ] リスト (すべて > システム OAuth > アプリケーションレジストリ).
      2. [パイプラインテストクライアント] レコードを開きます。
      3. クライアント ID をコピーします。
      4. 本番インスタンスで、テストインスタンスからクライアント ID を [クライアント ID] フィールドに貼り付けます。
      クライアントシークレット
      1. テストインスタンスで、[アプリケーションレジストリ] リスト (すべて > システム OAuth > アプリケーションレジストリ).
      2. [パイプラインテストクライアント] レコードを開きます。
      3. [クライアントシークレット] フィールドのロックを解除し、テキストをコピーします。
      4. 本番インスタンスで、テストインスタンスからクライアントシークレットを [クライアントシークレット] フィールドに貼り付けます。
      デフォルトの権限許可タイプ [認証コード] に変更します。
      認証 URL
      1. フィールドをロック解除します。
      2. テストインスタンスの URL を入力し、その後に「oauth_auth.do」と入力します。
      3. フィールドをロックします。
      例：https://<test instance name>.service-now.com/oauth_auth.do
      トークン URL
      1. フィールドをロック解除します。
      2. テストインスタンスの URL を入力し、その後に「oauth_token.do」と入力します。
      3. フィールドをロックします。
      例：https://<test instance name>.service-now.com/oauth_token.do
    9. [送信] を選択します。
    10. [アプリケーションレジストリ] リストで、[パイプラインコントローラークライアント] レコードを選択します。
    11. クライアント ID をコピーし、メモアプリケーションなどの場所に貼り付けます。
    12. [クライアントシークレット] フィールドのロックを解除し、テキストをコピーして、クライアント ID とともにメモに貼り付けます。
    13. [アプリケーションレジストリ] リストに戻って、[新規] を選択します。
    14. [サードパーティ OAuth プロバイダーに接続します] を選択して、本番インスタンスのレコードを作成します。
    15. フォームのフィールドに入力します。
      表 : 3. アプリケーションレジストリフォーム
      フィールド アクション
      名前 「Prod Instance Connection」と入力します。
      クライアント ID
      1. メモしたクライアント ID をコピーします。
      2. クライアント ID を [クライアント ID] フィールドに貼り付けます。
      クライアント シークレット
      1. メモしたクライアントシークレットをコピーします。
      2. [クライアントシークレット] フィールドのロックを解除し、テキストをフィールドに貼り付けます。
      デフォルトの権限許可タイプ [認証コード] に変更します。
      認証 URL
      1. フィールドをロック解除します。
      2. 本番インスタンスの URL を入力し、その後に「oauth_auth.do」と入力します。
      3. フィールドをロックします。
      例：https://<production instance name>.service-now.com/oauth_auth.do
      トークン URL
      1. フィールドをロック解除します。
      2. 本番インスタンスの URL を入力し、その後に「oauth_token.do」と入力します。
      3. フィールドをロックします。
      例：https://<production instance name>.service-now.com/oauth_token.do
    16. [送信] を選択します。
      重要:
      開発インスタンスの次の手順を完了します。
    17. 開発インスタンスで、 すべて > システム OAuth > アプリケーションレジストリ.

    18. [New (新規)] を選択します。
    19. [サードパーティ OAuth プロバイダーに接続します] を選択して、本番インスタンスのレコードを作成します。
    20. フォームのフィールドに入力します。
      表 : 4. アプリケーションレジストリフォーム
      フィールド アクション
      名前 「Prod Instance Connection」と入力します。
      クライアント ID
      1. メモしたクライアント ID をコピーします。
      2. クライアント ID を [クライアント ID] フィールドに貼り付けます。
      クライアント シークレット
      1. メモしたクライアントシークレットをコピーします。
      2. [クライアントシークレット] フィールドのロックを解除し、テキストをフィールドに貼り付けます。
      デフォルトの権限許可タイプ [認証コード] に変更します。
      認証 URL
      1. フィールドをロック解除します。
      2. 本番インスタンスの URL を入力し、その後に「oauth_auth.do」と入力します。
      3. フィールドをロックします。
      例：https://<production instance name>.service-now.com/oauth_auth.do
      トークン URL
      1. フィールドをロック解除します。
      2. 本番インスタンスの URL を入力し、その後に「oauth_token.do」と入力します。
      3. フィールドをロックします。
      例：https://<production instance name>.service-now.com/oauth_token.do
    21. [送信] を選択します。
      重要:
      テストインスタンスの次の手順を完了します。
    22. テストインスタンスで、 すべて > システム OAuth > アプリケーションレジストリ.
    23. [新規] を選択します。
    24. [サードパーティ OAuth プロバイダーに接続します] を選択して、本番インスタンスのレコードを作成します。
    25. フォームのフィールドに入力します。
      表 : 5. アプリケーションレジストリフォーム
      フィールド アクション
      名前 「Prod Instance Connection」と入力します。
      クライアント ID
      1. メモしたクライアント ID をコピーします。
      2. クライアント ID を [クライアント ID] フィールドに貼り付けます。
      クライアント シークレット
      1. メモしたクライアントシークレットをコピーします。
      2. [クライアントシークレット] フィールドのロックを解除し、テキストをフィールドに貼り付けます。
      デフォルトの権限許可タイプ [認証コード] に変更します。
      認証 URL
      1. フィールドをロック解除します。
      2. 本番インスタンスの URL を入力し、その後に「oauth_auth.do」と入力します。
      3. フィールドをロックします。
      例：https://<production instance name>.service-now.com/oauth_auth.do
      トークン URL
      1. フィールドをロック解除します。
      2. 本番インスタンスの URL を入力し、その後に「oauth_token.do」と入力します。
      3. フィールドをロックします。
      例：https://<production instance name>.service-now.com/oauth_token.do
    26. [送信] を選択します。
    27. オプション: 他の非本番インスタンス (ステージングなど) について、手順 22 ~ 26 を繰り返します。

    次のタスク

    OAuth を使用するための事前作業が完了したので、指定されたインスタンスでOAuth を使用してパイプライン認証情報を作成するのすべての手順を完了します。