봇에 인증 추가

C#, JavaScript 및 Python 봇에 사용할 수 있습니다.

C#, JavaScript 및 Python 봇에 사용할 수 있습니다.

C#, JavaScript, Java 및 Python과 같은 모든 프로그래밍 언어의 봇에 사용할 수 있습니다.

1. Azure Portal에서 봇의 Azure Bot 리소스 페이지를 엽니다.

2. 설정을 선택합니다.

3. 페이지 아래쪽에 있는 OAuth 연결 설정에서 설정 추가를 선택합니다.

4. 다음과 같이 양식을 채웁니다.

   1. 이름. 연결의 이름을 입력합니다. 봇 코드에서 사용합니다.

   2. 서비스 공급자입니다. Microsoft Entra ID를 선택하여 Microsoft Entra ID 관련 필드를 표시합니다.

   3. 클라이언트 ID입니다. Microsoft Entra ID ID 공급자에 대해 기록한 애플리케이션(클라이언트) ID를 입력합니다.

   4. 클라이언트 암호. Microsoft Entra ID ID 공급자에 대해 기록한 비밀을 입력합니다.

      팁

      인증서를 사용하려는 경우 인증서 공급자를 사용하여 AAD v2를 선택할 수 있습니다. 인증서를 가져오려면 Bot Service 토큰 저장소(appid: 00001111-aaaa-2222-bbbb-3333cc4444)에 권한을 부여해야 합니다.

   5. 토큰 교환 URL입니다. Microsoft Entra ID에서만 SSO에 사용되므로 비워 둡니다.

   6. 테넌트 ID입니다. Microsoft Entra ID 앱에 대해 이전에 기록한 디렉터리(테넌트) ID 또는 common을 입력합니다. 이는 Azure DD 앱을 생성할 때 선택한 지원되는 계정 유형에 따라 달라집니다. 할당할 값을 결정하려면 다음 조건을 따릅니다.

      • Microsoft Entra ID 앱을 만들 때 이 조직 디렉터리에서만 계정을 선택한 경우(Microsoft 전용 - 단일 테넌트) Microsoft Entra ID 앱에 대해 이전에 기록한 테넌트 ID를 입력합니다.
      • 그러나 조직 디렉터리의 계정 (모든 Microsoft Entra ID 디렉터리 - 다중 테넌트 및 개인 Microsoft 계정(예: Xbox, Outlook.com)) 또는 조직 디렉터리의 계정(Microsoft Entra ID 디렉터리 - 다중 테넌트)을 선택한 경우, 테넌트 ID 대신 common을 입력합니다. 그 외에는 Microsoft Entra ID 앱이 ID가 선택된 테넌트를 통해 검증하고 개인 Microsoft 계정을 제외합니다.

      인증할 수 있는 사용자와 연결된 테넌트가 됩니다. 자세한 내용은 Microsoft Entra ID의 테넌시를 참조하세요.

   7. 애플리케이션 등록에서 선택한 권한의 이름을 범위에 입력합니다. 테스트를 위해 다음을 입력 openid profile하면 됩니다.

      참고

      Microsoft Entra ID에서 "Scopes" 필드는 대/소문자를 구분하며 공백으로 구분된 값 목록을 사용합니다.

5. 저장을 선택합니다.

1. Azure Portal에서 봇의 리소스 페이지로 이동합니다.

2. 설정을 선택합니다.

3. 페이지 아래쪽에 있는 OAuth 연결 설정에서 설정 추가를 선택합니다.

4. 다음과 같이 양식을 채웁니다.

   1. 이름에 대해 연결의 이름을 입력합니다. 봇 코드에서 이 이름을 사용합니다.

   2. 서비스 공급자의 경우 Microsoft Entra ID를 선택합니다. 이 항목을 선택하면 Microsoft Entra ID 관련 필드가 표시됩니다.

   3. 클라이언트 ID의 경우 Azure AD v1 애플리케이션에 대해 기록한 애플리케이션(클라이언트) ID를 입력합니다.

   4. 클라이언트 암호의 경우 Microsoft Entra ID 앱에 대한 봇 액세스 권한을 부여하기 위해 만든 비밀을 입력합니다.

   5. 그랜트 유형에 대해 authorization_code를 입력합니다.

   6. 로그인 URL에 https://login.microsoftonline.com를 입력합니다.

   7. 테넌트 ID의 경우 이전에 Microsoft Entra ID 앱에 대해 기록한 디렉터리(테넌트) ID를 입력하거나 ADD 앱을 만들 때 선택한 지원되는 계정 유형에 따라 공통을 입력합니다. 할당할 값을 결정하려면 다음 조건을 따릅니다.

      • Microsoft Entra ID 앱을 만들 때 이 조직 디렉터리에서만 계정을 선택한 경우(Microsoft 전용 - 단일 테넌트) Microsoft Entra ID 앱에 대해 이전에 기록한 테넌트 ID를 입력합니다.
      • 그러나 조직 디렉터리의 계정 (모든 Microsoft Entra ID 디렉터리 - 다중 테넌트 및 개인 Microsoft 계정(예: Xbox, Outlook.com)) 또는 조직 디렉터리의 계정(Microsoft Entra ID 디렉터리 - 다중 테넌트)을 선택한 경우, 테넌트 ID 대신 common을 입력합니다. 그렇지 않으면 Microsoft Entra ID 앱은 ID가 선택된 테넌트를 통해 확인하며 개인 MS 계정을 배제합니다.

      인증할 수 있는 사용자와 연결된 테넌트가 됩니다. 자세한 내용은 Microsoft Entra ID의 테넌시를 참조하세요.

   8. 리소스 URL에 대해 https://graph.microsoft.com/을 입력합니다.

   9. 범위를 비워 둡 니다 .

5. 저장을 선택합니다.

1. 작업하려는 샘플을 GitHub 리포지토리에서 복제합니다: 봇 인증 또는 Microsoft Graph에 대한 봇 인증.

2. appsettings.json 업데이트:

   • ConnectionName을 봇에 추가한 OAuth 연결 설정의 이름으로 설정합니다.

   • MicrosoftAppId 및 MicrosoftAppPassword를 봇의 앱 ID 및 앱 비밀로 설정합니다.

     봇 비밀의 문자에 따라 암호를 XML 형식으로 이스케이프 처리해야 할 수도 있습니다. 예를 들어 앰퍼샌드(&)는 로 인코딩해야 합니다.

   {
     "MicrosoftAppType": "",
     "MicrosoftAppId": "",
     "MicrosoftAppPassword": "",
     "MicrosoftAppTenantId": "",
     "ConnectionName": ""
   }
   

   퍼블릭 클라우드에서 데이터 상주와 함께 봇에서 OAuth를 사용하려면 appsettings에 다음 구성을 추가해야 합니다.

   "OAuthUrl": "<Regional-OAuth-Uri>",
   "ToChannelFromBotOAuthScope": "https://api.botframework.com",
   "ToChannelFromBotLoginUrlTemplate": "https://api.botframework.com",
   "PublicAzureChannel": "https://api.botframework.com",
   "ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.com/v1/.well-known/openidconfiguration",
   "ToBotFromEmulatorOpenIdMetadataUrl": "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration",
   "ToBotFromChannelTokenIssuer": "https://api.botframework.com",
   "ToChannelFromBotLoginUrl": "https://login.microsoftonline.com/botframework.com",
   

   <Regional-OAuth-Url>은 다음 URL 중 하나입니다.

   URI(유알아이)	설명
   https://europe.api.botframework.com	유럽에 데이터가 상주하는 퍼블릭 클라우드 봇의 경우.
   https://unitedstates.api.botframework.com	미국 데이터 상주가 있는 퍼블릭 클라우드 봇의 경우
   https://india.api.botframework.com	인도에 데이터가 상주하는 퍼블릭 클라우드 봇의 경우.

3. 업데이트 Startup.cs:

   정부 클라우드와 같은 비공용 Azure 클라우드에서 OAuth를 사용하려면 Startup.cs 파일에 다음 코드를 추가해야 합니다.

   string uri = "<uri-to-use>";
   MicrosoftAppCredentials.TrustServiceUrl(uri);
   OAuthClientConfig.OAuthEndpoint = uri;
   
   

   여기서 <uri-to-use> 는 다음 URI 중 하나입니다.

   URI(유알아이)	설명
   https://api.botframework.azure.us	데이터 지역성을 고려하지 않는 미국 정부 클라우드 봇의 경우
   https://api.botframework.com	데이터 보존이 없는 퍼블릭 클라우드 봇의 경우 이는 기본 URI이며 Startup.cs 변경할 필요가 없습니다.

1. 작업하려는 GitHub 리포지토리에서 복제: 봇 인증 또는 Microsoft Graph에 대한 봇 인증.

2. .env 업데이트:

   • connectionName을 봇에 추가한 OAuth 연결 설정의 이름으로 설정합니다.

   • MicrosoftAppId 및 MicrosoftAppPassword 값을 봇의 앱 ID와 앱 비밀로 설정하십시오.

     봇 비밀의 문자에 따라 암호를 XML 형식으로 이스케이프 처리해야 할 수도 있습니다. 예를 들어 앰퍼샌드(&)는 로 인코딩해야 합니다.

   MicrosoftAppType=
   MicrosoftAppId=
   MicrosoftAppPassword=
   MicrosoftAppTenantId=
   connectionName=
   

1. 작업하려는 샘플을 GitHub 리포지토리에서 복제합니다: 봇 인증 또는 Microsoft Graph에 대한 봇 인증.

2. application.properties 업데이트:

   • ConnectionName을 봇에 추가한 OAuth 연결 설정의 이름으로 설정합니다.
   • MicrosoftAppId 및 MicrosoftAppPassword를 봇의 앱 ID 및 앱 비밀로 설정합니다.

   경고

   찾으려는 샘플이 이동된 것 같습니다. 우리는이 문제를 해결하기 위해 노력하고 있습니다 안심.

1. 작업하려는 샘플에 대해 봇 인증 또는 Microsoft Graph용 봇 인증의 GitHub 리포지토리를 복제합니다.

2. 업데이트 config.py:

   • ConnectionName을 봇에 추가한 OAuth 연결 설정의 이름으로 설정합니다.

   • MicrosoftAppId 및 MicrosoftAppPassword를 봇의 앱 ID 및 앱 비밀로 설정합니다.

     봇 비밀의 문자에 따라 암호를 XML 형식으로 이스케이프 처리해야 할 수도 있습니다. 예를 들어 앰퍼샌드(&)는 로 인코딩해야 합니다.

   #!/usr/bin/env python3
   # Copyright (c) Microsoft Corporation. All rights reserved.
   # Licensed under the MIT License.
   
   import os
   
   """ Bot Configuration """
   
   
   class DefaultConfig:
       """ Bot Configuration """
   
       PORT = 3978
       APP_ID = os.environ.get("MicrosoftAppId", "")
       APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "")
       APP_TYPE = os.environ.get("MicrosoftAppType", "MultiTenant")
       APP_TENANTID = os.environ.get("MicrosoftAppTenantId", "")
       CONNECTION_NAME = os.environ.get("ConnectionName", "")
   

Dialogs\MainDialog.cs

해당 생성자의 MainDialog에 OAuth 프롬프트를 추가합니다. 여기서 연결 이름 값은 appsettings.json 파일에서 검색되었습니다.

AddDialog(new OAuthPrompt(
    nameof(OAuthPrompt),
    new OAuthPromptSettings
    {
        ConnectionName = ConnectionName,
        Text = "Please Sign In",
        Title = "Sign In",
        Timeout = 300000, // User has 5 minutes to login (1000 * 60 * 5)
    }));

대화 상자 단계 내에서 BeginDialogAsync를 사용하여 사용자에게 로그인하라고 요청하는 OAuth 프롬프트를 시작합니다.

• 사용자가 이미 로그인한 경우 사용자에게 메시지를 표시하지 않고 토큰 응답 이벤트를 생성합니다.
• 사용자가 아직 로그인하지 않은 경우 사용자에게 로그인하라는 프롬프트를 표시합니다. Azure AI Bot Service는 사용자가 로그인을 시도한 후 토큰 응답 이벤트를 보냅니다.

return await stepContext.BeginDialogAsync(nameof(OAuthPrompt), null, cancellationToken);

다음 대화 단계 내에서 이전 단계의 결과에 토큰이 있는지 확인합니다. null이 아닌 경우 사용자가 성공적으로 로그인했습니다.

// Get the token from the previous step. Note that we could also have gotten the
// token directly from the prompt itself. There is an example of this in the next method.
var tokenResponse = (TokenResponse)stepContext.Result;

dialogs/mainDialog.js

해당 생성자의 MainDialog에 OAuth 프롬프트를 추가합니다. 여기서 연결 이름 값은 .env 파일에서 검색되었습니다.

}));
this.addDialog(new ConfirmPrompt(CONFIRM_PROMPT));
this.addDialog(new WaterfallDialog(MAIN_WATERFALL_DIALOG, [
    this.promptStep.bind(this),
    this.loginStep.bind(this),
    this.displayTokenPhase1.bind(this),

대화 상자 단계 내에서 beginDialog를 사용하여 사용자에게 로그인하라고 요청하는 OAuth 프롬프트를 시작합니다.

• 사용자가 이미 로그인한 경우 사용자에게 메시지를 표시하지 않고 토큰 응답 이벤트를 생성합니다.
• 사용자가 아직 로그인하지 않은 경우 사용자에게 로그인하라는 프롬프트를 표시합니다. Azure AI Bot Service는 사용자가 로그인을 시도한 후 토큰 응답 이벤트를 보냅니다.

// Get the token from the previous step. Note that we could also have gotten the

다음 대화 단계 내에서 이전 단계의 결과에 토큰이 있는지 확인합니다. null이 아닌 경우 사용자가 성공적으로 로그인했습니다.

    return await stepContext.prompt(CONFIRM_PROMPT, 'Would you like to view your token?');
}

MainDialog.java

해당 생성자의 MainDialog에 OAuth 프롬프트를 추가합니다. 여기서 연결 이름 값은 application.properties 파일에서 검색되었습니다.

대화 상자 단계 내에서 beginDialog를 사용하여 사용자에게 로그인하라고 요청하는 OAuth 프롬프트를 시작합니다.

• 사용자가 이미 로그인한 경우 사용자에게 메시지를 표시하지 않고 토큰 응답 이벤트를 생성합니다.
• 사용자가 아직 로그인하지 않은 경우 사용자에게 로그인하라는 프롬프트를 표시합니다. Azure AI Bot Service는 사용자가 로그인을 시도한 후 토큰 응답 이벤트를 보냅니다.

다음 대화 단계 내에서 이전 단계의 결과에 토큰이 있는지 확인합니다. null이 아닌 경우 사용자가 성공적으로 로그인했습니다.

dialogs/main_dialog.py

해당 생성자의 MainDialog에 OAuth 프롬프트를 추가합니다. 여기서 연결 이름 값은 config.py 파일에서 검색되었습니다.

self.add_dialog(
    WaterfallDialog(
        "WFDialog",
        [
            self.prompt_step,
            self.login_step,
            self.display_token_phase1,
            self.display_token_phase2,
        ],
    )
)

대화 상자 단계 내에서 begin_dialog를 사용하여 사용자에게 로그인하라고 요청하는 OAuth 프롬프트를 시작합니다.

• 사용자가 이미 로그인한 경우 사용자에게 메시지를 표시하지 않고 토큰 응답 이벤트를 생성합니다.
• 사용자가 아직 로그인하지 않은 경우 사용자에게 로그인하라는 프롬프트를 표시합니다. Azure AI Bot Service는 사용자가 로그인을 시도한 후 토큰 응답 이벤트를 보냅니다.

return await step_context.begin_dialog(OAuthPrompt.__name__)

다음 대화 단계 내에서 이전 단계의 결과에 토큰이 있는지 확인합니다. null이 아닌 경우 사용자가 성공적으로 로그인했습니다.

if step_context.result:
    await step_context.context.send_activity("You are now logged in.")
    return await step_context.prompt(
        ConfirmPrompt.__name__,
        PromptOptions(
            prompt=MessageFactory.text("Would you like to view your token?")
        ),
    )

await step_context.context.send_activity(
    "Login was not successful please try again."
)

Bots\AuthBot.cs

AuthBot은 ActivityHandler에서 파생되며, 토큰 응답 이벤트 활동을 명시적으로 처리합니다. 여기서는 OAuth 프롬프트가 이벤트를 처리하고 토큰을 검색할 수 있도록 하는 활성 대화 상자를 계속 진행합니다.

protected override async Task OnTokenResponseEventAsync(ITurnContext<IEventActivity> turnContext, CancellationToken cancellationToken)
{
    Logger.LogInformation("Running dialog with Token Response Event Activity.");

    // Run the Dialog with the new Token Response Event Activity.
    await Dialog.RunAsync(turnContext, ConversationState.CreateProperty<DialogState>(nameof(DialogState)), cancellationToken);
}

봇/authBot.js

AuthBot은 ActivityHandler에서 파생되며, 토큰 응답 이벤트 활동을 명시적으로 처리합니다. 여기서는 OAuth 프롬프트가 이벤트를 처리하고 토큰을 검색할 수 있도록 하는 활성 대화 상자를 계속 진행합니다.

    await next();
});

AuthBot.java

AuthBot은 Dialog에서 파생되며, 토큰 응답 이벤트 활동을 명시적으로 처리합니다. 여기서는 OAuth 프롬프트가 이벤트를 처리하고 토큰을 검색할 수 있도록 하는 활성 대화 상자를 계속 진행합니다.

bots/auth_bot.py

AuthBot 은 토큰 응답 이벤트 활동을 명시적으로 처리합니다. 여기서는 OAuth 프롬프트가 이벤트를 처리하고 토큰을 검색할 수 있도록 하는 활성 대화 상자를 계속 진행합니다.

async def on_token_response_event(self, turn_context: TurnContext):
    # Run the Dialog with the new Token Response Event Activity.
    await DialogHelper.run_dialog(
        self.dialog,
        turn_context,
        self.conversation_state.create_property("DialogState"),
    )

Dialogs\LogoutDialog.cs

private async Task<DialogTurnResult> InterruptAsync(DialogContext innerDc, CancellationToken cancellationToken = default(CancellationToken))
{
    if (innerDc.Context.Activity.Type == ActivityTypes.Message)
    {
        var text = innerDc.Context.Activity.Text.ToLowerInvariant();

        if (text == "logout")
        {
            // The UserTokenClient encapsulates the authentication processes.
            var userTokenClient = innerDc.Context.TurnState.Get<UserTokenClient>();
            await userTokenClient.SignOutUserAsync(innerDc.Context.Activity.From.Id, ConnectionName, innerDc.Context.Activity.ChannelId, cancellationToken).ConfigureAwait(false);

            await innerDc.Context.SendActivityAsync(MessageFactory.Text("You have been signed out."), cancellationToken);
            return await innerDc.CancelAllDialogsAsync(cancellationToken);
        }
    }

    return null;
}

dialogs/logoutDialog.js

}

async interrupt(innerDc) {
    if (innerDc.context.activity.type === ActivityTypes.Message) {
        const text = innerDc.context.activity.text.toLowerCase();
        if (text === 'logout') {
            const userTokenClient = innerDc.context.turnState.get(innerDc.context.adapter.UserTokenClientKey);

            const { activity } = innerDc.context;
            await userTokenClient.signOutUser(activity.from.id, this.connectionName, activity.channelId);

            await innerDc.context.sendActivity('You have been signed out.');
            return await innerDc.cancelAllDialogs();

LogoutDialog.java

dialogs/logout_dialog.py

        return result
    return await super().on_continue_dialog(inner_dc)

async def _interrupt(self, inner_dc: DialogContext):
    if inner_dc.context.activity.type == ActivityTypes.message:
        text = inner_dc.context.activity.text.lower()
        if text == "logout":
            user_token_client: UserTokenClient = inner_dc.context.turn_state.get(