Mark SecurityTokenUnableToValidateException as obsolete with guidance (…

…#2060)
AzureAD · Apr 25, 2023 · 3db0e02 · 3db0e02
1 parent 3d91c43
commit 3db0e02
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/Microsoft.IdentityModel.Tokens/Exceptions/SecurityTokenUnableToValidateException.cs b/src/Microsoft.IdentityModel.Tokens/Exceptions/SecurityTokenUnableToValidateException.cs
@@ -11,7 +11,15 @@ namespace Microsoft.IdentityModel.Tokens
     /// and when validation errors exist over the security token. This exception is not intended to be used as a signal
     /// to refresh keys.
     /// </summary>
+    /// <remarks>
+    /// This exception type is now considered obsolete and will be removed in the next major version (7.0.0).
+    /// </remarks>
     [Serializable]
+    [Obsolete(
+        "This expception is no longer being thrown by Microsoft.IdentityModel and will be removed in the next major " +
+        "version see: https://aka.ms/SecurityTokenUnableToValidateException",
+        false)]
+    [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
     public class SecurityTokenUnableToValidateException : SecurityTokenInvalidSignatureException
     {
         [NonSerialized]