Add GetUserId and GetRequireUserId to resolve UserId from API Key or ClaimsPrincipal

mythz · mythz · commit d0b6acf38cc4 · 2025-11-28T18:46:57.000+08:00
diff --git a/ServiceStack/src/ServiceStack/ServerClaimUtils.cs b/ServiceStack/src/ServiceStack/ServerClaimUtils.cs
@@ -0,0 +1,28 @@
+#nullable enable
+using ServiceStack.Web;
+
+namespace ServiceStack;
+
+public static class ServerClaimUtils
+{
+    /// <summary>
+    /// Retrieves the User Id associated with the request from either API Key or ClaimsPrincipal.
+    /// </summary>
+    public static string? GetUserId(this IRequest? req)
+    {
+        var apiKeyUserId = req.GetApiKey()?.UserAuthId;
+        if (apiKeyUserId != null)
+            return apiKeyUserId;
+        var user = req.GetClaimsPrincipal();
+        return user.IsAuthenticated()
+            ? user.GetUserId()
+            : null;
+    }
+
+    /// <summary>
+    /// Retrieves the required User Id associated with the request from either API Key or ClaimsPrincipal.
+    /// Throws an unauthorized exception if the User Id is not available.
+    /// </summary>
+    public static string GetRequiredUserId(this IRequest? req) => req.GetUserId()
+        ?? throw HttpError.Unauthorized("User Authentication required");
+}
diff --git a/ServiceStack/tests/ServiceStack.WebHost.Endpoints.Tests/AutoQueryTests.cs b/ServiceStack/tests/ServiceStack.WebHost.Endpoints.Tests/AutoQueryTests.cs
@@ -841,6 +841,8 @@ public async Task<object> Any(QueryMovies query)
         {
             using var db = AutoQuery.GetDb(query, base.Request);
             var q = AutoQuery.CreateQuery(query, base.Request, db);
+            var userId = Request.GetClaimsPrincipal().GetUserId();
+            q.Where(x => x.Rating == "PG-13");
             return await AutoQuery.ExecuteAsync(query, q, base.Request, db);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -841,6 +841,8 @@ public async Task<object> Any(QueryMovies query)`
`841`	`841`	`{`
`842`	`842`	`using var db = AutoQuery.GetDb(query, base.Request);`
`843`	`843`	`var q = AutoQuery.CreateQuery(query, base.Request, db);`
	`844`	`+ var userId = Request.GetClaimsPrincipal().GetUserId();`
	`845`	`+ q.Where(x => x.Rating == "PG-13");`
`844`	`846`	`return await AutoQuery.ExecuteAsync(query, q, base.Request, db);`
`845`	`847`	`}`
`846`	`848`	`}`