Promote MsalServiceException.SubError to public

src/client/Microsoft.Identity.Client/Internal/Requests/Silent/CacheSilentStrategy.cs

@@ -237,7 +237,7 @@ private async Task<MsalTokenResponse> TryGetTokenUsingFociAsync(CancellationToke
                     return null;
 #else
                     if (MsalError.InvalidGrantError.Equals(ex?.ErrorCode, StringComparison.OrdinalIgnoreCase) &&
-                        MsalError.ClientMismatch.Equals(ex?.SubError, StringComparison.OrdinalIgnoreCase))
+                        MsalError.ClientMismatch.Equals(ex?.SubErrorForLogging, StringComparison.OrdinalIgnoreCase))
                     {
                         logger.Error("[FOCI] FRT refresh failed - client mismatch. ");
                         return null;

src/client/Microsoft.Identity.Client/MsalServiceException.cs

@@ -205,10 +205,13 @@ public HttpResponseHeaders Headers
 
         #endregion
 
-        /// <remarks>
-        /// The suberror should not be exposed for public consumption yet, as STS needs to do some work first.
-        /// </remarks>
-        internal string SubError { get; set; }
+        /// <summary>
+        /// Sub-error returned by the token service refining <see cref="MsalException.ErrorCode"/>
+        /// (for example <c>consent_required</c>, <c>bad_token</c>, <c>protection_policy_required</c>).
+        /// Values are emitted by the service and may change without notice; intended for diagnostics
+        /// and logging — do not branch production behavior on this value.
+        /// </summary>
+        public string SubErrorForLogging { get; internal set; }
 
         /// <summary>
         /// A list of STS-specific error codes that can help in diagnostics.
@@ -249,7 +252,7 @@ internal override void PopulateJson(JObject jObject)
             jObject[ClaimsKey] = Claims;
             jObject[ResponseBodyKey] = ResponseBody;
             jObject[CorrelationIdKey] = CorrelationId;
-            jObject[SubErrorKey] = SubError;
+            jObject[SubErrorKey] = SubErrorForLogging;
         }
 
         internal override void PopulateObjectFromJson(JObject jObject)
@@ -259,7 +262,7 @@ internal override void PopulateObjectFromJson(JObject jObject)
             Claims = JsonHelper.GetExistingOrEmptyString(jObject, ClaimsKey);
             ResponseBody = JsonHelper.GetExistingOrEmptyString(jObject, ResponseBodyKey);
             CorrelationId = JsonHelper.GetExistingOrEmptyString(jObject, CorrelationIdKey);
-            SubError = JsonHelper.GetExistingOrEmptyString(jObject, SubErrorKey);
+            SubErrorForLogging = JsonHelper.GetExistingOrEmptyString(jObject, SubErrorKey);
         }
         #endregion
     }

src/client/Microsoft.Identity.Client/MsalServiceExceptionFactory.cs

@@ -78,7 +78,7 @@ internal static MsalServiceException FromHttpResponse(
 
             ex.Claims = oAuth2Response?.Claims;
             ex.CorrelationId = oAuth2Response?.CorrelationId;
-            ex.SubError = oAuth2Response?.SubError;
+            ex.SubErrorForLogging = oAuth2Response?.SubError;
             ex.ErrorCodes = oAuth2Response?.ErrorCodes;
 
             return ex;
@@ -168,7 +168,7 @@ internal static MsalServiceException FromBrokerResponse(
             SetHttpExceptionData(ex, brokerHttpResponse);
 
             ex.CorrelationId = correlationId;
-            ex.SubError = subErrorCode;
+            ex.SubErrorForLogging = subErrorCode;
 
             return ex;
         }

src/client/Microsoft.Identity.Client/MsalThrottledServiceException.cs

@@ -23,7 +23,7 @@ public MsalThrottledServiceException(MsalServiceException originalException) :
                 originalException.Message, 
                 originalException.InnerException)
         {
-            SubError = originalException.SubError;
+            SubErrorForLogging = originalException.SubErrorForLogging;
             StatusCode = originalException.StatusCode;
             Claims = originalException.Claims;
             CorrelationId = originalException.CorrelationId;

src/client/Microsoft.Identity.Client/MsalThrottledUiRequiredException.cs

@@ -27,7 +27,7 @@ public MsalThrottledUiRequiredException(MsalUiRequiredException originalExceptio
                 originalException.InnerException, 
                 originalException.Classification)
         {
-            SubError = originalException.SubError;
+            SubErrorForLogging = originalException.SubErrorForLogging;
             StatusCode = originalException.StatusCode;
             Claims = originalException.Claims;
             CorrelationId = originalException.CorrelationId;

src/client/Microsoft.Identity.Client/MsalUiRequiredException.cs

@@ -71,19 +71,19 @@ public UiRequiredExceptionClassification Classification
         {
             get
             {
-                if (string.Equals(base.SubError, MsalError.BasicAction, StringComparison.OrdinalIgnoreCase))
+                if (string.Equals(base.SubErrorForLogging, MsalError.BasicAction, StringComparison.OrdinalIgnoreCase))
                     return UiRequiredExceptionClassification.BasicAction;
 
-                if (string.Equals(base.SubError, MsalError.AdditionalAction, StringComparison.OrdinalIgnoreCase))
+                if (string.Equals(base.SubErrorForLogging, MsalError.AdditionalAction, StringComparison.OrdinalIgnoreCase))
                     return UiRequiredExceptionClassification.AdditionalAction;
 
-                if (string.Equals(base.SubError, MsalError.MessageOnly, StringComparison.OrdinalIgnoreCase))
+                if (string.Equals(base.SubErrorForLogging, MsalError.MessageOnly, StringComparison.OrdinalIgnoreCase))
                     return UiRequiredExceptionClassification.MessageOnly;
 
-                if (string.Equals(base.SubError, MsalError.ConsentRequired, StringComparison.OrdinalIgnoreCase))
+                if (string.Equals(base.SubErrorForLogging, MsalError.ConsentRequired, StringComparison.OrdinalIgnoreCase))
                     return UiRequiredExceptionClassification.ConsentRequired;
 
-                if (string.Equals(base.SubError, MsalError.UserPasswordExpired, StringComparison.OrdinalIgnoreCase))
+                if (string.Equals(base.SubErrorForLogging, MsalError.UserPasswordExpired, StringComparison.OrdinalIgnoreCase))
                     return UiRequiredExceptionClassification.UserPasswordExpired;
 
                 return _classification;

src/client/Microsoft.Identity.Client/PublicApi/net462/PublicAPI.Unshipped.txt

@@ -1,3 +1,4 @@
+Microsoft.Identity.Client.MsalServiceException.SubErrorForLogging.get -> string
 Microsoft.Identity.Client.AzureCloudInstance.GovFr = 5 -> Microsoft.Identity.Client.AzureCloudInstance
 Microsoft.Identity.Client.AzureCloudInstance.GovDe = 6 -> Microsoft.Identity.Client.AzureCloudInstance
-Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance
+Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance

src/client/Microsoft.Identity.Client/PublicApi/net472/PublicAPI.Unshipped.txt

@@ -1,3 +1,4 @@
+Microsoft.Identity.Client.MsalServiceException.SubErrorForLogging.get -> string
 Microsoft.Identity.Client.AzureCloudInstance.GovFr = 5 -> Microsoft.Identity.Client.AzureCloudInstance
 Microsoft.Identity.Client.AzureCloudInstance.GovDe = 6 -> Microsoft.Identity.Client.AzureCloudInstance
-Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance
+Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance

src/client/Microsoft.Identity.Client/PublicApi/net8.0-android/PublicAPI.Unshipped.txt

@@ -1,3 +1,4 @@
+Microsoft.Identity.Client.MsalServiceException.SubErrorForLogging.get -> string
 Microsoft.Identity.Client.AzureCloudInstance.GovFr = 5 -> Microsoft.Identity.Client.AzureCloudInstance
 Microsoft.Identity.Client.AzureCloudInstance.GovDe = 6 -> Microsoft.Identity.Client.AzureCloudInstance
-Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance
+Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance

src/client/Microsoft.Identity.Client/PublicApi/net8.0-ios/PublicAPI.Unshipped.txt

@@ -1,3 +1,4 @@
+Microsoft.Identity.Client.MsalServiceException.SubErrorForLogging.get -> string
 Microsoft.Identity.Client.AzureCloudInstance.GovFr = 5 -> Microsoft.Identity.Client.AzureCloudInstance
 Microsoft.Identity.Client.AzureCloudInstance.GovDe = 6 -> Microsoft.Identity.Client.AzureCloudInstance
-Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance
+Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance

src/client/Microsoft.Identity.Client/PublicApi/net8.0/PublicAPI.Unshipped.txt

@@ -1,3 +1,4 @@
+Microsoft.Identity.Client.MsalServiceException.SubErrorForLogging.get -> string
 Microsoft.Identity.Client.AzureCloudInstance.GovFr = 5 -> Microsoft.Identity.Client.AzureCloudInstance
 Microsoft.Identity.Client.AzureCloudInstance.GovDe = 6 -> Microsoft.Identity.Client.AzureCloudInstance
-Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance
+Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance

src/client/Microsoft.Identity.Client/PublicApi/netstandard2.0/PublicAPI.Unshipped.txt

@@ -1,3 +1,4 @@
+Microsoft.Identity.Client.MsalServiceException.SubErrorForLogging.get -> string
 Microsoft.Identity.Client.AzureCloudInstance.GovFr = 5 -> Microsoft.Identity.Client.AzureCloudInstance
 Microsoft.Identity.Client.AzureCloudInstance.GovDe = 6 -> Microsoft.Identity.Client.AzureCloudInstance
-Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance
+Microsoft.Identity.Client.AzureCloudInstance.GovSg = 7 -> Microsoft.Identity.Client.AzureCloudInstance

tests/Microsoft.Identity.Test.Unit/BrokerTests/BrokerRequestTests.cs

@@ -890,7 +890,7 @@ private void ProtectionPolicyNotEnabled_Throws_Exception_Common(Action<MsalToken
                 {
                     // Assert
                     Assert.AreEqual(BrokerResponseConst.AndroidUnauthorizedClient, ex.ErrorCode);
-                    Assert.AreEqual(BrokerResponseConst.AndroidProtectionPolicyRequired, ex.SubError);
+                    Assert.AreEqual(BrokerResponseConst.AndroidProtectionPolicyRequired, ex.SubErrorForLogging);
 
                     return;
                 }

tests/Microsoft.Identity.Test.Unit/ExceptionTests/MsalExceptionSerializationTests.cs

@@ -62,7 +62,7 @@ public void MsalServiceException_CanSerializeAndDeserializeRoundTrip()
                 Claims = SomeClaims,
                 CorrelationId = SomeCorrelationId,
                 ResponseBody = SomeResponseBody,
-                SubError = SomeSubError
+                SubErrorForLogging = SomeSubError
             };
 
             SerializeDeserializeAndValidate(ex, typeof(MsalServiceException), true);
@@ -76,7 +76,7 @@ public void MsalUiRequiredException_CanSerializeAndDeserializeRoundTrip()
                 Claims = SomeClaims,
                 CorrelationId = SomeCorrelationId,
                 ResponseBody = SomeResponseBody,
-                SubError = SomeSubError
+                SubErrorForLogging = SomeSubError
             };
 
             SerializeDeserializeAndValidate(ex, typeof(MsalUiRequiredException), true);
@@ -108,7 +108,7 @@ private void SerializeDeserializeAndValidate(MsalException ex, Type expectedType
                 Assert.AreEqual(SomeClaims, serviceEx.Claims);
                 Assert.AreEqual(SomeResponseBody, serviceEx.ResponseBody);
                 Assert.AreEqual(SomeCorrelationId, serviceEx.CorrelationId);
-                Assert.AreEqual(SomeSubError, serviceEx.SubError);
+                Assert.AreEqual(SomeSubError, serviceEx.SubErrorForLogging);
             }
         }
     }

tests/Microsoft.Identity.Test.Unit/ExceptionTests/MsalExceptionTests.cs

@@ -154,7 +154,7 @@ private static void ValidateClassification(
             Assert.Contains(ExMessage, msalException.Message);
             Assert.AreEqual("some_claims", msalException.Claims);
             Assert.AreEqual("6347d33d-941a-4c35-9912-a9cf54fb1b3e", msalException.CorrelationId);
-            Assert.AreEqual(suberror ?? "", msalException.SubError);
+            Assert.AreEqual(suberror ?? "", msalException.SubErrorForLogging);
 
             if (expectUiRequiredException)
             {
@@ -194,7 +194,7 @@ public void MsalUiRequiredException_Oauth2Response()
             Assert.AreEqual(ExMessage + " " + MsalErrorMessage.ClaimsChallenge, msalServiceException.Message);
             Assert.AreEqual("some_claims", msalServiceException.Claims);
             Assert.AreEqual("6347d33d-941a-4c35-9912-a9cf54fb1b3e", msalServiceException.CorrelationId);
-            Assert.AreEqual("some_suberror", msalServiceException.SubError);
+            Assert.AreEqual("some_suberror", msalServiceException.SubErrorForLogging);
 
             ValidateExceptionProductInformation(msalException);
         }      
@@ -265,7 +265,7 @@ public void MsalServiceException_HttpResponse_OAuthResponse()
 
             Assert.AreEqual("some_claims", msalServiceException.Claims);
             Assert.AreEqual("6347d33d-941a-4c35-9912-a9cf54fb1b3e", msalServiceException.CorrelationId);
-            Assert.AreEqual("some_suberror", msalServiceException.SubError);
+            Assert.AreEqual("some_suberror", msalServiceException.SubErrorForLogging);
             ValidateExceptionProductInformation(msalException);
 
             // Act
@@ -343,7 +343,7 @@ public void MsalServiceException_FromHttpResponse()
             Assert.AreEqual(responseBody, msalServiceException.ResponseBody);
             Assert.AreEqual(ExMessage + " " + MsalErrorMessage.ClaimsChallenge, msalServiceException.Message);
             Assert.AreEqual((int)statusCode, msalServiceException.StatusCode);
-            Assert.AreEqual("some_suberror", msalServiceException.SubError);
+            Assert.AreEqual("some_suberror", msalServiceException.SubErrorForLogging);
 
             Assert.AreEqual(retryAfterSpan, msalServiceException.Headers.RetryAfter.Delta);
             ValidateExceptionProductInformation(msalException);