Skip to content

Update DeviceCodeRequest/UsernamePasswordRequest to utilize OAuth2Value.ReservedScopes rather than individual constants #5426

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update DeviceCodeRequest/UsernamePasswordRequest to utilize OAuth2Value.ReservedScopes rather than individual constants #5426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions src/client/Microsoft.Identity.Client/Internal/Requests/DeviceCodeRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,8 @@ protected override async Task<AuthenticationResult> ExecuteAsync(CancellationTok

var client = new OAuth2Client(ServiceBundle.ApplicationLogger, ServiceBundle.HttpManager, null);

var deviceCodeScopes = new HashSet<string>();
deviceCodeScopes.UnionWith(AuthenticationRequestParameters.Scope);
deviceCodeScopes.Add(OAuth2Value.ScopeOfflineAccess);
deviceCodeScopes.Add(OAuth2Value.ScopeProfile);
deviceCodeScopes.Add(OAuth2Value.ScopeOpenId);
var deviceCodeScopes = new HashSet<string>(AuthenticationRequestParameters.Scope);
deviceCodeScopes.UnionWith(OAuth2Value.ReservedScopes);
Copy link
Member

@bgavrilMS bgavrilMS Aug 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

ReservedScopes are just offlineaccess + profile + openId

https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/blob/main/src/client/Microsoft.Identity.Client/OAuth2/OAuthConstants.cs#L102

What is the actual issue you are seeing? Is it perf related?

Copy link
Author

Choose a reason for hiding this comment

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

Yes, there is no performance or functional difference sought here. The somewhat justifiable intent was to bring these token clients into alignment with TokenClient.GetDefaultScopes(), i.e., consistent use of UnionWith the parameterized scopes.

But full disclosure, I have a (mostly) OIDC-compatible provider that doesn't tolerate the offline_access scope in some cases and another that doesn't take profile on a token request, and this change makes makes patch maintenance more straightforward (and also allows for reflection-based patching of the reserved scopes across all grant types per-provider). Obviously I would have preferred that 6412672 had been merged.


client.AddBodyParameter(OAuth2Parameter.ClientId, AuthenticationRequestParameters.AppConfig.ClientId);
client.AddBodyParameter(OAuth2Parameter.Scope, deviceCodeScopes.AsSingleString());
Expand Down
9 changes: 2 additions & 7 deletions src/client/Microsoft.Identity.Client/Internal/Requests/UsernamePasswordRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,14 +187,9 @@ private Dictionary<string, string> GetAdditionalBodyParameters(UserAssertion use
dict[OAuth2Parameter.Password] = _usernamePasswordParameters.Password;
}

ISet<string> unionScope = new HashSet<string>()
{
OAuth2Value.ScopeOpenId,
OAuth2Value.ScopeOfflineAccess,
OAuth2Value.ScopeProfile
};
var unionScope = new HashSet<string>(AuthenticationRequestParameters.Scope);
unionScope.UnionWith(OAuth2Value.ReservedScopes);

unionScope.UnionWith(AuthenticationRequestParameters.Scope);
dict[OAuth2Parameter.Scope] = unionScope.AsSingleString();
dict[OAuth2Parameter.ClientInfo] = "1";

Expand Down