Add authenticated user decorator, closes #43

example/src/app.controller.ts

@@ -1,10 +1,17 @@
 import { Controller, Get } from '@nestjs/common';
+import { AuthenticatedUser } from 'nest-keycloak-connect';
 
 @Controller()
 export class AppController {
-
   @Get()
-  getHello(): string {
-    return "Hello world!";
+  getHello(
+    @AuthenticatedUser()
+    user: any,
+  ): string {
+    if (user) {
+      return `Hello ${user.preferred_username}`;
+    } else {
+      return 'Hello world!';
+    }
   }
 }

src/decorators/authenticated-user.decorator.ts

@@ -0,0 +1,12 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+/**
+ * Retrieves the current Keycloak logged-in user.
+ * @since 1.5.0
+ */
+export const AuthenticatedUser = createParamDecorator(
+  (data: unknown, ctx: ExecutionContext) => {
+    const req = ctx.switchToHttp().getRequest();
+    return req.user;
+  },
+);

src/keycloak-connect.module.ts

@@ -12,6 +12,7 @@ export * from './decorators/roles.decorator';
 export * from './decorators/allow-any-role.decorator';
 export * from './decorators/unprotected.decorator';
 export * from './decorators/enforcer-options.decorator';
+export * from './decorators/authenticated-user.decorator';
 export * from './guards/auth.guard';
 export * from './guards/resource.guard';
 export * from './guards/role.guard';