Skip to content

Clarify that allow_broker is not applicable to ConfidentialClientApplication #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions msal/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,8 @@ def __init__(
New in version 1.19.0.

:param boolean allow_broker:
This parameter is NOT applicable to :class:`ConfidentialClientApplication`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a positive statement?

This parameter is ONLY applicable to PublicClientApplication.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I believe the emphasis of this PR and its corresponding issue were to call out the only invalid situation among the three. So, taking your suggestion into account, we can change it to:

This parameter is applicable to PublicClientApplication and its base class ClientApplication, but NOT applicable to ConfidentialClientApplication.

How about that?


A broker is a component installed on your device.
Broker implicitly gives your device an identity. By using a broker,
your device becomes a factor that can satisfy MFA (Multi-factor authentication).
Expand Down