Add acquire_token() public method for cross-resource auth#182
Add acquire_token() public method for cross-resource auth#182athanipavan wants to merge 1 commit into
Conversation
Adds _AuthManager.acquire_token(resource_url) as a thin public helper over the existing _acquire_token: appends /.default and delegates to the underlying TokenCredential. Lets callers reuse the same credential to obtain tokens for any Microsoft AAD-protected resource (notably a linked Finance & Operations env) via client.auth.acquire_token(fno_url). Internal _ODataClient._headers() now goes through the same method, so the DV and external paths share one scope-construction site. Verified end-to-end against a real F&O int env (operations.int.dynamics.com) using AzureCliCredential: token issued with aud=<fno_url>, F&O accepted the token and returned $metadata (HTTP 200, ~53 MB OData XML). Tests: 4 new unit tests in tests/unit/core/test_auth.py (default-scope, trailing-slash strip, alternate resource, empty-URL ValueError); _auth.py coverage 100%. Inline DummyAuth in tests/conftest.py plus three test modules updated to also expose acquire_token so _odata._headers callsites keep passing. Full suite: 1393 passed. Docs: README adds a subsection covering F&O token acquisition; both SKILL.md copies updated (byte-identical per dataverse-sdk-dev contract); CHANGELOG [Unreleased] entry added. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
@athanipavan please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
There was a problem hiding this comment.
Pull request overview
Adds a public client.auth.acquire_token(resource_url) helper so callers can reuse the Dataverse client credential for other Microsoft AAD-protected resources, and routes Dataverse OData header token acquisition through the same scope-construction path.
Changes:
- Added
_AuthManager.acquire_token()with scope construction and unit tests. - Refactored
_ODataClient._headers()to call the new auth helper. - Updated README, changelog, skill docs, and test auth stubs for the expanded auth surface.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
src/PowerPlatform/Dataverse/core/_auth.py |
Adds the public token acquisition helper and related documentation. |
src/PowerPlatform/Dataverse/data/_odata.py |
Refactors header construction to use auth.acquire_token(self.base_url). |
tests/unit/core/test_auth.py |
Adds tests for public token acquisition behavior. |
tests/conftest.py |
Updates shared dummy auth fixture with acquire_token. |
tests/unit/core/test_http_errors.py |
Updates local dummy auth for _headers() refactor. |
tests/unit/data/test_logical_crud.py |
Updates local dummy auth for _headers() refactor. |
tests/unit/data/test_enum_optionset_payload.py |
Updates local dummy auth for _headers() refactor. |
README.md |
Documents acquiring tokens for linked/non-Dataverse Microsoft resources. |
.claude/skills/dataverse-sdk-use/SKILL.md |
Adds skill guidance for cross-resource token acquisition. |
src/PowerPlatform/Dataverse/claude_skill/dataverse-sdk-use/SKILL.md |
Mirrors the skill guidance update in packaged skill docs. |
CHANGELOG.md |
Records the new auth helper under Unreleased. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "https://myenv.operations.dynamics.com" | ||
| ) | ||
| """ | ||
| target = (resource_url or "").rstrip("/") |
| """Build standard OData headers with bearer auth.""" | ||
| scope = f"{self.base_url}/.default" | ||
| token = self.auth._acquire_token(scope).access_token | ||
| token = self.auth.acquire_token(self.base_url) |
| """Build standard OData headers with bearer auth.""" | ||
| scope = f"{self.base_url}/.default" | ||
| token = self.auth._acquire_token(scope).access_token | ||
| token = self.auth.acquire_token(self.base_url) |
| headers = {"Authorization": f"Bearer {fno_token}"} | ||
| ``` | ||
|
|
||
| The `/.default` scope is appended automatically. The customer's AAD app must already have the required permission on the target resource and admin consent granted. For Finance & Operations the standard permissions are `Odata.FullAccess` and `CustomService.FullAccess` on the **Microsoft Dynamics ERP** API (`00000015-0000-0000-c000-000000000000`). |
| headers = {"Authorization": f"Bearer {fno_token}"} | ||
| ``` | ||
|
|
||
| The customer's AAD app must already have the required permission on the target resource. For F&O the standard delegated permissions are `Odata.FullAccess` and `CustomService.FullAccess` on the **Microsoft Dynamics ERP** API (`00000015-0000-0000-c000-000000000000`). |
| headers = {"Authorization": f"Bearer {fno_token}"} | ||
| ``` | ||
|
|
||
| The customer's AAD app must already have the required permission on the target resource. For F&O the standard delegated permissions are `Odata.FullAccess` and `CustomService.FullAccess` on the **Microsoft Dynamics ERP** API (`00000015-0000-0000-c000-000000000000`). |
Summary
_AuthManager.acquire_token(resource_url)-- a thin public helper over the existing_acquire_token: appends/.defaultand delegates to the underlyingTokenCredential. Lets callers reuse the same credential to obtain tokens for any Microsoft AAD-protected resource (notably a linked Finance & Operations env) viaclient.auth.acquire_token(fno_url)._ODataClient._headers()to call the new method, so the DV and external paths share one scope-construction site (no duplication).SKILL.mdcopies, andCHANGELOGupdated. InlineDummyAuthmocks inconftest.pyand three test modules updated to also exposeacquire_tokenso existing_odata._headerstests still pass with the refactored call site.End-to-end verification
Probe against a real F&O int env using the modified SDK +
AzureCliCredential:client.auth.acquire_token("https://aurorabapenvf94ec.operations.int.dynamics.com")audclaim (decoded JWT)https://aurorabapenvf94ec.operations.int.dynamics.com(F&O resource, not DV)GET <fno_url>/data/$metadatawith that tokenMicrosoft.Dynamics.DataEntitiesnamespace)F&O accepted the token. The same code path is taken for DV's own header construction, so the DV experience is unchanged.
Test plan
pytest tests/unit -q-- 1393 passed (4 newacquire_tokentests + existing suite)_auth.pyline coverage: 100%_headers()still usesbase_urlfrom constructor)Notes for reviewers
client.pyis untouched; the new method lives on_AuthManager(single source of truth for scope construction).acquire_tokenwith an F&O URL on its own. Customers explicitly pass the F&O URL when they need it.SKILL.mdcopies verified byte-identical per thedataverse-sdk-devcontract.🤖 Generated with Claude Code