Skip to content

Commit 8e75e49

Browse files
committed
Fine tune API docs
1 parent b282045 commit 8e75e49

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

msal/application.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,10 +646,19 @@ def acquire_token_on_behalf_of(self, user_assertion, scopes, **kwargs):
646646
representing an end user.
647647
The current app can use such token (a.k.a. a user assertion) to request
648648
another token to access downstream service, on behalf of that user.
649+
See `detail docs here <https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow>`_ .
649650
650651
The current middle-tier app has no user interaction to obtain consent.
651652
See how to gain consent upfront for your middle-tier app from this article.
652653
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application
654+
655+
:param str user_assertion: The incoming token already received by this app
656+
:param list[str] scopes: Scopes required by downstream API (a resource).
657+
658+
:return: A dict representing the json response from AAD:
659+
660+
- A successful response would contain "access_token" key,
661+
- an error response would contain "error" and usually "error_description".
653662
"""
654663
# The implementation is NOT based on Token Exchange
655664
# https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16

0 commit comments

Comments
 (0)