feat: add OAuth support for regional bots by Copilot · Pull Request #209 · microsoft/teams.py

Copilot · 2025-11-11T18:15:44Z

Plan: Add OAuth Support for Regional Bots ✅ COMPLETE

This PR implements OAuth support for regional bots in Python, mirroring the TypeScript implementation.

Summary of Changes

API Layer (`packages/api`)

ApiClientSettings: New dataclass for OAuth endpoint configuration
- Defaults to https://token.botframework.com
- Supports regional endpoints (e.g., https://europe.token.botframework.com)
- Reads from OAUTH_URL environment variable
BaseClient: Now handles api_client_settings for all subclasses
- Added api_client_settings parameter to constructor
- Calls merge_api_client_settings internally
- All client subclasses inherit this functionality
Client updates: All API clients now inherit settings handling from BaseClient
Endpoint constants: Added for maintainability
Docstrings: Updated to "Optional API client settings." for consistency

Apps Layer (`packages/apps`)

AppOptions.default_connection_name: OAuth connection name (defaults to "graph")
AppOptions.api_client_settings: Top-level field for API client configuration
Removed OAuthSettings: Simplified API by keeping all config in AppOptions
Updated references: Changed from options.oauth.default_connection_name to options.default_connection_name

Example Usage

from microsoft.teams.api import ApiClientSettings
from microsoft.teams.apps import App

# Configure for Europe region
app = App(
    default_connection_name='graph',
    api_client_settings=ApiClientSettings(
        oauth_url="https://europe.token.botframework.com"
    )
)

Testing

All 109 API unit tests passing
Linting passed (ruff)
Type checking passed (pyright)

Latest Changes

✅ Moved api_client_settings handling to BaseClient for inheritance
✅ All client subclasses now pass settings to BaseClient constructor
✅ Removed duplicate merge_api_client_settings calls from subclasses
✅ Simplified imports by removing unused merge_api_client_settings imports

Original prompt

in the Python repository, apply similar changes to this Typescript PR [apps/api] feat: allow oauth for regional bots by lilyydu · Pull Request #386 · microsoft/teams.ts

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: lilyydu <[email protected]>

lilyydu · 2025-11-11T19:21:33Z

@copilot A series of updates were made here. Complete the same changes
microsoft/teams.ts#394

Co-authored-by: lilyydu <[email protected]>

Copilot · 2025-11-11T19:30:58Z

@copilot A series of updates were made here. Complete the same changes
microsoft/teams.ts#394

Completed the refactoring from PR #394. Changes applied in commit 9982511:

Removed client_settings from OAuthSettings
Added api_client_settings as a top-level field in AppOptions
Updated App and ActivityProcessor to use options.api_client_settings instead of options.oauth.client_settings
Updated documentation and examples

The API is now simpler with ApiClientSettings at the top level rather than nested in OAuthSettings.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

login.microsoftonline.com
- Triggering command: /home/REDACTED/work/teams.py/teams.py/.venv/bin/python /home/REDACTED/work/teams.py/teams.py/.venv/bin/pytest packages -x -q --tb=short (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Co-authored-by: lilyydu <[email protected]>

Copilot · 2025-11-11T20:10:04Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

login.microsoftonline.com
- Triggering command: /home/REDACTED/work/teams.py/teams.py/.venv/bin/python /home/REDACTED/work/teams.py/teams.py/.venv/bin/pytest packages -x -q --tb=short (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot

Pull Request Overview

This PR implements configurable OAuth endpoints to support regional bot deployments in the Microsoft Teams SDK for Python, mirroring the functionality from teams.ts PRs #386 and #394. It enables bots deployed in specific regions (e.g., Europe, Asia) to use regional token endpoints instead of the global endpoint.

Key changes:

Introduces ApiClientSettings dataclass for OAuth endpoint configuration with environment variable support
Updates all API clients to accept and use configurable OAuth URLs
Adds api_client_settings field to AppOptions for easy configuration at the application level

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/api/src/microsoft/teams/api/clients/api_client_settings.py	New dataclass and utility function for OAuth endpoint configuration
packages/api/src/microsoft/teams/api/clients/init.py	Exports new API client settings classes
packages/api/src/microsoft/teams/api/clients/api_client.py	Accepts and propagates API client settings to all sub-clients
packages/api/src/microsoft/teams/api/clients/bot/client.py	Passes settings to token and sign-in clients
packages/api/src/microsoft/teams/api/clients/bot/sign_in_client.py	Uses configurable OAuth URL with endpoint constants
packages/api/src/microsoft/teams/api/clients/bot/token_client.py	Accepts and stores API client settings
packages/api/src/microsoft/teams/api/clients/user/client.py	Passes settings to token client
packages/api/src/microsoft/teams/api/clients/user/token_client.py	Uses configurable OAuth URL with endpoint constants
packages/api/src/microsoft/teams/api/clients/conversation/client.py	Propagates settings to activity and member clients
packages/api/src/microsoft/teams/api/clients/conversation/activity.py	Accepts API client settings parameter
packages/api/src/microsoft/teams/api/clients/conversation/member.py	Accepts API client settings parameter
packages/api/src/microsoft/teams/api/clients/team/client.py	Accepts and stores API client settings
packages/api/src/microsoft/teams/api/clients/meeting/client.py	Accepts and stores API client settings
packages/apps/src/microsoft/teams/apps/options.py	Adds `api_client_settings` field to app options
packages/apps/src/microsoft/teams/apps/app.py	Passes settings to API client and activity processor
packages/apps/src/microsoft/teams/apps/app_process.py	Accepts and uses settings when building API clients
packages/apps/tests/test_app_process.py	Updates test to pass `None` for new parameter
packages/api/tests/unit/test_user_client.py	Adds 7 new tests for regional endpoint functionality
packages/api/tests/unit/test_bot_client.py	Adds 2 new tests for bot regional endpoints
tests/graph/src/main.py	Adds example usage in comments
tests/graph/README.md	Adds regional bot configuration documentation
packages/mcpplugin/src/microsoft/teams/mcpplugin/server_plugin.py	Formatting change to decorator

Co-authored-by: lilyydu <[email protected]>

## Release 2.0.0a6 ### Changes - Make images required for Thumbnail (#216) - Revert "Add comment" - Add comment - Move tests to examples (#199) - Bump glob from 11.0.3 to 11.1.0 in /tests/tab/Web (#215) - Remove Agents class (#213) - Add signin/failure invoke activity support (#206) - Update config.yml (#214) - Adds a github template when New issues are created (#212) - feat: add OAuth support for regional bots (#209) - [feat] Add BotBuilder Plugin package, sample and tests (#190) Co-authored-by: lilydu <[email protected]>

Initial plan

0f0d7fd

Copilot AI assigned Copilot and lilyydu Nov 11, 2025

Copilot started work on behalf of lilyydu November 11, 2025 18:16 View session

Copilot AI and others added 3 commits November 11, 2025 18:31

Add API client settings for regional OAuth support

1614e8e

Co-authored-by: lilyydu <[email protected]>

Add OAuth settings support in apps package for regional bots

22ebfdf

Co-authored-by: lilyydu <[email protected]>

Fix ActivityProcessor test fixture

5d8efa9

Copilot AI changed the title ~~[WIP] Apply OAuth functionality for regional bots in Python~~ feat: add OAuth support for regional bots Nov 11, 2025

Copilot AI requested a review from lilyydu November 11, 2025 18:45

Copilot finished work on behalf of lilyydu November 11, 2025 18:45

Copilot started work on behalf of lilyydu November 11, 2025 19:22 View session

Refactor ApiClientSettings to top-level AppOptions field

9982511

Co-authored-by: lilyydu <[email protected]>

Copilot finished work on behalf of lilyydu November 11, 2025 19:34

lilyydu reviewed Nov 11, 2025

View reviewed changes

Copilot started work on behalf of lilyydu November 11, 2025 20:01 View session

Apply feedback: simplify API, remove OAuthSettings, update docstrings

80212f5

Co-authored-by: lilyydu <[email protected]>

Copilot finished work on behalf of lilyydu November 11, 2025 20:10

Copilot AI requested a review from lilyydu November 11, 2025 20:10

lilyydu marked this pull request as ready for review November 11, 2025 21:06

Copilot AI review requested due to automatic review settings November 11, 2025 21:06

Copilot started reviewing on behalf of lilyydu November 11, 2025 21:07 View session

Copilot finished reviewing on behalf of lilyydu November 11, 2025 21:09

Copilot AI reviewed Nov 11, 2025

View reviewed changes

Comment thread tests/graph/README.md Outdated

Comment thread tests/graph/README.md Outdated

Comment thread tests/graph/README.md Outdated

Comment thread tests/graph/src/main.py Outdated

update from testing

afbdaf0

This was referenced Nov 11, 2025

[WIP] Apply similar changes for OAuth support in Python #210

Closed

feat: add OAuth support for regional bots microsoft/teams.net#202

Closed

Merge branch 'main' into copilot/feat-allow-oauth-for-regional-bots

0f18ba9

lilyydu approved these changes Nov 13, 2025

View reviewed changes

heyitsaamir reviewed Nov 13, 2025

View reviewed changes

Copilot started work on behalf of lilyydu November 14, 2025 00:07 View session

Remove commented code and fix merge_api_client_settings signature

fe5a0e0

Co-authored-by: lilyydu <[email protected]>

Copilot AI requested a review from lilyydu November 14, 2025 00:18

Copilot finished work on behalf of lilyydu November 14, 2025 00:18

Copilot started work on behalf of lilyydu November 14, 2025 00:20 View session

Move api_client_settings to BaseClient for inheritance

fad0a5c

Co-authored-by: lilyydu <[email protected]>

Copilot finished work on behalf of lilyydu November 14, 2025 00:28

Copilot started work on behalf of lilyydu November 14, 2025 00:29 View session

Copilot finished work on behalf of lilyydu November 14, 2025 00:31

heyitsaamir approved these changes Nov 14, 2025

View reviewed changes

Comment thread packages/api/tests/unit/test_bot_client.py

Comment thread packages/api/tests/unit/test_bot_client.py Outdated

Comment thread packages/api/tests/unit/test_user_client.py

fix tests

c224727

github-advanced-security AI found potential problems Nov 14, 2025

View reviewed changes

Comment thread packages/api/tests/unit/test_user_client.py Dismissed

Comment thread packages/api/tests/unit/test_user_client.py Dismissed

Comment thread packages/api/tests/unit/test_user_client.py Dismissed

lilyydu merged commit 3da24e5 into main Nov 14, 2025
7 checks passed

lilyydu deleted the copilot/feat-allow-oauth-for-regional-bots branch November 14, 2025 22:28

This was referenced Nov 22, 2025

Release 2.0.0a6 #219

Closed

Release 2.0.0a6 #220

Merged

Uh oh!

Conversation

Copilot AI commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plan: Add OAuth Support for Regional Bots ✅ COMPLETE

Summary of Changes

API Layer (packages/api)

Apps Layer (packages/apps)

Example Usage

Testing

Latest Changes

Uh oh!

lilyydu commented Nov 11, 2025

Uh oh!

Copilot AI commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Nov 11, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Nov 11, 2025 •

edited

Loading

API Layer (`packages/api`)

Apps Layer (`packages/apps`)

Copilot AI commented Nov 11, 2025 •

edited

Loading