-
Notifications
You must be signed in to change notification settings - Fork 310
Expand file tree
/
Copy pathdevices.controller.ts
More file actions
260 lines (254 loc) · 7.13 KB
/
devices.controller.ts
File metadata and controls
260 lines (254 loc) · 7.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
import { Controller, Delete, Get, HttpCode, Param, UseGuards } from '@nestjs/common';
import {
ApiOperation,
ApiParam,
ApiResponse,
ApiSecurity,
ApiTags,
} from '@nestjs/swagger';
import { AuthContext, OrganizationId } from '../auth/auth-context.decorator';
import { HybridAuthGuard } from '../auth/hybrid-auth.guard';
import { PermissionGuard } from '../auth/permission.guard';
import { RequirePermission } from '../auth/require-permission.decorator';
import type { AuthContext as AuthContextType } from '../auth/types';
import { DevicesByMemberResponseDto } from './dto/devices-by-member-response.dto';
import { DevicesService } from './devices.service';
@ApiTags('Devices')
@Controller({ path: 'devices', version: '1' })
@UseGuards(HybridAuthGuard, PermissionGuard)
@RequirePermission('app', 'read')
@ApiSecurity('apikey')
export class DevicesController {
constructor(private readonly devicesService: DevicesService) {}
@Get()
@ApiOperation({
summary: 'Get all devices',
description:
'Returns all devices for the authenticated organization from FleetDM. Supports both API key authentication (X-API-Key header) and session authentication (Bearer token or cookies).',
})
@ApiResponse({
status: 200,
description: 'Devices retrieved successfully',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
data: {
type: 'array',
items: { $ref: '#/components/schemas/DeviceResponseDto' },
},
count: {
type: 'number',
description: 'Total number of devices',
example: 25,
},
authType: {
type: 'string',
enum: ['api-key', 'session'],
description: 'How the request was authenticated',
},
authenticatedUser: {
type: 'object',
properties: {
id: {
type: 'string',
description: 'User ID',
example: 'usr_abc123def456',
},
email: {
type: 'string',
description: 'User email',
example: 'user@company.com',
},
},
},
},
},
},
},
})
@ApiResponse({
status: 401,
description:
'Unauthorized - Invalid authentication or insufficient permissions',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
message: {
type: 'string',
example: 'Invalid or expired API key',
},
},
},
},
},
})
@ApiResponse({
status: 404,
description: 'Organization not found',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
message: {
type: 'string',
example: 'Organization with ID org_abc123def456 not found',
},
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Internal server error - FleetDM integration issue',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
message: {
type: 'string',
example: 'Organization does not have FleetDM configured',
},
},
},
},
},
})
async getAllDevices(
@OrganizationId() organizationId: string,
@AuthContext() authContext: AuthContextType,
) {
const devices =
await this.devicesService.findAllByOrganization(organizationId);
return {
data: devices,
count: devices.length,
authType: authContext.authType,
...(authContext.userId &&
authContext.userEmail && {
authenticatedUser: {
id: authContext.userId,
email: authContext.userEmail,
},
}),
};
}
@Get('member/:memberId')
@ApiOperation({
summary: 'Get devices by member ID',
description:
"Returns all devices assigned to a specific member within the authenticated organization. Devices are fetched from FleetDM using the member's dedicated fleetDmLabelId. Supports both API key authentication (X-API-Key header) and session authentication (Bearer token or cookies).",
})
@ApiParam({
name: 'memberId',
description: 'Member ID to get devices for',
example: 'mem_abc123def456',
})
@ApiResponse({
status: 200,
description: 'Member devices retrieved successfully',
type: DevicesByMemberResponseDto,
})
@ApiResponse({
status: 401,
description:
'Unauthorized - Invalid authentication or insufficient permissions',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
message: { type: 'string', example: 'Unauthorized' },
},
},
},
},
})
@ApiResponse({
status: 404,
description: 'Organization or member not found',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
message: {
type: 'string',
example:
'Member with ID mem_abc123def456 not found in organization org_abc123def456',
},
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Internal server error - FleetDM integration issue',
})
async getDevicesByMember(
@Param('memberId') memberId: string,
@OrganizationId() organizationId: string,
@AuthContext() authContext: AuthContextType,
): Promise<DevicesByMemberResponseDto> {
const [devices, member] = await Promise.all([
this.devicesService.findAllByMember(organizationId, memberId),
this.devicesService.getMemberById(organizationId, memberId),
]);
return {
data: devices,
count: devices.length,
member,
authType: authContext.authType,
...(authContext.userId &&
authContext.userEmail && {
authenticatedUser: {
id: authContext.userId,
email: authContext.userEmail,
},
}),
};
}
@Delete(':id')
@RequirePermission('member', 'delete')
@HttpCode(204)
@ApiOperation({
summary: 'Delete device',
description:
'Deletes a single device in the authenticated organization. Only organization owners can delete devices.',
})
@ApiParam({
name: 'id',
description: 'Device ID to delete',
example: 'dev_abc123def456',
})
@ApiResponse({
status: 204,
description: 'Device deleted successfully',
})
@ApiResponse({
status: 403,
description: 'Forbidden - only organization owners can delete devices',
})
@ApiResponse({
status: 404,
description: 'Organization or device not found',
})
async deleteDevice(
@Param('id') id: string,
@OrganizationId() organizationId: string,
@AuthContext() authContext: AuthContextType,
): Promise<void> {
await this.devicesService.removeDeviceById({
organizationId,
deviceId: id,
userId: authContext.userId,
});
}
}