-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-spec.yaml
207 lines (200 loc) · 7.65 KB
/
api-spec.yaml
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
# Copyright (c) 2024 Jamf
openapi: 3.0.0
info:
title: Jamf
description: Get inventory data from Jamf Pro for a macOS device by providing its serial number.
version: v1.0.0
servers:
- url: {InstanceURL}
paths:
/JSSResource/computers/serialnumber/{serialNumber}:
get:
operationId: Raw Inventory Record
description: |
Get entire macOS inventory record from Jamf Pro by providing its serial number
#ExamplePrompt Give me a summary of what you know about H2WFP7BPQ6NV
summary: Get raw unabridged inventory record of a macOS device using its serial number from Jamf Pro.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
deprecated: false
/JSSResource/computers/serialnumber/{serialNumber}/subset/General&Location:
get:
operationId: General and Location Info
description: |
Get General information (host name, username, last checkin, last inventory update ip address, jamf version, and more) from the inventory record by serial number.
#ExamplePrompt When was the last time this mac checked in? H2WFP7BPQ6NV
summary: Get General information from the inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
/JSSResource/computers/serialnumber/{serialNumber}/subset/Hardware&Security:
get:
operationId: Hardware and Security Info
description: |
Get macOS Hardware info and Security settings (model ID, os version, Filevault status, SIP status, Gatekeeper status, XProtect version, firewall status and more) from the inventory record in Jamf Pro by providing serial number.
#ExamplePrompt Does this mac have Gatekeeper disabled? H2WFP7BPQ6NV
#ExamplePrompt Do you see any security configuration gaps for H2WFP7BPQ6NV?
#ExamplePrompt What's the filevault status for H2WFP7BPQ6NV?
#ExamplePrompt What os version is H2WFP7BPQ6NV on?
summary: Get Hardware info and Security settings from the inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
/JSSResource/computers/serialnumber/{serialNumber}/subset/Certificates:
get:
operationId: Certificates Info
description: |
Get Certificates information for a macOS device from the Jamf Pro inventory record by providing the macOS serial number.
#ExamplePrompt List the certficiates that are installed on this mac H2WFP7BPQ6NV
summary: Get Certificates information from the inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
/JSSResource/computers/serialnumber/{serialNumber}/subset/Software:
get:
operationId: Software Info
description: |
Get macOS software information (installed applications, available updates, fonts, plugins and more) for an endpoint from the Jamf Pro inventory record by providing the mac serial number.
#ExamplePrompt What applications are installed on H2WFP7BPQ6NV?
#ExamplePrompt What version of Firefox is installed on H2WFP7BPQ6NV?
#ExamplePrompt Does the mac H2WFP7BPQ6NV appear to have any suspicious applications installed?
summary: Get macOS software information from the jamf inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
/JSSResource/computers/serialnumber/{serialNumber}/subset/ExtensionAttributes:
get:
operationId: Extension Attributes Info
description: |
Get custom (specific to the cusotmer) attribute information for a macOS endpoint from the Jamf inventory record by providing the mac serial number.
#ExamplePrompt What custom data points is jamf collecting on this mac H2WFP7BPQ6NV?
#Example What is the value of [insert customer specific inventory attribute] for this mac H2WFP7BPQ6NV?
summary: Get custom attributes information from the inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
/JSSResource/computers/serialnumber/{serialNumber}/subset/GroupsAccounts:
get:
operationId: Groups Info
description: |
Get group membership (Jamf Pro smart and static groups) information for a macOS endpoint from the jamf inventory record by providing the mac serial number.
#ExamplePrompt what smart groups is this mac a member of H2WFP7BPQ6NV?
summary: Get Groups (Jamf Pro smart and static group memberships) information from the inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []
/JSSResource/computers/serialnumber/{serialNumber}/subset/ConfigurationProfiles:
get:
operationId: Configuration Profiles Info
description: |
Get Configuration Profiles (profile ids) information from the inventory record by serial number.
#ExamplePrompt list the configuration profiles for this mac H2WFP7BPQ6NV
summary: Get Configuration Profiles (profile ids) information from the inventory record by serial number.
parameters:
- in: path
name: serialNumber
description: The serial number of the device
schema:
type: string
required: true
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'404':
description: Not Found
security:
- bearerAuth: []