OAuth URL support in Azure AI Bot Service
Azure AI Bot Service provides different OAuth and OAuth redirect URLs to meet specific needs.
- The bot needs the OAuth URL at run time.
- You need to provide the OAuth redirect URL when you create or configure your OAuth identity provider.
- For more information, see how to add authentication to your a bot.
Choose the URLs to use with your bot and identity provider based on your data residency requirements and whether your bot is in the public cloud or the Microsoft Azure Government cloud.
Data residency | Cloud | OAuth URL | OAuth Redirect URL |
---|---|---|---|
None | Public | https://token.botframework.com |
https://token.botframework.com/.auth/web/redirect |
Europe | Public | https://europe.token.botframework.com |
https://europe.token.botframework.com/.auth/web/redirect |
United States | Public | https://unitedstates.token.botframework.com |
https://unitedstates.token.botframework.com/.auth/web/redirect |
India | Public | https://india.token.botframework.com |
https://india.token.botframework.com/.auth/web/redirect |
None | Azure Government | https://token.botframework.azure.us |
https://token.botframework.azure.us/.auth/web/redirect |
The default OAuth and OAuth redirect URLs are https://token.botframework.com
and https://token.botframework.com/.auth/web/redirect
, which can be used for public-cloud bots with no data residency requirements.
To configure OAuthUrl in bot
Update appsettings.json to include OAuthUrl options:
{
"MicrosoftAppType": "",
"MicrosoftAppId": "",
"MicrosoftAppPassword": "",
"BotOpenIdMetadata": "https://login.botframework.com/v1/.well-known/openidconfiguration",
"CallerId": "urn:botframework:azure",
"OAuthUrl": "https://europe.token.botframework.com/",
"ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.com/v1/.well-known/openidconfiguration",
"ToBotFromChannelTokenIssuer": "https://api.botframework.com",
"ToBotFromEmulatorOpenIdMetadataUrl": "https://login.microsoftonline.com/botframework.com/v2.0/.well-known/openid-configuration",
"ToChannelFromBotLoginUrl": "https://login.microsoftonline.com/{0}",
"ToChannelFromBotOAuthScope": "https://api.botframework.com",
"ValidateAuthority": true
}
Additional information
Some environments use endpoints different than the ones listed here.
See these articles for related information.
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: I hele 2024 udfaser vi GitHub-problemer som feedbackmekanisme for indhold og erstatter det med et nyt feedbacksystem. Du kan få flere oplysninger under:Indsend og få vist feedback om