Native Auth Backward Compatibility feature, Fixes AB#3287604 #2669

Yuki-YuXin · 2025-06-12T15:46:57Z

Related msal PR: AzureAD/microsoft-authentication-library-for-android#2305
Fixes AB#{3287604}

Native Auth Backward Compatibility feature includes:

Add capabilities parameter to native auth public client application initialization, Fixes AB#3287412, Closed AB#3287412
Add capabilities parameter to the flow start operations, Fixes AB#3288182, Closed AB#3288182
Handle redirect across all endpoints and return the redirect reason to the developers, Closed AB#3288191

The main addition to this PR is the testing section

…nitialization, Fixes AB#3287412, Closed AB#3287412 (#2656) Fixes [AB#3287412](https://identitydivision.visualstudio.com/Engineering/_workitems/edit/3287412) Related msal PR: AzureAD/microsoft-authentication-library-for-android#2303

…8182, Closed AB#3288182 (#2658) Fixes [AB#3288182](https://dev.azure.com/IdentityDivision/Engineering/_workitems/edit/3288182) 1. __BaseNativeAuthCommandParameters.java__ - Added `capabilities` field to the base command parameters class 2. __SignInInitiateRequest.kt__ - Added `capabilities` parameter to the sign-in initiate request 3. __SignUpStartRequest.kt__ - Added `capabilities` parameter to the sign-up start request 4. __ResetPasswordStartRequest.kt__ - Added `capabilities` parameter to the reset password start request 5. __NativeAuthRequestProvider.kt__ - Updated to pass capabilities from configuration to requests 6. __NativeAuthOAuth2Configuration.kt__ - Added `capabilities` property to the configuration class pipeline failed due to the broker step.

…o the developers, Closed AB#3288191 (#2660) Fixes [AB#3288191](https://identitydivision.visualstudio.com/Engineering/_workitems/edit/3288191) Related msal PR: AzureAD/microsoft-authentication-library-for-android#2304 Pipeline failed reason: NativeAuthOAuth2Strategy needs both request and response and capabilities configuration together.

…tibility

github-actions · 2025-06-12T15:47:09Z

❌ Work item link check failed. Description does not contain AB#{ID}.

Click here to Learn more.

…x StrategyTest

Copilot

Pull Request Overview

This PR adds backward compatibility support for redirect-based authentication flows by introducing Redirect result types, propagating a new redirectReason field throughout requests, responses, handlers, controllers, and tests, and adds a capabilities parameter to request configuration.

Introduce Redirect cases in JIT, sign-in, sign-up, and reset-password result and response classes
Add a nullable capabilities parameter to request models and propagate it through providers
Update NativeAuthResponseHandler, NativeAuthMsalController, and integration/test suites to handle redirect flows

Reviewed Changes

Copilot reviewed 50 out of 50 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/responses/jit/JITContinueApiResult.kt	Added `Redirect` result type with `redirectReason`
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/responses/jit/JITContinueApiResponse.kt	Extended parsing to detect redirect and wire into new `Redirect` result
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/responses/jit/JITChallengeApiResult.kt	Added `Redirect` case for JIT challenge
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/responses/jit/JITChallengeApiResponse.kt	Updated response logic to handle redirect responses
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/signup/SignUpStartRequest.kt	Introduced `capabilities` field to sign-up start request
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/signin/SignInInitiateRequest.kt	Introduced `capabilities` field to sign-in initiate request
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/resetpassword/ResetPasswordStartRequest.kt	Introduced `capabilities` field to reset-password start request
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthResponseHandler.kt	Populated `redirectReason` default/null and branched on `isRedirect()`
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthRequestProvider.kt	Passed `config.capabilities` into request constructors
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthOAuth2Configuration.kt	Added optional `capabilities` to configuration
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthConstants.kt	Defined `Capabilities` constants and documented usage
common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/INativeAuthApiResponse.kt	Replaced `IApiResponse` with `INativeAuthApiResponse` adding `redirectReason`
common4j/src/main/com/microsoft/identity/common/java/nativeauth/controllers/results/INativeAuthCommandResult.kt	Updated `Redirect` command result to include `redirectReason`
common4j/src/main/com/microsoft/identity/common/java/nativeauth/commands/parameters/BaseNativeAuthCommandParameters.java	Added `capabilities` field for logging and parameter propagation
common/src/test/java/com/microsoft/identity/common/nativeauth/util/CommandResultUtilTest.kt	Added test vector for `Redirect` in `CommandResultUtil`
common/src/test/java/com/microsoft/identity/common/internal/providers/microsoft/nativeauth/integration/SignUpOAuth2StrategyTest.kt	New integration test for sign-up redirect flow
common/src/test/java/com/microsoft/identity/common/internal/providers/microsoft/nativeauth/integration/SignInOAuthStrategyTest.kt	Renamed and added redirect case for sign-in challenge
common/src/test/java/com/microsoft/identity/common/internal/providers/microsoft/nativeauth/integration/ResetPasswordOAuth2StrategyTest.kt	Added redirect test cases for reset-password flows
common/src/test/java/com/microsoft/identity/common/internal/providers/microsoft/nativeauth/integration/JITOAuthStrategyTest.kt	New JIT integration tests covering redirect behaviour
common/src/main/java/com/microsoft/identity/common/nativeauth/internal/controllers/NativeAuthMsalController.kt	Extended controller branches to handle `Redirect` results

Comments suppressed due to low confidence (2)

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthConstants.kt:74

The comment refers to MFARequired and RegistrationRequired but the constants are named MFA_REQUIRED and REGISTRATION_REQUIRED; updating the docs to match the actual constant names will avoid confusion.

*      MFARequired: The application can accommodate ...

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/signup/SignUpStartRequest.kt:99

[nitpick] The toString() implementation omits the new capabilities field; consider including it to reflect the full parameters in logs.

override fun toString(): String = "NativeAuthRequestSignUpStartRequestParameters(clientId=$clientId)"

Copilot · 2025-06-13T14:32:42Z

...om/microsoft/identity/common/java/nativeauth/providers/responses/jit/JITContinueApiResult.kt

+        val redirectReason: String
+    ) : JITContinueApiResult {
+        override fun toUnsanitizedString(): String {
+            return "Redirect(correlationId=$correlationId, redirectReason=$redirectReason)"


[nitpick] Consider adding the class qualifier for clarity, e.g. JITContinueApiResult.Redirect(...), to distinguish this string from other Redirect cases.

Suggested change

return "Redirect(correlationId=$correlationId, redirectReason=$redirectReason)"

return "JITContinueApiResult.Redirect(correlationId=$correlationId, redirectReason=$redirectReason)"

Good suggestion but tend to keep alignment the existing common practice.

Copilot · 2025-06-13T14:32:43Z

...rc/main/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthResponseHandler.kt

@@ -89,6 +90,7 @@ class NativeAuthResponseHandler {
                unverifiedAttributes = null,
                invalidAttributes = null,
                challengeType = null,
+                redirectReason = null,


[nitpick] There's a lot of repeated redirectReason = null across handlers; consider refactoring into a helper or relying on default constructor values to reduce boilerplate.

Good suggestion. Did default constructor before. But tend to be explicit on the parameters.

...microsoft/identity/common/java/nativeauth/providers/responses/jit/JITChallengeApiResponse.kt

Yuki-YuXin · 2025-06-13T15:04:04Z

A hit for the change log update after final review.

…into feature/backward-compatibility

.../identity/common/internal/providers/microsoft/nativeauth/integration/JITOAuthStrategyTest.kt

fadidurah · 2025-06-19T21:57:38Z

...j/src/main/com/microsoft/identity/common/java/providers/oauth2/OAuth2StrategyParameters.java

@@ -51,6 +51,9 @@ public class OAuth2StrategyParameters {
    @Nullable
    public final List<String> mChallengeTypes;

+    @Nullable
+    public final List<String> mCapabilities;


Let's put a comment here for clarity

Done. Updated both challenge type and capabilities.

Fixes [AB#{3287604}](https://dev.azure.com/IdentityDivision/Engineering/_workitems/edit/3287604) Related common PR: AzureAD/microsoft-authentication-library-common-for-android#2669 Native Auth Backward Compatibility feature includes: - [Add capabilities parameter to native auth public client application initialization, Fixes AB#3287412](6d55346) - [Handle redirect across all endpoints and return the redirect reason to the developers, Fixes AB#3288191](a121610) - [Use parameter instead of config when initialization](#2313) The main addition to this PR is the testing section

Yuki-YuXin and others added 4 commits June 4, 2025 16:20

Merge remote-tracking branch 'origin/dev' into feature/backward-compa…

3e46dca

…tibility

Yuki-YuXin and others added 3 commits June 12, 2025 18:16

@transient to abstract class and @SerializedName to child class to fi…

38432d2

…x StrategyTest

Redirect integration tests

08fe454

Merge branch 'dev' into feature/backward-compatibility

a516a7a

Yuki-YuXin requested a review from Copilot June 13, 2025 14:29

Copilot AI reviewed Jun 13, 2025

View reviewed changes

Yuki-YuXin added Skip-Consumers-Check Only include this if making a breaking change purposefully, and there is an MSAL/ADAL/Broker PR native-auth labels Jun 13, 2025

Yuki-YuXin mentioned this pull request Jun 13, 2025

Native Auth Backward Compatibility feature, Fixes AB#3287604 AzureAD/microsoft-authentication-library-for-android#2305

Merged

Yuki-YuXin changed the title ~~Native Auth Backward Compatibility feature~~ Native Auth Backward Compatibility feature, Fixes 3287604 Jun 13, 2025

Yuki-YuXin changed the title ~~Native Auth Backward Compatibility feature, Fixes 3287604~~ Native Auth Backward Compatibility feature, Fixes AB#3287604 Jun 13, 2025

Merge branch 'dev' into feature/backward-compatibility

694e23b

Yuki-YuXin marked this pull request as ready for review June 16, 2025 12:17

Yuki-YuXin requested review from a team as code owners June 16, 2025 12:17

Yuki-YuXin and others added 8 commits June 16, 2025 18:36

Nit: StrategyTest CAPABILITIES

f9fea66

Authority and Command add capabilities

3130bd6

Remove whenever(mockConfig.capabilities).thenReturn(CAPABILITIES)

7bfdc5c

Address copilot comments

d2673bc

Merge branch 'dev' into feature/backward-compatibility

1f3b673

Merge remote-tracking branch 'origin/feature/backward-compatibility' …

2990597

…into feature/backward-compatibility

changelog.txt update

98c8a28

changelog.txt update

83ff9ec

Yuki-YuXin added the skip AB ID validation label Jun 18, 2025

nilo-ms reviewed Jun 18, 2025

View reviewed changes

.../identity/common/internal/providers/microsoft/nativeauth/integration/JITOAuthStrategyTest.kt Show resolved Hide resolved

nilo-ms reviewed Jun 18, 2025

View reviewed changes

.../identity/common/internal/providers/microsoft/nativeauth/integration/JITOAuthStrategyTest.kt Show resolved Hide resolved

Yuki-YuXin and others added 3 commits June 18, 2025 17:40

Address comments: 1) update the comment 2) add redirect reason assertion

9579968

Tidy up import

497dea3

Merge branch 'dev' into feature/backward-compatibility

07c027f

nilo-ms approved these changes Jun 19, 2025

View reviewed changes

Yuki-YuXin changed the title ~~Native Auth Backward Compatibility feature, Fixes AB#3287604~~ Native Auth Backward capability feature, Fixes AB#3287604 Jun 19, 2025

Yuki-YuXin changed the title ~~Native Auth Backward capability feature, Fixes AB#3287604~~ Native Auth Backward Compatibility feature, Fixes AB#3287604 Jun 19, 2025

fadidurah reviewed Jun 19, 2025

View reviewed changes

fadidurah approved these changes Jun 19, 2025

View reviewed changes

Add comment for the parameter

f6453f5

nilo-ms approved these changes Jun 20, 2025

View reviewed changes

Yuki-YuXin merged commit 73483c8 into dev Jun 20, 2025
19 of 20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Native Auth Backward Compatibility feature, Fixes AB#3287604 #2669

Native Auth Backward Compatibility feature, Fixes AB#3287604 #2669

Uh oh!

Yuki-YuXin commented Jun 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jun 13, 2025

Uh oh!

Yuki-YuXin Jun 18, 2025

Uh oh!

Copilot AI Jun 13, 2025

Uh oh!

Yuki-YuXin Jun 18, 2025

Uh oh!

Uh oh!

Yuki-YuXin commented Jun 13, 2025

Uh oh!

Uh oh!

Uh oh!

fadidurah Jun 19, 2025

Uh oh!

Yuki-YuXin Jun 20, 2025

Uh oh!

Uh oh!

Uh oh!

	return "Redirect(correlationId=$correlationId, redirectReason=$redirectReason)"
	return "JITContinueApiResult.Redirect(correlationId=$correlationId, redirectReason=$redirectReason)"

Native Auth Backward Compatibility feature, Fixes AB#3287604 #2669

Native Auth Backward Compatibility feature, Fixes AB#3287604 #2669

Uh oh!

Conversation

Yuki-YuXin commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Yuki-YuXin Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Yuki-YuXin Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Yuki-YuXin commented Jun 13, 2025

Uh oh!

Uh oh!

Uh oh!

fadidurah Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

Yuki-YuXin Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Yuki-YuXin commented Jun 12, 2025 •

edited

Loading