Microsoft Entra ID を使用してシングルサインオンを構成する

[アーティクル]
04/22/2024

重要

Power Virtual Agents 機能は、生成 AI への多大な投資と Microsoft Copilot 全体の統合の強化により、現在 Microsoft Copilot Studio の一部となっています。

ドキュメントやトレーニングコンテンツが更新される間、一部の記事やスクリーンショットで Power Virtual Agents が参照される場合があります。

Copilot Studio は、シングルサインオン (SSO) をサポートしています。 SSO を使用すると、Web サイト上のコパイロットは、コパイロットが展開されているページまたはアプリに既にサインインしている場合に、顧客をサインインすることができます。

前提条件

Microsoft Entra ID を使用してエンドユーザー認証を有効にします。
SSO は Microsoft Entra ID でのみサポートされます。 Microsoft アカウントや他の OAuth アカウントなどの他のアカウントタイプはサポートされていません。
コパイロットへの認証トピックを追加します。
カスタムキャンバスを使用する。

たとえば、コパイロットは社内のイントラネットまたはユーザーが既にサインインしているアプリでホストされます。

Copilot Studio の SSO を構成する、4 つの主な手順があります:

Microsoft Entra ID でカスタムキャンバスにアプリ登録を作成します。
コパイロットのカスタムスコープを定義します。
SSO を有効にするように Copilot Studio で認証を構成します。
SSO を有効にするように、カスタムキャンバス HTML コードを構成します。

重要

現在、コパイロットが次のいずれかの場合、SSO はサポートされていません:

SharePoint Web サイトに公開済み。
Power Apps ポータルに公開済み。

サポート対象のチャネル

次の表は、現在 SSO をサポートしているチャネルの詳細です。追加のチャネルのサポートは Microsoft Copilot Studio アイデアフォーラムで提案できます。

Channel	サポート対象
Azure ボットサービスチャネル	サポートしていません
カスタム Web サイト	サポート対象
デモ Web サイト	サポートしていません
Facebook	サポートしていません
Microsoft Teams¹	サポート対象
モバイルアプリ	サポートしていません
Omnichannel for Customer Service²	サポート対象

¹ Teams チャネルも有効にしている場合は、Teams チャネルの SSO の構成説明書の構成手順に従う必要があります。そのページの指示に従って Teams SSO 設定を構成しないと、ユーザーは Teams チャネルを使用するときに常に認証に失敗します。

² ライブチャットチャネルのみがサポートされています。詳細については、Dynamics 365 Customer Service へのハンドオフを構成するを参照してください。

Web アプリケーション
クラシック

カスタム Web サイト用のアプリ登録を作成する

SSO を有効にするには、2 つの個別のアプリ登録を作成する必要です。

認証アプリ登録 で、コパイロットの Microsoft Entra ID ユーザー認証を有効にします
カスタム Web ページの SSO を有効にするキャンバスアプリの登録

セキュリティ上の理由から、コパイロットとカスタム Web サイトの両方に同じアプリ登録を再利用することはお勧めしません。

Microsoft Entra ID を使用してユーザー認証を構成するの手順に従って、認証アプリ登録を作成します。
もう一度同じ手順に従って、キャンバスアプリの登録として機能する 2 つ目のアプリ登録を作成します。
この記事に戻ります。

キャンバスアプリの登録を構成する

キャンバスアプリの登録を作成した後は、認証にアクセスし、プラットフォームの追加を選択します。
プラットフォームの構成の下で、プラットフォームの追加、次に Web を選択します。
リダイレクト URI の下で、http://contoso.com/index.html などの Web ページの URL を入力します。
暗黙的な許可とハイブリッドフロー セクションで、アクセストークン (暗黙的なフローに使用) と ID トークン (暗黙的およびハイブリッドフローに使用) の両方をオンにします。
構成を選択します。

コパイロットのトークンエンドポイント URL を確認する

Copilot Studio で、設定に移動し、次にチャネルを選択します。
モバイルアプリを選択します。
トークンエンドポイントの下で、コピーを選択します。

Web ページで SSO を構成する

Copilot Studio GitHub リポジトリで提供されるコードを使用して、リダイレクト URL の Web ページを作成します。 GitHub リポジトリからコードをコピーし、以下の手順に従って変更します。

Azure ポータルの概要ページに移動し、キャンバスアプリ登録からアプリケーション (クライアント) ID とディレクトリ (テナント) ID をコピーします。
Microsoft Authentication Library (MSAL) を構成する方法:
- clientId を アプリケーション (クライアント) ID に割り当てます。
- authority を https://login.microsoftonline.com/ に割り当て、最後に ディレクトリ (テナント) ID を追加します。
例:
```
var clientApplication;
    (function (){
    var msalConfig = {
        auth: {
            clientId: '692e92c7-xxxx-4060-76d3-b381798f4d9c',
            authority: 'https://login.microsoftonline.com/7ef988bf-xxxx-51af-01ab-2d7fd011db47'     
        },
```

theURL 変数を、すでにコピーしたトークンエンドポイント URL に設定します。例:

(async function main() {

    var theURL = "https://1c0.0.environment.api.powerplatform.com/powervirtualagents/bots/5a099fd/directline/token?api-version=2022-03-01-preview"

userId の値を編集して、カスタム接頭辞を含めます。例:

var userId = clientApplication.account?.accountIdentifier != null ? 
        ("My-custom-prefix" + clientApplication.account.accountIdentifier).substr(0, 64) 
        : (Math.random().toString() + Date.now().toString()).substr(0,64);

変更を保存。

Web ページを使用してコパイロットをテストする

ブラウザで Web ページを開きます。
ログインを選択します。

Note

ブラウザーがポップアップをブロックしている場合、またはシークレットまたはプライベートブラウザーウィンドウを使用している場合は、ログインするよう求められます。それ以外の場合、ログインは検証コードを使用して完了します。

新しいブラウザータブが開きます。
新しいタブに切り替えて、検証コードをコピーします。
コパイロットのあるタブに戻り、コパイロットの会話に検証コードを貼り付けます。

Azure アプリの登録

技術的な概要

次の図は、ユーザーが Copilot Studio でログインプロンプト (SSO) を表示せずにサインインする方法を示します:

SSO 認証フローの図。

コパイロットユーザーは、サインイントピックをトリガーするフレーズを入力します。サインイントピックは、ユーザーをサインインしてユーザーの認証されたトークン (AuthToken 変数) を使用するように設計されています。
Copilot Studio はログインプロンプトを送信して、ユーザーが構成された ID プロバイダーでサインインできるようにします。
コパイロットのカスタムキャンバスはサインインプロンプトを受信し、代理 (OBO) トークンを Microsoft Entra ID から要求します。キャンバスはトークンをコパイロットに送信します。
OBO トークンの受信時に、コパイロットは OBO トークンを「アクセストークン」に交換し、アクセストークンの値を使用して AuthToken 変数を入力します。 IsLoggedIn 変数はこの時点でも設定されます。

Microsoft Entra ID でカスタムキャンバスにアプリ登録を作成する

SSO を有効にするには、2 つの個別のアプリ登録が必要です:

1 つは、Microsoft Entra ID でユーザー認証を有効にするためのコパイロット用です。
他の 1 つはカスタムキャンバスが SSO を有効にするためです。

重要

コパイロットのユーザー認証とカスタムキャンバスの両方に同じアプリ登録を使いまわすことはできません。

コパイロットのキャンバス用アプリ登録を作成する

Azure portalにサインインします。
アプリ登録に移動して、アイコンを選択するか、上部の検索バーで検索します。
新規登録を選択します。
登録の名前を入力してください。登録しているキャンバスのコパイロットの名前を使用し、"キャンバス" を含めて認証用のアプリ登録と区別するのに役立ちます。

たとえば、コパイロットが "Contoso sales help" という名前の場合、アプリ登録に "ContosoSalesCanvas" などの名前を付ける場合があります。
サポートされているアカウントの種類 からアカウントの種類を選択します。 任意の組織ディレクトリ内のアカウント (任意の Microsoft Entra ID ディレクトリ - マルチテナント型) と個人の Microsoft アカウント (Skype、Xbox など)の選択を推奨します。
次のステップでその情報を入力するので、今回は リダイレクト URI セクションを空白のままにします。登録を選択します。
登録が完了した後、概要ページが開きます。 マニフェストにアクセスします。 accessTokenAcceptedVersion が 2 に設定されていることを確認します。そうでない場合は、2 に変更し、保存を選択します。

リダイレクト URL の追加

登録を開いた状態で、認証にアクセスし、プラットフォームの追加を選択します。
プラットフォームの構成ブレードで、Web を選択します。
リダイレクト URI で、チャットキャンバスがホストされているページに完全な URL を追加します。 暗示的な許可セクションで、ID トークンおよびアクセストークン チェックボックスを選択します。
構成を選択して変更を確認します。
API アクセス許可に移動します。 <テナント名>に管理者の承認を付与するを選択してから、はいを選択します。

重要

ユーザーが各アプリケーションに同意するのを防ぐには、グローバル管理者、アプリケーション管理者、またはクラウドアプリケーション管理者がアプリの登録にテナント全体の同意を付与する必要があります。

コパイロットのカスタムスコープを定義する

認証アプリ登録内でキャンバスアプリ登録用の API を公開することにより、カスタムスコープを定義します。スコープにより、ユーザーと管理者の役割およびアクセス権を決定できます。

この手順では、認証用の認証アプリ登録とカスタムキャンバス用のアプリ登録の間に信頼関係が作成されます。

認証を構成したときに作成したアプリ登録を開きます。
API アクセス許可 に移動し、コパイロットに適切なアクセス許可が追加されていることを確認してください。 <テナント名>に管理者の承認を付与するを選択してから、はいを選択します。

重要

ユーザーが各アプリケーションに同意するのを防ぐには、グローバル管理者、アプリケーション管理者、またはクラウドアプリケーション管理者がアプリの登録にテナント全体の同意を付与する必要があります。
API を公開するに移動してからスコープの追加を選択します。
スコープの名前と、ユーザーが SSO 画面にアクセスしたときに表示される表示情報を入力します。 スコープの追加を選択します。
クライアントアプリケーションの追加を選択します。
アプリケーション (クライアント) ID を、キャンバスアプリ登録の概要ページからクライアント ID フィールドに入力します。作成した一覧表示スコープのチェックボックスを選択します。
アプリケーションの追加を選択します。

SSO を有効にするように Copilot Studio で認証を構成する

Copilot Studio 認証設定ページの トークン交換 URL は、Bot Framework を通じて要求されたアクセストークンに対する OBO トークンを交換するために使用されます。

Copilot Studio は Microsoft Entra ID を呼び出して、実際の交換を行います。

Copilot Studio にサインインします。
トップメニューにあるコパイロットアイコンを選択し、適切なコパイロットを選択して、認証を有効にするコパイロットを選択したことを確認します。
ナビゲーションメニューの設定で セキュリティ を選択します。次に、認証カードを選択します。
トークンの交換 URL フィールドにあるコパイロットの認証アプリ登録について、API の公開 ブレードから完全なスコープ URI を入力します。 URI の形式は api://1234-4567/scope.name です。
保存を選択してからコパイロットコンテンツを公開します。

SSO を有効にするように、カスタムキャンバス HTML コードを構成する

コパイロットが配置されているカスタムキャンバスページを更新して、ログインカードのリクエストを受信し、OBO トークンを交換します。

次のコードを <head> セクションの <script> タグに追加して、Microsoft 認証ライブラリ (MSAL) を構成します。

アプリケーション (クライアント) ID キャンバスアプリ登録用を使用して clientId を更新します。 <Directory ID> をディレクトリ (テナント) ID に置き換えます。キャンバスアプリ登録の概要ページからこれらの ID を取得します。

アプリケーションとディレクトリ ID を強調表示したアプリ登録の概要。

<head>
 <script>
   var clientApplication;
     (function () {
       var msalConfig = {
           auth: {
             clientId: '<Client ID [CanvasClientId]>',
             authority: 'https://login.microsoftonline.com/<Directory ID>'
           },
           cache: {
             cacheLocation: 'localStorage',
             storeAuthStateInCookie: false
           }
       };
       if (!clientApplication) {
         clientApplication = new Msal.UserAgentApplication(msalConfig);
       }
     } ());
 </script>
</head>

次の <script> を <body> セクションに挿入します。このスクリプトはメソッドを呼び出して resourceUrl を取得し、現在のトークンを OAuth プロンプトで要求されたトークンと交換します。

<script>
function getOAuthCardResourceUri(activity) {
  if (activity &&
       activity.attachments &&
       activity.attachments[0] &&
       activity.attachments[0].contentType === 'application/vnd.microsoft.card.oauth' &&
       activity.attachments[0].content.tokenExchangeResource) {
         // asking for token exchange with Microsoft Entra ID
         return activity.attachments[0].content.tokenExchangeResource.uri;
   }
}

function exchangeTokenAsync(resourceUri) {
  let user = clientApplication.getAccount();
   if (user) {
     let requestObj = {
       scopes: [resourceUri]
     };
     return clientApplication.acquireTokenSilent(requestObj)
       .then(function (tokenResponse) {
         return tokenResponse.accessToken;
         })
         .catch(function (error) {
           console.log(error);
         });
         }
         else {
         return Promise.resolve(null);
   }
}
</script>

次の <script> を <body> セクションに挿入します。 main メソッド内で、このコードはコパイロットの一意識別子を使用して store に条件を追加します。また固有の ID を、userId 変数として生成します。

コパイロットの ID を使用して <COPILOT ID> を更新します。使用しているコパイロットの チャネルタブ に移動し、Copilot Studio ポータルで モバイルアプリ を選択すると、コパイロットの ID を確認できます。

モバイルアプリチャネルの構成ページに表示されるコパイロット ID。

<script>
    (async function main() {

        // Add your COPILOT ID below 
        var BOT_ID = "<BOT ID>";
        var theURL = "https://powerva.microsoft.com/api/botmanagement/v1/directline/directlinetoken?botId=" + BOT_ID;

        const {
            token
        } = await fetchJSON(theURL);

        var directline = await fetchJSON(regionalChannelSettingsURL).then(res=> res.channelUrlsById.directline); 

        const directLine = window.WebChat.createDirectLine({
            domain: `${directline}v3/directline`,
            token
        });

        var userID = clientApplication.account?.accountIdentifier != null ?
            ("Your-customized-prefix-max-20-characters" + clientApplication.account.accountIdentifier).substr(0, 64) :
            (Math.random().toString() + Date.now().toString()).substr(0, 64); // Make sure this will not exceed 64 characters 
        const store = WebChat.createStore({}, ({
            dispatch
        }) => next => action => {
            const {
                type
            } = action;
            if (action.type === 'DIRECT_LINE/CONNECT_FULFILLED') {
                dispatch({
                    type: 'WEB_CHAT/SEND_EVENT',
                    payload: {
                        name: 'startConversation',
                        type: 'event',
                        value: {
                            text: "hello"
                        }
                    }
                });
                return next(action);
            }
            if (action.type === 'DIRECT_LINE/INCOMING_ACTIVITY') {
                const activity = action.payload.activity;
                let resourceUri;
                if (activity.from && activity.from.role === 'bot' &&
                    (resourceUri = getOAuthCardResourceUri(activity))) {
                    exchangeTokenAsync(resourceUri).then(function(token) {
                        if (token) {
                            directLine.postActivity({
                                type: 'invoke',
                                name: 'signin/tokenExchange',
                                value: {
                                    id: activity.attachments[0].content.tokenExchangeResource.id,
                                    connectionName: activity.attachments[0].content.connectionName,
                                    token,
                                },
                                "from": {
                                    id: userID,
                                    name: clientApplication.account.name,
                                    role: "user"
                                }
                            }).subscribe(
                                id => {
                                    if (id === 'retry') {
                                        // copilot was not able to handle the invoke, so display the oauthCard
                                        return next(action);
                                    }
                                    // else: tokenexchange successful and we do not display the oauthCard
                                },
                                error => {
                                    // an error occurred to display the oauthCard
                                    return next(action);
                                }
                            );
                            return;
                        } else
                            return next(action);
                    });
                } else
                    return next(action);
            } else
                return next(action);
        });

        const styleOptions = {

            // Add styleOptions to customize Web Chat canvas
            hideUploadButton: true
        };

        window.WebChat.renderWebChat({
                directLine: directLine,
                store,
                userID: userID,
                styleOptions
            },
            document.getElementById('webchat')
        );
    })().catch(err => console.error("An error occurred: " + err));
</script>

完全なサンプルコード

詳細については、MSAL およびストア条件付きスクリプトが既に GitHub リポジトリに含まれている完全なサンプルコードを参照してください。

Microsoft Entra ID を使用してシングルサインオンを構成する

前提条件

サポート対象のチャネル

カスタム Web サイト用のアプリ登録を作成する

キャンバスアプリの登録を構成する

コパイロットのトークンエンドポイント URL を確認する

Web ページで SSO を構成する

Web ページを使用してコパイロットをテストする

技術的な概要

Microsoft Entra ID でカスタムキャンバスにアプリ登録を作成する

コパイロットのキャンバス用アプリ登録を作成する

リダイレクト URL の追加

コパイロットのカスタムスコープを定義する

SSO を有効にするように Copilot Studio で認証を構成する

SSO を有効にするように、カスタムキャンバス HTML コードを構成する

完全なサンプルコード

フィードバック

フィードバック

その他のリソース

Microsoft Entra ID を使用してシングル サインオンを構成する

前提条件

サポート対象のチャネル

カスタム Web サイト用のアプリ登録を作成する

キャンバス アプリの登録を構成する

コパイロットのトークン エンドポイント URL を確認する

Web ページで SSO を構成する

Web ページを使用してコパイロットをテストする

関連記事

フィードバック

フィードバック

その他のリソース

Microsoft Entra ID を使用してシングルサインオンを構成する

キャンバスアプリの登録を構成する

コパイロットのトークンエンドポイント URL を確認する