From 19dcd142f55163c08a97ade608a203c8b4a84239 Mon Sep 17 00:00:00 2001
From: Mike Alhayek <mike@crestapps.com>
Date: Thu, 21 Dec 2023 07:38:26 -0800
Subject: [PATCH] Document ConfigureSecurityStampOptions (#14926)

---
 .../Services/ConfigureSecurityStampOptions.cs                   | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/OrchardCore/OrchardCore.Users.Core/Services/ConfigureSecurityStampOptions.cs b/src/OrchardCore/OrchardCore.Users.Core/Services/ConfigureSecurityStampOptions.cs
index 01cc9d179b2..d255bedb52d 100644
--- a/src/OrchardCore/OrchardCore.Users.Core/Services/ConfigureSecurityStampOptions.cs
+++ b/src/OrchardCore/OrchardCore.Users.Core/Services/ConfigureSecurityStampOptions.cs
@@ -10,6 +10,8 @@ public class ConfigureSecurityStampOptions : IPostConfigureOptions<SecurityStamp
 {
     public void PostConfigure(string name, SecurityStampValidatorOptions options)
     {
+        // While updating the principal, any customized claims set using IUserClaimsProvider
+        // or obtained from an external identity will persist and transfer to the refreshed/new principal.
         options.OnRefreshingPrincipal = principalContext =>
         {
             var currentIdentity = principalContext.CurrentPrincipal?.Identities?.FirstOrDefault();