Skip to content

Add acquire_token() public method for cross-resource auth#182

Open
athanipavan wants to merge 1 commit into
microsoft:mainfrom
athanipavan:pathani/fno-acquire-token
Open

Add acquire_token() public method for cross-resource auth#182
athanipavan wants to merge 1 commit into
microsoft:mainfrom
athanipavan:pathani/fno-acquire-token

Conversation

@athanipavan
Copy link
Copy Markdown

Summary

  • Adds _AuthManager.acquire_token(resource_url) -- 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).
  • Refactors internal _ODataClient._headers() to call the new method, so the DV and external paths share one scope-construction site (no duplication).
  • README, both SKILL.md copies, and CHANGELOG updated. Inline DummyAuth mocks in conftest.py and three test modules updated to also expose acquire_token so existing _odata._headers tests still pass with the refactored call site.

End-to-end verification

Probe against a real F&O int env using the modified SDK + AzureCliCredential:

Step Result
client.auth.acquire_token("https://aurorabapenvf94ec.operations.int.dynamics.com") Token issued, length 2948
Token aud claim (decoded JWT) https://aurorabapenvf94ec.operations.int.dynamics.com (F&O resource, not DV)
GET <fno_url>/data/$metadata with that token HTTP 200, ~53 MB of F&O EDMX (Microsoft.Dynamics.DataEntities namespace)

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 new acquire_token tests + existing suite)
  • _auth.py line coverage: 100%
  • Manual end-to-end probe against live F&O env (HTTP 200 + correct token audience)
  • DV-only flows unchanged (no extra AAD roundtrips; _headers() still uses base_url from constructor)

Notes for reviewers

  • client.py is untouched; the new method lives on _AuthManager (single source of truth for scope construction).
  • F&O usage is fully opt-in: the SDK never calls acquire_token with an F&O URL on its own. Customers explicitly pass the F&O URL when they need it.
  • Both SKILL.md copies verified byte-identical per the dataverse-sdk-dev contract.

🤖 Generated with Claude Code

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>
Copilot AI review requested due to automatic review settings May 14, 2026 10:18
@athanipavan athanipavan requested a review from a team as a code owner May 14, 2026 10:18
@microsoft-github-policy-service
Copy link
Copy Markdown

@athanipavan please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Comment thread README.md
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`).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants