Feature: List and Delete API Keys Endpoints

packages/api-gateway/src/middleware/api_key.middleware.ts

@@ -1,5 +1,6 @@
 import {
   Injectable,
+  Logger,
   NestMiddleware,
   Inject,
   OnModuleInit,
@@ -20,6 +21,7 @@ const { JWT_SERVICE_NAME } = JwtProto;
 
 @Injectable()
 export class ApiKeyMiddleware implements NestMiddleware, OnModuleInit {
+  private readonly logger = new Logger(ApiKeyMiddleware.name);
   private apiKeyService: ApiKeyProto.ApiKeyServiceClient;
   private jwtService: JwtProto.JwtServiceClient;
 
@@ -58,19 +60,7 @@ export class ApiKeyMiddleware implements NestMiddleware, OnModuleInit {
       });
       const res = await lastValueFrom(apiKeyValidation);
       req.apiKey = res.key;
-
-      const userJwt = req.headers['x-user-jwt'] as string | undefined;
-      if (userJwt) {
-        try {
-          const userJwtValidation = this.jwtService.validateUserJwt({
-            jwt: userJwt,
-          });
-          const userJwtRes = await lastValueFrom(userJwtValidation);
-          if (userJwtRes.valid && userJwtRes.user) {
-            req.user = userJwtRes.user;
-          }
-        } catch (error) {}
-      }
+      await this.resolveUserFromJwt(req);
 
       next();
     } catch (error) {
@@ -85,18 +75,7 @@ export class ApiKeyMiddleware implements NestMiddleware, OnModuleInit {
 
         req.apiKey = jwtRes.apiKey;
 
-        const userJwt = req.headers['x-user-jwt'] as string | undefined;
-        if (userJwt) {
-          try {
-            const userJwtValidation = this.jwtService.validateUserJwt({
-              jwt: userJwt,
-            });
-            const userJwtRes = await lastValueFrom(userJwtValidation);
-            if (userJwtRes.valid && userJwtRes.user) {
-              req.user = userJwtRes.user;
-            }
-          } catch (error) {}
-        }
+        await this.resolveUserFromJwt(req);
 
         next();
       } catch (error) {
@@ -105,6 +84,24 @@ export class ApiKeyMiddleware implements NestMiddleware, OnModuleInit {
     }
   }
 
+  private async resolveUserFromJwt(req: ApiKeyReq): Promise<void> {
+    const userJwt = req.headers['x-user-jwt'] as string | undefined;
+    if (!userJwt) return;
+
+    try {
+      const result = await lastValueFrom(
+        this.jwtService.validateUserJwt({ jwt: userJwt }),
+      );
+      if (result.valid && result.user) {
+        req.user = result.user;
+      }
+    } catch (error) {
+      this.logger.warn(
+        `x-user-jwt validation failed: ${(error as Error).message}`,
+      );
+    }
+  }
+
   private extractTokenFromHeader(request: Request): string | undefined {
     const [type, token] = request.headers.authorization?.split(' ') ?? [];
     return type === 'Bearer' ? token : undefined;

packages/api-gateway/src/models/auth.dto.ts

@@ -1,26 +1,124 @@
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import { IsNotEmpty } from 'class-validator';
-import { ApiKeyProto, IdentifierProto, JwtProto } from 'juno-proto';
+import {
+  ApiKeyProto,
+  AuthCommonProto,
+  IdentifierProto,
+  JwtProto,
+} from 'juno-proto';
 
 export class IssueApiKeyRequest {
-  @ApiProperty({ description: 'Optional description for key' })
+  @ApiPropertyOptional({
+    description: 'Optional description for key',
+    example: 'Production API key for mobile app',
+  })
   description?: string | undefined;
 
-  @ApiProperty({ description: 'Environment the key will be tied to' })
+  @ApiProperty({
+    description: 'Environment the key will be tied to',
+    example: 'production',
+  })
   @IsNotEmpty()
   environment: string;
 
   @IsNotEmpty()
-  @ApiProperty({ description: 'Project identifier' })
+  @ApiProperty({
+    description: 'Project identifier',
+    example: { name: 'my-project' },
+  })
   project: IdentifierProto.ProjectIdentifier;
 }
 
 export class IssueApiKeyResponse {
-  @ApiProperty({ type: 'string', description: 'The generated API key' })
+  @ApiProperty({
+    description:
+      'The generated API key value (store immediately, not retrievable again)',
+    example: 'a1b2c3d4e5f6...',
+  })
   apiKey: string;
 
+  @ApiProperty({
+    description: 'Environment this key was issued for',
+    example: 'production',
+  })
+  environment: string;
+
+  @ApiProperty({
+    description: 'Description provided at creation',
+    example: 'Production API key for mobile app',
+  })
+  description: string;
+
+  @ApiProperty({
+    description: 'ISO timestamp of key creation',
+    example: '2026-01-01T00:00:00.000Z',
+  })
+  createdAt: string;
+
+  @ApiProperty({ description: 'project identifier for the API key' })
+  project: string;
+
   constructor(res: ApiKeyProto.IssueApiKeyResponse) {
     this.apiKey = res.apiKey;
+    this.environment = res.info?.environment;
+    this.description = res.info?.description;
+    this.createdAt = res.info?.createdAt;
+    this.project = res.info.project.id.toString();
+  }
+}
+
+export class ApiKey {
+  @ApiProperty({
+    description: "The API key's ID in the databse",
+    example: '5',
+  })
+  id: string;
+
+  @ApiProperty({
+    description:
+      'The generated API key value (store immediately, not retrievable again)',
+    example: 'a1b2c3d4e5f6...',
+  })
+  hash: string;
+
+  @ApiProperty({
+    description: 'Description provided at creation',
+    example: 'Production API key for mobile app',
+  })
+  description: string;
+
+  @ApiProperty({
+    description: 'Scopes tied to this API key',
+    example: ['read:projects', 'write:analytics'],
+    type: [String],
+  })
+  scopes: string[];
+
+  @ApiProperty({ description: 'project identifier for the API key' })
+  project: string;
+
+  @ApiProperty({
+    description: 'Environment this key was issued for',
+    example: 'production',
+  })
+  environment: string;
+
+  @ApiProperty({
+    description: 'ISO timestamp of key creation',
+    example: '2026-01-01T00:00:00.000Z',
+  })
+  createdAt: string;
+
+  constructor(res: AuthCommonProto.ApiKey) {
+    this.id = res.id;
+    this.hash = res.hash;
+    this.description = res.description;
+    this.scopes = res.scopes
+      ? res.scopes.map((scope) => scope.toString())
+      : [''];
+    this.environment = res.environment;
+    this.project = res.project.id.toString();
+    this.createdAt = res.createdAt;
   }
 }
 
@@ -32,3 +130,60 @@ export class IssueJWTResponse {
     this.token = res.jwt;
   }
 }
+
+export class PaginationParams {
+  @ApiProperty({
+    description: 'first page of results',
+    example: '/auth/key/?offset=0&limit=5',
+  })
+  first: string;
+  @ApiProperty({
+    description: 'previous page of results',
+    example: '/auth/key/?offset=15&limit=5',
+  })
+  prev: string;
+  @ApiProperty({
+    description: 'next page of results',
+    example: '/auth/key/?offset=20&limit=5',
+  })
+  next: string;
+  @ApiProperty({
+    description: 'last page of results',
+    example: '/auth/key/?offset=25&limit=5',
+  })
+  last: string;
+
+  constructor(res: {
+    first: string;
+    prev: string;
+    next: string;
+    last: string;
+  }) {
+    this.first = res.first;
+    this.prev = res.prev;
+    this.next = res.next;
+    this.last = res.last;
+  }
+}
+export class GetAllApiKeysResponse {
+  @ApiProperty({
+    type: ApiKey,
+    isArray: true,
+    description: 'List of API keys belonging to a project',
+  })
+  keys: ApiKey[];
+
+  @ApiProperty({
+    type: PaginationParams,
+    description: 'Pagination parameters',
+  })
+  links: PaginationParams;
+
+  constructor(res: {
+    keys: AuthCommonProto.ApiKey[];
+    links: PaginationParams;
+  }) {
+    this.keys = (res.keys ?? []).map((key) => new ApiKey(key));
+    this.links = res.links;
+  }
+}