blaze-query-connector-kandji-jersey3.1.0.6.source-code.kandji-openapi.yml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of blaze-query-connector-kandji-jersey3 Show documentation
Show all versions of blaze-query-connector-kandji-jersey3 Show documentation
A multi-platform querying library
The newest version!
openapi: 3.0.3
info:
title: Kandji API
description: >-
# Welcome to the Kandji API Documentation
You can find your API URL in Settings > Access. The API URL will follow the
below formats.
- US - `https://SubDomain.api.kandji.io`
- EU - `https://SubDomain.api.eu.kandji.io`
For information on how to obtain an API token, please refer to the following
support article.
[https://support.kandji.io/api](https://support.kandji.io/api)
#### Rate Limit
The Kandji API currently has an API rate limit of 10,000 requests per hour
per customer.
#### Request Methods
HTTP request methods supported by the Kandji API.
| Method | Definition |
| --- | --- |
| GET | The `GET` method requests a representation of the specified
resource. |
| POST | The `POST` method submits an entity to the specified resource. |
| PATCH | The `PATCH` method applies partial modifications to a resource. |
| DELETE | The `DELETE` method deletes the specified resource. |
#### Response codes
Not all response codes apply to every endpoint.
| Code | Response |
| --- | --- |
| 200 | OK |
| 201 | Created |
| 204 | No content |
| | Typical response when sending the DELETE method. |
| 400 | Bad Request |
| | "Command already running" - The command may already be running in a
_Pending_ state waiting on the device. |
| | "Command is not allowed for current device" - The command may not be
compatible with the target device. |
| | "JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)"
|
| 401 | Unauthorized |
| | This error can occur if the token is incorrect, was revoked, or the
token has expired. |
| 403 | Forbidden |
| | The request was understood but cannot be authorized. |
| 404 | Not found |
| | Unable to locate the resource in the Kandji tenant. |
| 415 | Unsupported Media Type |
| | The request contains a media type which the server or resource does not
support. |
| 500 | Internal server error |
| 503 | Service unavailable |
| | This error can occur if a file upload is still being processed via the
custom apps API. |
#### Data structure
The API returns all structured responses in JSON schema format.
#### Examples
Code examples using the API can be found in the Kandji support
[GitHub](https://github.com/kandji-inc/support/tree/main/api-tools).
version: 1.0.0
contact: { }
servers:
- url: https://{sub_domain}.api.kandji.io
- url: '{post_url}'
paths:
/api/v1/integrations/apple/ade/public_key/:
get:
tags:
- Automated Device Enrollment integrations
summary: Download ADE public key
description: >-
This request returns the public key used to create an MDM server
connection in Apple Business Manager.
The encoded information needs to be saved to a file with the `.pem`
format and then uploaded to ABM.
operationId: downloadAdePublicKey
responses:
'200':
description: Download public key
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '1074'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; frame-ancestors 'none'; base-uri 'none';
form-action 'none'
Date:
schema:
type: string
example: Tue, 14 Jun 2022 22:33:42 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Set-Cookie:
schema:
type: string
example: >-
AWSALBCORS=tVpRSFpB+GSyXPPojjnOCwZ0oOY57zHbDE2HWXnVIJfA2LmX+0rdouh+Ojv0lOntAJsOx6tsVPWxE8a35sxzqm6l+60wTD4DQ7MYgvwDb9Xy5W0V3yL2Ec3z+kIB;
Expires=Tue, 21 Jun 2022 22:33:42 GMT; Path=/; SameSite=None;
Secure
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Xss-Protection:
schema:
type: string
example: 1; mode=block
content:
text/plain:
examples:
Download public key:
value: >
-----BEGIN CERTIFICATE-----
MIIC7TCCAdWgAwIBAgICANIwDQYJKoZIhvcNAQELBQAwLjEQMA4GA1UEAwwHU0NF
UC1DQTELMAkGA1UEBhMCRVUxDTALBgNVBAoMBERUTkIwHhcNMjEwMjI2MTk1MTM1
WhcNMzEwMjI0MTk1MTM1WjAxMRMwEQYDVQQDDApLQU5ESkktREVQMQswCQYDVQQG
EwJFVTENMAsGA1UECgwERFROQjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
ggEBANsWli9JUD5Q32Gny5G8nfVACBwoYOd0WymsI96xrnguhMKS/zzrlkn4HUCt
...
...
...
CSqGSIb3DQEBCwUAA4IBAQBAq91ds1eQxzxUE/vyRUd1D4Sq4kEHLtyumfbAdhxq
oFVeQNCcHh4EAdH+D5kCV1KSbhap0WGm10c6rLidMSfcdCmr0IkIcFKCdtW3sAIB
bqsM5pF1LULqnYZM25aDFRcy1d+t9en1jsL2ig2lDuIVCLd9Shj88R5NWELwHrar
q0Ix5jA1qhQKrFzROXITAJUZOuf7WbOG7foM9Z12rQrfv1yTgLllr4S4qDCQUpGy
3Q12WhkYltkdsG6GeoSbwNPxMUwNiDNE1Z3z51dMfzFud/vtB2wv29AIjRMBT4mW
HA2a80rO+vlrUn8GR31yTlpazvalccuSuTpIO9VLxweB
-----END CERTIFICATE-----
/api/v1/integrations/apple/ade/:
post:
tags:
- Automated Device Enrollment integrations
summary: Create ADE integration
description: >-
This request will create a new ADE integration.
The default `blueprint_id`, `phone` number, `email` address, and MDM
server token `file` downloaded from ABM are required and must be sent in
the request.
operationId: createAdeIntegration
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
blueprint_id:
type: string
example: 932fd172-3c27-4ee6-a165-af74ef55b343
email:
type: string
example: [email protected]
file:
type: string
format: binary
phone:
type: string
example: '1234567890'
responses:
'200':
description: Create integration
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '787'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; form-action 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Thu, 09 Dec 2021 21:19:13 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
access_token_expiry:
type: string
example: '2023-06-15T00:06:08Z'
admin_id:
type: string
example: [email protected]
blueprint:
type: object
properties:
color:
type: string
example: aqua-800
icon:
type: string
example: ss-files
id:
type: string
example: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name:
type: string
example: Default Blueprint
days_left:
type: number
example: 364
defaults:
type: object
properties:
email:
type: string
example: [email protected]
phone:
type: string
example: '123457890'
device_counts:
type: object
properties:
total:
type: number
example: 0
id:
type: string
example: 4fbe63a1-6dc3-42e2-80dc-b1b183287463
last_device_sync:
nullable: true
example: null
org_address:
type: string
example: 113 W G St,San Diego CA 92101-6096,USA
org_email:
type: string
example: [email protected]
org_name:
type: string
example: Accuhive
org_phone:
type: string
example: +1 (415) 640-4923
org_type:
type: string
example: org
server_name:
type: string
example: stage 2
server_uuid:
type: string
example: 55251a76-0a79-4a58-b96c-68b25f5cae53
status:
type: string
example: SUCCESS
status_reason:
nullable: true
example: null
status_received_at:
nullable: true
example: null
stoken_file_name:
type: string
example: stage 2_Token_2022-06-15T00-06-08Z_smime.p7m
examples:
Create integration:
value:
access_token_expiry: '2023-06-15T00:06:08Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name: Default Blueprint
days_left: 364
defaults:
email: [email protected]
phone: '123457890'
device_counts:
total: 0
id: 4fbe63a1-6dc3-42e2-80dc-b1b183287463
last_device_sync: null
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: Accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: stage 2
server_uuid: 55251a76-0a79-4a58-b96c-68b25f5cae53
status: SUCCESS
status_reason: null
status_received_at: null
stoken_file_name: stage 2_Token_2022-06-15T00-06-08Z_smime.p7m
/api/v1/integrations/apple/ade/{ade_token_id}/renew:
post:
tags:
- Automated Device Enrollment integrations
summary: Renew ADE integration
description: >-
This request will renew an existing ADE integration.
The default `blueprint_id`, `phone` number, `email` address, and MDM
server token `file` from the associated MDM server in ABM are required
and must be sent in the request.
operationId: renewAdeIntegration
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
blueprint_id:
type: string
example: 9de089f2-15a4-4670-9f81-d3fc6236b668
email:
type: string
example: [email protected]
file:
type: string
format: binary
phone:
type: string
example: '1234567890'
responses:
'200':
description: Renew integration
content:
application/json:
schema:
type: object
properties:
access_token_expiry:
type: string
example: '2023-06-14T23:53:04Z'
admin_id:
type: string
example: [email protected]
blueprint:
type: object
properties:
color:
type: string
example: aqua-800
icon:
type: string
example: ss-files
id:
type: string
example: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name:
type: string
example: Default Blueprint
days_left:
type: number
example: 364
defaults:
type: object
properties:
email:
type: string
example: [email protected]
phone:
type: string
example: '123457890'
device_counts:
type: object
properties:
total:
type: number
example: 0
id:
type: string
example: 6cd195c1-9421-40ce-af5e-35c16cb69cc9
last_device_sync:
type: string
example: '2022-06-14T23:51:00.567593Z'
org_address:
type: string
example: 113 W G St,San Diego CA 92101-6096,USA
org_email:
type: string
example: [email protected]
org_name:
type: string
example: Accuhive
org_phone:
type: string
example: +1 (415) 640-4923
org_type:
type: string
example: org
server_name:
type: string
example: stage
server_uuid:
type: string
example: 78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd
status:
type: string
example: SUCCESS
status_reason:
nullable: true
example: null
status_received_at:
type: string
example: '2022-05-11T18:06:00.461776Z'
stoken_file_name:
type: string
example: stage-kandji.io_Token_2022-06-14T23-53-04Z_smime.p7m
examples:
Renew integration:
value:
access_token_expiry: '2023-06-14T23:53:04Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name: Default Blueprint
days_left: 364
defaults:
email: [email protected]
phone: '123457890'
device_counts:
total: 0
id: 6cd195c1-9421-40ce-af5e-35c16cb69cc9
last_device_sync: '2022-06-14T23:51:00.567593Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: Accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: stage
server_uuid: 78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd
status: SUCCESS
status_reason: null
status_received_at: '2022-05-11T18:06:00.461776Z'
stoken_file_name: stage-kandji.io_Token_2022-06-14T23-53-04Z_smime.p7m
parameters:
- name: ade_token_id
in: path
required: true
schema:
type: string
/api/v1/integrations/apple/ade/{ade_token_id}:
get:
tags:
- Automated Device Enrollment integrations
summary: Get ADE integration
description: >-
This request returns a specific ADE integration based on the
`ade_token_id` passed.
operationId: getAdeIntegration
responses:
'200':
description: Get integration
content:
application/json:
schema:
type: object
properties:
access_token_expiry:
type: string
example: '2023-06-15T00:11:57Z'
admin_id:
type: string
example: [email protected]
blueprint:
type: object
properties:
color:
type: string
example: aqua-800
icon:
type: string
example: ss-files
id:
type: string
example: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name:
type: string
example: Default Blueprint
days_left:
type: number
example: 364
defaults:
type: object
properties:
email:
type: string
example: [email protected]
phone:
type: string
example: '123457890'
device_counts:
type: object
properties:
total:
type: number
example: 0
id:
type: string
example: 6aa1b707-57ba-43ed-bed7-3553d77ac3d1
last_device_sync:
type: string
example: '2022-06-15T00:31:00.581170Z'
org_address:
type: string
example: 113 W G St,San Diego CA 92101-6096,USA
org_email:
type: string
example: [email protected]
org_name:
type: string
example: Accuhive
org_phone:
type: string
example: +1 (415) 640-4923
org_type:
type: string
example: org
server_name:
type: string
example: stage
server_uuid:
type: string
example: 78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd
status:
type: string
example: SUCCESS
status_reason:
nullable: true
example: null
status_received_at:
nullable: true
example: null
stoken_file_name:
type: string
example: stage_Token_2022-06-15T00-11-57Z_smime.p7m
examples:
Get integration:
value:
access_token_expiry: '2023-06-15T00:11:57Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name: Default Blueprint
days_left: 364
defaults:
email: [email protected]
phone: '123457890'
device_counts:
total: 0
id: 6aa1b707-57ba-43ed-bed7-3553d77ac3d1
last_device_sync: '2022-06-15T00:31:00.581170Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: Accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: stage
server_uuid: 78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd
status: SUCCESS
status_reason: null
status_received_at: null
stoken_file_name: stage_Token_2022-06-15T00-11-57Z_smime.p7m
delete:
tags:
- Automated Device Enrollment integrations
summary: Delete ADE integration
description: >-
# **WARNING!**
This is a HIGHLY destructive action.
Deleting an ADE token will unassign the associated device records from
Kandji. For currently enrolled devices that were assigned to Kandji via
the delete ADE integration will not be impacted until they are wiped and
reprovisioned. This action is essentially the same as removing an ADE
token from MDM and then adding it back.
If applicable, be sure to reassign the device records in ABM.
operationId: deleteAdeIntegration
requestBody:
content:
multipart/form-data:
schema:
type: object
properties: { }
responses:
'204':
description: Delete integration
headers:
Allow:
schema:
type: string
example: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Connection:
schema:
type: string
example: keep-alive
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; frame-ancestors 'none'; base-uri 'none';
form-action 'none'
Date:
schema:
type: string
example: Wed, 15 Jun 2022 00:13:32 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Set-Cookie:
schema:
type: string
example: >-
AWSALBCORS=J3w+KU+5Sx7Yrgr8UxsdmPLdRtRyFbFLqnrSeOIKoKgk7Dq/F9NvbYTiEJtEhvcXW42v01GKTfGWZh4cLzz4cUwA03cIbx7If6TW15ISyVfONrqSaWSxc+9QVBBB;
Expires=Wed, 22 Jun 2022 00:13:32 GMT; Path=/; SameSite=None;
Secure
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Xss-Protection:
schema:
type: string
example: 1; mode=block
content: { }
patch:
tags:
- Automated Device Enrollment integrations
summary: Update ADE integration
description: >-
This request will update the default blueprint, phone number, and email
address in an existing ADE integration.
The default `blueprint_id`, `phone` number, and `email` address must be
sent in the request.
operationId: updateAdeIntegration
requestBody:
content:
application/json:
schema:
type: object
properties:
blueprint_id:
type: string
example: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
email:
type: string
example: [email protected]
phone:
type: string
example: '1234567890'
examples:
Update ADE integration:
value:
blueprint_id: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
email: [email protected]
phone: '1234567890'
responses:
'200':
description: Update integration
content:
application/json:
schema:
type: object
properties:
access_token_expiry:
type: string
example: '2023-06-14T23:53:04Z'
admin_id:
type: string
example: [email protected]
blueprint:
type: object
properties:
color:
type: string
example: aqua-800
icon:
type: string
example: ss-files
id:
type: string
example: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name:
type: string
example: Default Blueprint
days_left:
type: number
example: 364
defaults:
type: object
properties:
email:
type: string
example: [email protected]
phone:
type: string
example: '123457890'
device_counts:
type: object
properties:
total:
type: number
example: 0
id:
type: string
example: 6cd195c1-9421-40ce-af5e-35c16cb69cc9
last_device_sync:
type: string
example: '2022-06-14T23:51:00.567593Z'
org_address:
type: string
example: 113 W G St,San Diego CA 92101-6096,USA
org_email:
type: string
example: [email protected]
org_name:
type: string
example: Accuhive
org_phone:
type: string
example: +1 (415) 640-4923
org_type:
type: string
example: org
server_name:
type: string
example: stage
server_uuid:
type: string
example: 78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd
status:
type: string
example: SUCCESS
status_reason:
nullable: true
example: null
status_received_at:
type: string
example: '2022-05-11T18:06:00.461776Z'
stoken_file_name:
type: string
example: stage-kandji.io_Token_2022-06-14T23-53-04Z_smime.p7m
examples:
Update integration:
value:
access_token_expiry: '2023-06-14T23:53:04Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: bf21d9cf-17cf-48b3-890d-7bc27c241bb7
name: Default Blueprint
days_left: 364
defaults:
email: [email protected]
phone: '123457890'
device_counts:
total: 0
id: 6cd195c1-9421-40ce-af5e-35c16cb69cc9
last_device_sync: '2022-06-14T23:51:00.567593Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: Accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: stage
server_uuid: 78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd
status: SUCCESS
status_reason: null
status_received_at: '2022-05-11T18:06:00.461776Z'
stoken_file_name: stage-kandji.io_Token_2022-06-14T23-53-04Z_smime.p7m
parameters:
- name: ade_token_id
in: path
required: true
schema:
type: string
/api/v1/integrations/apple/ade:
get:
tags:
- Automated Device Enrollment integrations
summary: List ADE integrations
description: This request returns a list of configured ADE integrations.
operationId: listAdeIntegrations
responses:
'200':
description: List integrations
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
access_token_expiry:
type: string
example: '2023-03-11T04:41:43Z'
admin_id:
type: string
example: [email protected]
blueprint:
type: object
properties:
color:
type: string
example: aqua-800
icon:
type: string
example: ss-files
id:
type: string
example: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name:
type: string
example: accuhive_default
days_left:
type: number
example: 235
defaults:
type: object
properties:
email:
type: string
example: [email protected]
phone:
type: string
example: '1234567890'
device_counts:
type: object
properties:
AppleTV:
type: number
example: 1
Mac:
type: number
example: 12
iPad:
type: number
example: 1
iPhone:
type: number
example: 1
total:
type: number
example: 15
id:
type: string
example: 1411be7d-5e91-439f-8d93-2f5667c60d42
last_device_sync:
type: string
example: '2022-07-18T15:56:34.567587Z'
org_address:
type: string
example: 113 W G St,San Diego CA 92101-6096,USA
org_email:
type: string
example: [email protected]
org_name:
type: string
example: accuhive
org_phone:
type: string
example: +1 (415) 640-4923
org_type:
type: string
example: org
server_name:
type: string
example: accuhive.kandji.io
server_uuid:
type: string
example: e0067508-4df3-4c0a-87c1-bd4ca5934b0b
status:
type: string
example: SUCCESS
status_reason:
type: string
nullable: true
example: null
status_received_at:
type: string
example: '2022-05-11T18:07:48.349490Z'
stoken_file_name:
type: string
example: >-
accuhive.kandji.io_Token_2022-03-11T04-41-43Z_smime.p7m
example:
- access_token_expiry: '2023-03-11T04:41:43Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: accuhive_default
days_left: 235
defaults:
email: [email protected]
phone: '1234567890'
device_counts:
AppleTV: 1
Mac: 12
iPad: 1
iPhone: 1
total: 15
id: 1411be7d-5e91-439f-8d93-2f5667c60d42
last_device_sync: '2022-07-18T15:56:34.567587Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: accuhive.kandji.io
server_uuid: e0067508-4df3-4c0a-87c1-bd4ca5934b0b
status: SUCCESS
status_reason: null
status_received_at: '2022-05-11T18:07:48.349490Z'
stoken_file_name: >-
accuhive.kandji.io_Token_2022-03-11T04-41-43Z_smime.p7m
- access_token_expiry: '2023-03-11T19:22:18Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: accuhive_default
days_left: 236
defaults:
email: [email protected]
phone: '1234567890'
device_counts:
total: 0
id: bb7ad458-9d51-4652-a988-4b13cf8d61f4
last_device_sync: '2022-04-27T18:51:30.560318Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: accuhive.kandji.io-2
server_uuid: 0d7fda7f-19a7-4ddf-992b-89dbcd2d9dab
status: BROKEN
status_reason: FORBIDDEN
status_received_at: '2022-07-18T16:01:27.232090Z'
stoken_file_name: >-
accuhive.kandji.io-2_Token_2022-03-11T19-22-18Z_smime.p7m
examples:
List integrations:
value:
count: 2
next: null
previous: null
results:
- access_token_expiry: '2023-03-11T04:41:43Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: accuhive_default
days_left: 235
defaults:
email: [email protected]
phone: '1234567890'
device_counts:
AppleTV: 1
Mac: 12
iPad: 1
iPhone: 1
total: 15
id: 1411be7d-5e91-439f-8d93-2f5667c60d42
last_device_sync: '2022-07-18T15:56:34.567587Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: accuhive.kandji.io
server_uuid: e0067508-4df3-4c0a-87c1-bd4ca5934b0b
status: SUCCESS
status_reason: null
status_received_at: '2022-05-11T18:07:48.349490Z'
stoken_file_name: >-
accuhive.kandji.io_Token_2022-03-11T04-41-43Z_smime.p7m
- access_token_expiry: '2023-03-11T19:22:18Z'
admin_id: [email protected]
blueprint:
color: aqua-800
icon: ss-files
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: accuhive_default
days_left: 236
defaults:
email: [email protected]
phone: '1234567890'
device_counts:
total: 0
id: bb7ad458-9d51-4652-a988-4b13cf8d61f4
last_device_sync: '2022-04-27T18:51:30.560318Z'
org_address: 113 W G St,San Diego CA 92101-6096,USA
org_email: [email protected]
org_name: accuhive
org_phone: +1 (415) 640-4923
org_type: org
server_name: accuhive.kandji.io-2
server_uuid: 0d7fda7f-19a7-4ddf-992b-89dbcd2d9dab
status: BROKEN
status_reason: FORBIDDEN
status_received_at: '2022-07-18T16:01:27.232090Z'
stoken_file_name: >-
accuhive.kandji.io-2_Token_2022-03-11T19-22-18Z_smime.p7m
/api/v1/integrations/apple/ade/{ade_token_id}/devices:
get:
tags:
- Automated Device Enrollment integrations
summary: List devices associated to ADE token
description: >-
This request returns a list of devices associated with a specified
`ade_token_id` as well as their enrollment status.
When the `mdm_device` key value is `null`, this can be taken as an
indication that the device is awaiting enrollment into Kandji.
When data is present within the mdm_device dictionary, you can reference
the `device_id` as the ID of the enrolled device record.
operationId: listDevicesAssociatedToAdeToken
parameters:
- name: page
in: query
schema:
type: string
example: '1'
description: >-
Use the `page` parameter to page through results or to request a
specific page. By default, if a page is not specified, page 1 is
returned. Note: 300 device records are returned per page of results.
Alternatively, the `next` and `previous` key attributes in the
response can be used to request the next page of results or return
to the previous page.
responses:
'200':
description: List associated devices / List associated devices - null mdm_device
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '848'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; frame-ancestors 'none'; base-uri 'none';
form-action 'none'
Date:
schema:
type: string
example: Wed, 15 Jun 2022 00:11:51 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Set-Cookie:
schema:
type: string
example: >-
AWSALBCORS=SUH3MJYLBVVzQ28XDiOfPhdQJR7pU2pzWx4w2msllp/fqIZzy8lsrQxAGXUeyxKK6S00YKuTaCiRhjZaz1wUzuXVVxKU9FVzaUO2bI28dMvQ5GNNeO2z05Hpxykj;
Expires=Wed, 22 Jun 2022 00:11:51 GMT; Path=/; SameSite=None;
Secure
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Xss-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 1
next:
type: string
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
asset_tag:
nullable: true
example: null
assignment_status_received_at:
type: string
example: '2022-06-14T23:23:21.701712Z'
blueprint:
type: object
properties:
color:
type: string
example: orange-300
icon:
type: string
example: ss-attach
id:
type: string
example: 70ab3d4e-1298-41a5-a2a7-b04abf804578
name:
type: string
example: EMPTY_DONT_ADD_STUFF
color:
type: string
example: SILVER
dep_account:
type: object
properties:
id:
type: string
example: 0e5dceab-9389-4b4d-87a2-691de4ca2e73
server_name:
type: string
example: API Testing
description:
type: string
example: MBA 13.3 SLV/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by:
type: string
example: [email protected]
device_assigned_date:
type: string
example: '2022-06-14T23:20:52Z'
device_family:
type: string
example: Mac
failed_assignment_attempts:
type: number
example: 0
id:
type: string
example: 80b43bbc-b283-4c70-aef3-4d34e340293e
last_assignment_status:
type: string
example: SUCCESS
mdm_device:
type: object
properties:
deferred_install:
type: boolean
example: false
enrolled_at:
type: string
example: '2022-01-28T20:02:21.069265Z'
enrollment_status:
type: number
example: 4
id:
type: string
example: 627ec14c-7947-45ac-8023-435a7782311b
is_missing:
type: boolean
example: true
is_removed:
type: boolean
example: false
name:
type: string
example: example’s MacBook Air
status:
type: string
example: EMPTY
model:
type: string
example: MacBook Air
os:
type: string
example: OSX
profile_assign_time:
type: string
example: '2022-06-14T23:23:21Z'
profile_push_time:
nullable: true
example: null
profile_status:
type: string
example: assigned
serial_number:
type: string
example: FVFXXXB3XXXX
user:
nullable: true
example: null
example:
- asset_tag: null
assignment_status_received_at: '2022-06-14T23:23:21.701712Z'
blueprint:
color: orange-300
icon: ss-attach
id: 70ab3d4e-1298-41a5-a2a7-b04abf804578
name: EMPTY_DONT_ADD_STUFF
color: SILVER
dep_account:
id: 0e5dceab-9389-4b4d-87a2-691de4ca2e73
server_name: API Testing
description: MBA 13.3 SLV/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-14T23:20:52Z'
device_family: Mac
failed_assignment_attempts: 0
id: 80b43bbc-b283-4c70-aef3-4d34e340293e
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2022-01-28T20:02:21.069265Z'
enrollment_status: 4
id: 627ec14c-7947-45ac-8023-435a7782311b
is_missing: true
is_removed: false
name: example’s MacBook Air
status: EMPTY
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-14T23:23:21Z'
profile_push_time: null
profile_status: assigned
serial_number: FVFXXXB3XXXX
user: null
examples:
List associated devices:
value:
count: 1
next: null
previous: null
results:
- asset_tag: null
assignment_status_received_at: '2022-06-14T23:23:21.701712Z'
blueprint:
color: orange-300
icon: ss-attach
id: 70ab3d4e-1298-41a5-a2a7-b04abf804578
name: EMPTY_DONT_ADD_STUFF
color: SILVER
dep_account:
id: 0e5dceab-9389-4b4d-87a2-691de4ca2e73
server_name: API Testing
description: MBA 13.3 SLV/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-14T23:20:52Z'
device_family: Mac
failed_assignment_attempts: 0
id: 80b43bbc-b283-4c70-aef3-4d34e340293e
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2022-01-28T20:02:21.069265Z'
enrollment_status: 4
id: 627ec14c-7947-45ac-8023-435a7782311b
is_missing: true
is_removed: false
name: example’s MacBook Air
status: EMPTY
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-14T23:23:21Z'
profile_push_time: null
profile_status: assigned
serial_number: FVFXXXB3XXXX
user: null
List associated devices - null mdm_device:
value:
count: 498
next: >-
https://accuhive.kandji.io/api/v1/integrations/apple/ade/119a9ad6-d6ee-460f-af11-36595c25ad68/devices/?page=2
previous: null
results:
- asset_tag: ''
assignment_status_received_at: '2022-06-14T23:23:21.701712Z'
blueprint:
color: orange-300
icon: ss-attach
id: 70ab3d4e-1298-41a5-a2a7-b04abf804578
name: EMPTY_DONT_ADD_STUFF
color: SILVER
dep_account:
id: 0e5dceab-9389-4b4d-87a2-691de4ca2e73
server_name: API Testing
description: MBA 13.3 SLV/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-14T23:58:41Z'
device_family: Mac
failed_assignment_attempts: 0
id: 80b43bbc-b283-4c70-aef3-4d34e340293e
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-14T23:23:21Z'
profile_push_time: '2022-06-14T23:58:41Z'
profile_status: pushed
serial_number: FVFXXXB3QXXX
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 9a7628c8-59ac-41cf-8596-bf07f589a0c7
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: PZ5ZZIR186S8
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:10:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:10:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 03dba3c6-624c-4d01-9755-3b4ba9565f3f
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:10:56Z'
profile_push_time: null
profile_status: assigned
serial_number: UQJOE6U9I36Q
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:11:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:11:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 3973b56d-db7d-4771-8289-0602d84f8f11
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:11:56Z'
profile_push_time: null
profile_status: assigned
serial_number: XBKIJXO3X14O
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:12:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:12:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 5f5fc661-ec2a-4ab6-8663-4449eda6dfd4
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:12:56Z'
profile_push_time: null
profile_status: assigned
serial_number: TZ2QFWBGKWJM
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: f17461fd-d428-4194-99ff-c91e476b2c07
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: B60I6IOYAIKO
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 2920149b-8ea9-4b6f-8cc2-e3f5ac8ff28c
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: VDVCKYCVYNEV
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 063044b4-0c4b-4540-8308-8df7bf5767ce
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: WSUOWXKBLFQN
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: dde9eeaf-2731-4027-a162-a3f23935a277
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: 2JNQEICBHZVJ
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 67945772-3ca9-44ea-a4df-fa6f37ff441f
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: OUIJOLT0TFFR
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 3a31562a-2a3e-4873-bef4-9a06e4352ad7
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: HWNUHNFQXXJB
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 650950b9-8be8-4f9e-970c-2bf2a0f88187
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: HGGQOUOLTLG3
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 00c09e16-8c50-41d4-bcc2-1811fc72b006
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: MX3TACOBFZHL
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: b53c7e06-ee93-499d-aadf-397662c134ef
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: ROWUPQUAPLZH
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 78eb2368-0639-4a6f-9467-cace292db33d
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: YTOCKCHYDBT6
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: c311e247-ca79-4b35-8cb3-e7409c304880
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: JU3VSQS2DMFU
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: d70aa1d9-aa52-40de-b45c-20e48611e2d4
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: L4LJYCGSYFP1
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 94c319cf-a056-488d-8681-6f456d87cc41
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: L11R13OS6V12
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: a6c1676c-46e2-40f7-87bf-5aa1ea02d625
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: MPH7P16FHKNK
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 8c1cdc33-7695-49c6-bde5-033a595c64c9
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: BZX1AZEUEZJW
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 4c90fcdb-7f9a-4779-b86a-1a7aa14d9c08
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: CII977WQ06J8
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 1fb8647d-66cd-4881-8283-c33136e220e3
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: LX8ZTLG0SPZU
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: a31d31f5-c911-4272-a7ee-985be29ac353
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: 3NQZEMKMKZ3T
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 9d4b4830-a07b-4f9c-b8f6-4956fde6d671
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: 9WTTWLCYXSY0
user: null
- asset_tag: null
assignment_status_received_at: '2022-06-30T19:09:58.070000Z'
blueprint:
color: aqua-500
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
color: GOLD
dep_account:
id: 119a9ad6-d6ee-460f-af11-36595c25ad68
server_name: API Testing
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2022-06-30T19:09:51Z'
device_family: Mac
failed_assignment_attempts: 0
id: 9c4c5b72-b466-4e46-850c-d3eff6065fe7
last_assignment_status: SUCCESS
mdm_device: null
model: MacBook Air
os: OSX
profile_assign_time: '2022-06-30T19:09:56Z'
profile_push_time: null
profile_status: assigned
serial_number: M6A8ZWAX93MG
user: null
parameters:
- name: ade_token_id
in: path
required: true
schema:
type: string
/api/v1/integrations/apple/ade/devices:
get:
tags:
- Automated Device Enrollment integrations
summary: List ADE devices
description: Get a list of Automated Device Enrollment devices.
operationId: listAdeDevices
parameters:
- name: blueprint_id
in: query
schema:
type: string
example: fce0cc58-caa5-40d2-a0d7-a0b257127ec5
description: Return results "containing" the specified blueprint id
- name: blueprint
in: query
schema:
type: string
example: fce0cc58-caa5-40d2-a0d7-a0b257127ec5
description: Return results "containing" the specified blueprint id
- name: user_id
in: query
schema:
type: string
example: '8136'
description: '"exact" match on kandji user ID number'
- name: user
in: query
schema:
type: string
example: '8136'
description: '"exact" match on kandji user ID number'
- name: dep_account
in: query
schema:
type: string
example: ''
description: The ADE token UUID
- name: device_family
in: query
schema:
type: string
example: ''
description: Mac, iPhone, iPad, AppleTV, iPod
- name: model
in: query
schema:
type: string
example: MacBook Air
description: >-
Return model results "containing" the specified model string. -
"iPad (8th Generation)", "MacBook Air"
- name: os
in: query
schema:
type: string
example: ''
description: OSX, iOS, tvOS
- name: profile_status
in: query
schema:
type: string
example: ''
description: >-
The automated device enrollment profile assignment status -
assigned, empty, pushed, removed
- name: serial_number
in: query
schema:
type: string
example: ''
description: >-
Search for a specific device by Serial Number. If partial serial
number is provided in the query, all device containing the partial
string will be returned.
- name: page
in: query
schema:
type: string
example: '1'
description: >-
Use the `page` parameter to page through results or to request a
specific page. By default, if a page is not specified, page 1 is
returned. Note: 300 device records are returned per page of results.
Alternatively, the `next` and `previous` key attributes in the
response can be used to request the next page of results or return
to the previous page.
responses:
'200':
description: success
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 1
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
asset_tag:
type: string
example: sending_to_now
assignment_status_received_at:
type: string
example: '2023-09-21T22:02:45.609328Z'
blueprint:
type: string
example: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
blueprint_id:
type: string
example: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
color:
type: string
example: GOLD
dep_account:
type: object
properties:
id:
type: string
example: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name:
type: string
example: accuhive
description:
type: string
example: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by:
type: string
example: [email protected]
device_assigned_date:
type: string
example: '2023-08-22T16:56:48Z'
device_family:
type: string
example: Mac
failed_assignment_attempts:
type: number
example: 0
id:
type: string
example: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status:
type: string
example: SUCCESS
mdm_device:
type: object
properties:
deferred_install:
type: boolean
example: false
enrolled_at:
type: string
example: '2023-09-20T14:44:45.258155Z'
enrollment_status:
type: number
example: 4
id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing:
type: boolean
example: false
is_removed:
type: boolean
example: false
name:
type: string
example: testuser’s MacBook Air
model:
type: string
example: MacBook Air
os:
type: string
example: OSX
profile_assign_time:
type: string
example: '2023-09-21T22:02:45Z'
profile_push_time:
type: string
example: '2023-09-20T14:43:45Z'
profile_status:
type: string
example: assigned
serial_number:
type: string
example: C02FL5YXQ6LC
user:
type: number
example: 8136
user_id:
type: number
example: 8136
example:
- asset_tag: sending_to_now
assignment_status_received_at: '2023-09-21T22:02:45.609328Z'
blueprint: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
blueprint_id: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
color: GOLD
dep_account:
id: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name: accuhive
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2023-08-22T16:56:48Z'
device_family: Mac
failed_assignment_attempts: 0
id: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2023-09-20T14:44:45.258155Z'
enrollment_status: 4
id: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing: false
is_removed: false
name: testuser’s MacBook Air
model: MacBook Air
os: OSX
profile_assign_time: '2023-09-21T22:02:45Z'
profile_push_time: '2023-09-20T14:43:45Z'
profile_status: assigned
serial_number: C02FL5YXQ6LC
user: 8136
user_id: 8136
examples:
success:
value:
count: 1
next: null
previous: null
results:
- asset_tag: sending_to_now
assignment_status_received_at: '2023-09-21T22:02:45.609328Z'
blueprint: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
blueprint_id: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
color: GOLD
dep_account:
id: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name: accuhive
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2023-08-22T16:56:48Z'
device_family: Mac
failed_assignment_attempts: 0
id: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2023-09-20T14:44:45.258155Z'
enrollment_status: 4
id: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing: false
is_removed: false
name: testuser’s MacBook Air
model: MacBook Air
os: OSX
profile_assign_time: '2023-09-21T22:02:45Z'
profile_push_time: '2023-09-20T14:43:45Z'
profile_status: assigned
serial_number: C02FL5YXQ6LC
user: 8136
user_id: 8136
'400':
description: Invalid UUID
content:
application/json:
schema:
type: object
properties:
dep_account:
type: array
items:
type: string
example: Enter a valid UUID.
example:
- Enter a valid UUID.
examples:
Invalid UUID:
value:
dep_account:
- Enter a valid UUID.
/api/v1/integrations/apple/ade/devices/{device_id}:
get:
tags:
- Automated Device Enrollment integrations
summary: Get ADE device
description: Get information about a specific Automated Device Enrollment device.
operationId: getAdeDevice
responses:
'200':
description: Get ADE device
content:
application/json:
schema:
type: object
properties:
asset_tag:
type: string
example: sending_to_now
assignment_status_received_at:
type: string
example: '2023-09-21T22:02:45.609328Z'
blueprint:
type: string
example: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
blueprint_id:
type: string
example: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
color:
type: string
example: GOLD
dep_account:
type: object
properties:
id:
type: string
example: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name:
type: string
example: accuhive
description:
type: string
example: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by:
type: string
example: [email protected]
device_assigned_date:
type: string
example: '2023-08-22T16:56:48Z'
device_family:
type: string
example: Mac
failed_assignment_attempts:
type: number
example: 0
id:
type: string
example: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status:
type: string
example: SUCCESS
mdm_device:
type: object
properties:
deferred_install:
type: boolean
example: false
enrolled_at:
type: string
example: '2023-09-20T14:44:45.258155Z'
enrollment_status:
type: number
example: 4
id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing:
type: boolean
example: false
is_removed:
type: boolean
example: false
name:
type: string
example: testuser’s MacBook Air
model:
type: string
example: MacBook Air
os:
type: string
example: OSX
profile_assign_time:
type: string
example: '2023-09-21T22:02:45Z'
profile_push_time:
type: string
example: '2023-09-20T14:43:45Z'
profile_status:
type: string
example: assigned
serial_number:
type: string
example: C02FL5YXQ6LC
user:
type: number
example: 8136
user_id:
type: number
example: 8136
examples:
Get ADE device:
value:
asset_tag: sending_to_now
assignment_status_received_at: '2023-09-21T22:02:45.609328Z'
blueprint: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
blueprint_id: c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2
color: GOLD
dep_account:
id: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name: accuhive
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2023-08-22T16:56:48Z'
device_family: Mac
failed_assignment_attempts: 0
id: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2023-09-20T14:44:45.258155Z'
enrollment_status: 4
id: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing: false
is_removed: false
name: testuser’s MacBook Air
model: MacBook Air
os: OSX
profile_assign_time: '2023-09-21T22:02:45Z'
profile_push_time: '2023-09-20T14:43:45Z'
profile_status: assigned
serial_number: C02FL5YXQ6LC
user: 8136
user_id: 8136
patch:
tags:
- Automated Device Enrollment integrations
summary: Update ADE device
description: >-
Update a specific Automated Device Enrollment device's blueprint
assignment or asset tag.
operationId: updateAdeDevice
requestBody:
content:
application/json:
schema:
type: object
properties:
asset_tag:
type: string
example: accuhive_asset_tag_01
examples:
Update ADE device:
value:
asset_tag: accuhive_asset_tag_01
responses:
'200':
description: Update blueprint / Update asset tag
content:
application/json:
schema:
type: object
properties:
asset_tag:
type: string
example: sending_to_now
assignment_status_received_at:
type: string
example: '2023-09-21T22:02:45.609328Z'
blueprint:
type: string
example: b38787e4-401c-4c4b-86dc-f1cca2072531
blueprint_id:
type: string
example: b38787e4-401c-4c4b-86dc-f1cca2072531
color:
type: string
example: GOLD
dep_account:
type: object
properties:
id:
type: string
example: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name:
type: string
example: accuhive
description:
type: string
example: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by:
type: string
example: [email protected]
device_assigned_date:
type: string
example: '2023-08-22T16:56:48Z'
device_family:
type: string
example: Mac
failed_assignment_attempts:
type: number
example: 0
id:
type: string
example: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status:
type: string
example: SUCCESS
mdm_device:
type: object
properties:
deferred_install:
type: boolean
example: false
enrolled_at:
type: string
example: '2023-09-20T14:44:45.258155Z'
enrollment_status:
type: number
example: 4
id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing:
type: boolean
example: false
is_removed:
type: boolean
example: false
name:
type: string
example: testuser’s MacBook Air
model:
type: string
example: MacBook Air
os:
type: string
example: OSX
profile_assign_time:
type: string
example: '2023-09-21T22:02:45Z'
profile_push_time:
type: string
example: '2023-09-20T14:43:45Z'
profile_status:
type: string
example: assigned
serial_number:
type: string
example: C02FL5YXQ6LC
user:
type: number
example: 8136
user_id:
type: number
example: 8136
examples:
Update asset tag:
value:
asset_tag: sending_to_now
assignment_status_received_at: '2023-09-21T22:02:45.609328Z'
blueprint: b38787e4-401c-4c4b-86dc-f1cca2072531
blueprint_id: b38787e4-401c-4c4b-86dc-f1cca2072531
color: GOLD
dep_account:
id: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name: accuhive
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2023-08-22T16:56:48Z'
device_family: Mac
failed_assignment_attempts: 0
id: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2023-09-20T14:44:45.258155Z'
enrollment_status: 4
id: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing: false
is_removed: false
name: testuser’s MacBook Air
model: MacBook Air
os: OSX
profile_assign_time: '2023-09-21T22:02:45Z'
profile_push_time: '2023-09-20T14:43:45Z'
profile_status: assigned
serial_number: C02FL5YXQ6LC
user: 8136
user_id: 8136
Update blueprint:
value:
asset_tag: sending_to_now
assignment_status_received_at: '2023-09-21T22:02:45.609328Z'
blueprint: b38787e4-401c-4c4b-86dc-f1cca2072531
blueprint_id: b38787e4-401c-4c4b-86dc-f1cca2072531
color: GOLD
dep_account:
id: 821b216b-8a8d-4089-b4d9-c66dc83f92f2
server_name: accuhive
description: MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA
device_assigned_by: [email protected]
device_assigned_date: '2023-08-22T16:56:48Z'
device_family: Mac
failed_assignment_attempts: 0
id: aca3e9f7-48d9-44a5-9007-25bc0b1d451f
last_assignment_status: SUCCESS
mdm_device:
deferred_install: false
enrolled_at: '2023-09-20T14:44:45.258155Z'
enrollment_status: 4
id: 782f4054-b971-4bec-850b-7bf13ce806fe
is_missing: false
is_removed: false
name: testuser’s MacBook Air
model: MacBook Air
os: OSX
profile_assign_time: '2023-09-21T22:02:45Z'
profile_push_time: '2023-09-20T14:43:45Z'
profile_status: assigned
serial_number: C02FL5YXQ6LC
user: 8136
user_id: 8136
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/blueprints:
get:
tags:
- Blueprints
summary: List Blueprints
description: >-
This request returns a list of a blueprint records in the Kandji tenant.
Optional query parameters can be specified to filter the results.
operationId: listBlueprints
parameters:
- name: id
in: query
schema:
type: string
example: 97e4e175-1631-43f6-a02b-33fd1c748ab8
description: Look up a specific Blueprint by its ID
- name: id__in
in: query
schema:
type: string
example: >-
11f4eb9a-10ed-4c3d-a7c1-fb87f95743fb,6391086e-85a1-4820-813c-f9c75025fff4
description: >-
Specify a list of Blueprint IDs to limit the results to. Multiple
values may be separated by commas. There is a double underscore
(`__`) between id and in
- name: name
in: query
schema:
type: string
example: testing_blueprint
description: Return Blueprint names "containing" the specified search string.
- name: limit
in: query
schema:
type: string
example: '100'
description: Number of results to return per page.
- name: offset
in: query
schema:
type: string
example: '400'
description: The initial index from which to return the results.
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, HEAD, POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '3285'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; frame-ancestors 'none'; default-src
'none'; base-uri 'none'
Date:
schema:
type: string
example: Wed, 08 Dec 2021 21:58:44 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
color:
type: string
example: aqua-500
computers_count:
type: number
example: 0
description:
type: string
example: ''
enrollment_code:
type: object
properties:
code:
type: string
example: '123456'
is_active:
type: boolean
example: true
icon:
type: string
example: ss-paintdisabled
id:
type: string
example: b38787e4-401c-4c4b-86dc-f1cca2072531
name:
type: string
example: auto_app_testing
params:
type: object
properties: { }
type:
type: string
example: classic
example:
- color: aqua-500
computers_count: 0
description: ''
enrollment_code:
code: '123456'
is_active: true
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
params: { }
type: classic
- color: aqua-800
computers_count: 0
description: ''
enrollment_code:
code: '012345'
is_active: true
icon: ss-files
id: cbe7daa9-2bcb-4cb1-aff9-024cd3a0330c
name: this is a test assignment map
params: { }
type: map
examples:
success:
value:
count: 2
next: null
previous: null
results:
- color: aqua-500
computers_count: 0
description: ''
enrollment_code:
code: '123456'
is_active: true
icon: ss-paintdisabled
id: b38787e4-401c-4c4b-86dc-f1cca2072531
name: auto_app_testing
params: { }
type: classic
- color: aqua-800
computers_count: 0
description: ''
enrollment_code:
code: '012345'
is_active: true
icon: ss-files
id: cbe7daa9-2bcb-4cb1-aff9-024cd3a0330c
name: this is a test assignment map
params: { }
type: map
post:
tags:
- Blueprints
summary: Create Blueprint
description: >-
This request creates a new empty Blueprint or a new Blueprint from a
template. The keys `name` and `enrollment_code` `is_active` are
required, and the blueprint name key must be unique from the existing
blueprint names in the Kandji tenant.
optionally, `type: map` can be used when creating a new Assignment Map
blueprint.
Note: If cloning an existing blueprint,\`type\` value and the type of
sourced (\`source.id\`) blueprint must match and \`source.type\` value
must be set to \`blueprint\`.
operationId: createBlueprint
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
color:
type: string
example: orange-500
description:
type: string
example: Test Template
enrollment_code.code:
type: string
example: '897526'
enrollment_code.is_active:
type: string
example: 'true'
icon:
type: string
example: ss-fax
name:
type: string
example: Test Template123
source.id:
type: string
example: b38787e4-401c-4c4b-86dc-f1cca2072531
source.type:
type: string
example: blueprint
type:
type: string
example: map
examples:
Create Blueprint:
value:
color: orange-500
description: Test Template
enrollment_code.code: '897526'
enrollment_code.is_active: 'true'
icon: ss-fax
name: Test Template123
source.id: b38787e4-401c-4c4b-86dc-f1cca2072531
source.type: blueprint
type: map
responses:
'201':
description: success
content:
application/json:
schema:
type: object
properties:
color:
type: string
example: aqua-800
description:
type: string
example: ''
enrollment_code:
type: object
properties:
code:
type: string
example: '123456'
is_active:
type: boolean
example: true
icon:
type: string
example: ss-files
id:
type: string
example: f3a0445f-87ba-4c37-ba9f-67186004f375
name:
type: string
example: Test Template123
params:
type: object
properties: { }
type:
type: string
example: map
examples:
success:
value:
color: aqua-800
description: ''
enrollment_code:
code: '123456'
is_active: true
icon: ss-files
id: f3a0445f-87ba-4c37-ba9f-67186004f375
name: Test Template123
params: { }
type: map
'400':
description: 400 - type does not match source.id blueprint type
content:
application/json:
schema:
type: array
items:
type: string
example: Blueprint type does not match the source blueprint type
example:
- Blueprint type does not match the source blueprint type
examples:
400 - type does not match source.id blueprint type:
value:
- Blueprint type does not match the source blueprint type
/api/v1/blueprints/{blueprint_id}:
get:
tags:
- Blueprints
summary: Get Blueprint
description: >-
This request returns information about a specific blueprint based on
blueprint ID.
### Request Parameters
`blueprint_id` (path parameter): The unique identifier of the blueprint.
operationId: getBlueprint
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, HEAD, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '238'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; form-action 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 08 Dec 2021 22:00:35 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
text/plain:
examples:
success:
value: "{\n\t\"id\": \"b38787e4-401c-4c4b-86dc-f1cca2072531\",\n\t\"name\": \"auto_app_testing\",\n\t\"icon\": \"ss-paintdisabled\",\n\t\"color\": \"aqua-500\",\n\t\"description\": \"\",\n\t\"params\": {},\n\t\"computers_count\": 0,\n\t\"enrollment_code\": {\n\t\t\"code\": \"752477\",\n\t\t\"is_active\": true\n\t},\n\t\"type\": \"classic\" // values - classic or map\n}"
delete:
tags:
- Blueprints
summary: Delete Blueprint
description: >-
# **WARNING!**
This is a HIGHLY destructive action.
Deleting a Blueprint will un-manage ALL devices assigned to the
Blueprint.
### Request Parameters
`blueprint_id` (path parameter): The unique identifier of the blueprint.
operationId: deleteBlueprint
responses:
'200':
description: ''
patch:
tags:
- Blueprints
summary: Update Blueprint
description: >-
This requests allows updating of the name, icon, icon color,
description, enrollment code, and active status on an existing
blueprint.
### Request Parameters
`blueprint_id` (path parameter): The unique identifier of the blueprint.
operationId: updateBlueprint
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
color:
type: string
example: orange-500
description:
type: string
example: An example blueprint description
enrollment_code.code:
type: string
example: '999858'
enrollment_code.is_active:
type: string
example: 'false'
name:
type: string
example: Default Blueprint
examples:
Update Blueprint:
value:
color: orange-500
description: An example blueprint description
enrollment_code.code: '999858'
enrollment_code.is_active: 'false'
name: Default Blueprint
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, HEAD, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '274'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; default-src 'none'; form-action 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 08 Dec 2021 22:20:27 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
color:
type: string
example: orange-500
computers_count:
type: number
example: 1
description:
type: string
example: An example blueprint description
enrollment_code:
type: object
properties:
code:
type: string
example: '999858'
is_active:
type: boolean
example: false
icon:
type: string
example: ss-quote
id:
type: string
example: 6391086e-85a1-4820-813c-f9c75025fff4
missing_computers_count:
type: number
example: 1
name:
type: string
example: Default Blueprint
params:
type: object
properties: { }
examples:
success:
value:
color: orange-500
computers_count: 1
description: An example blueprint description
enrollment_code:
code: '999858'
is_active: false
icon: ss-quote
id: 6391086e-85a1-4820-813c-f9c75025fff4
missing_computers_count: 1
name: Default Blueprint
params: { }
parameters:
- name: blueprint_id
in: path
required: true
schema:
type: string
/api/v1/blueprints/{blueprint_id}/list-library-items:
get:
tags:
- Blueprints
summary: List Library Items
description: >-
This API endpoint retrieves a list of library items associated with a
specific blueprint. (classic and maps). Requires that the blueprint ID
is passed as a path parameter in the URL.
### Request Parameters
`blueprint_id` (path parameter): The unique identifier of the blueprint.
### Response fields
- `count` (int): The total count of library items.
- `next` (str): The URL for the next page of results, if available. If
not available will value will be `null`.
- `previous` (str): The URL for the previous page of results, if
available. If not available will value will be `null`.
- `results` (object): An array containing objects with the following
fields:
- `id` (str): The ID of the library item.
- `name` (str): The name of the library item.
operationId: listLibraryItems
responses:
'200':
description: success
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Allow:
schema:
type: string
example: GET, POST, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'self'; script-src 'self'
'unsafe-inline' unpkg.com; style-src 'self' 'unsafe-inline'
unpkg.com; frame-ancestors 'none'; base-uri 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 11 Jan 2024 23:17:11 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '211'
X-Kong-Upstream-Latency:
schema:
type: string
example: '92'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9996'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300113-BFI, cache-mia-kmia1760044-MIA
X-Timer:
schema:
type: string
example: S1705015031.591200,VS0,VE420
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 6
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
id:
type: string
example: 18b9e13d-fa78-47b7-8871-580bfb34d020
name:
type: string
example: ssh config
example:
- id: 18b9e13d-fa78-47b7-8871-580bfb34d020
name: ssh config
- id: c0148e35-c734-4402-b2fb-1c61aab72550
name: accuhive_wifi
- id: 6a77e7dc-014b-4e3f-95b0-a140577ccfb8
name: ade - default skip
- id: 76eea1b5-62bb-4ae5-905a-cdf910bcaa84
name: okta - kandji-oie
- id: 4e44ed2d-5be8-4647-b63b-92d52d3d8864
name: liftoff
- id: 994dbaf3-839a-4c11-8f80-3e0b6daee473
name: agent_debug_logging
examples:
success:
value:
count: 6
next: null
previous: null
results:
- id: 18b9e13d-fa78-47b7-8871-580bfb34d020
name: ssh config
- id: c0148e35-c734-4402-b2fb-1c61aab72550
name: accuhive_wifi
- id: 6a77e7dc-014b-4e3f-95b0-a140577ccfb8
name: ade - default skip
- id: 76eea1b5-62bb-4ae5-905a-cdf910bcaa84
name: okta - kandji-oie
- id: 4e44ed2d-5be8-4647-b63b-92d52d3d8864
name: liftoff
- id: 994dbaf3-839a-4c11-8f80-3e0b6daee473
name: agent_debug_logging
parameters:
- name: blueprint_id
in: path
required: true
schema:
type: string
/api/v1/blueprints/{blueprint_id}/assign-library-item:
post:
tags:
- Blueprints
summary: Assign Library Item
description: >-
This endpoint allows assigning a library item to a specific blueprint
(classic and maps). The response will include a list of library item IDs
assigned to the blueprint.
### Request Parameters
`blueprint_id` (path parameter): The unique identifier of the blueprint.
### Request Body
- `library_item_id` (string, required)
- `assignment_node_id` (string, required for maps)
- Note: To find the assignment_node_id, view the map in a browser. Then, on your keyboard, press and hold the Option ⌥ key. Each node ID remains fixed for the lifespan of the node on the map.
### Error responses
| **Code** | **Body** |
| --- | --- |
| 400 - Bad Request | Bad Request |
| | "Library Item already exists on Blueprint" |
| | "Library Item already exists in Assignment Node" |
| | "assignment_node_id cannot be provided for Classic Blueprint" |
| | "Must provide assignment_node_id for Assignment Map Blueprint" |
operationId: assignLibraryItem
requestBody:
content:
application/json:
examples:
Assign Library Item:
value: "{\n \"library_item_id\": \"{library_item_id}\"\n\t// \"assignment_node_id\": \"{library_item_id}\" // required for assigning to assignment maps.\n}"
responses:
'200':
description: success - map / success - classic
headers:
Allow:
schema:
type: string
example: GET, POST, PATCH, DELETE
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:21:48 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: array
items:
type: string
example: c0148e35-c734-4402-b2fb-1c61aab72550
example:
- c0148e35-c734-4402-b2fb-1c61aab72550
- a6063468-48aa-4e52-a098-fd9c7902201e
- e3d94912-d8bd-474b-9b90-c32288f84f99
- 0563461d-de5d-4218-9350-43e624f607ee
examples:
success - classic:
value:
- c0148e35-c734-4402-b2fb-1c61aab72550
- a6063468-48aa-4e52-a098-fd9c7902201e
- e3d94912-d8bd-474b-9b90-c32288f84f99
- 0563461d-de5d-4218-9350-43e624f607ee
success - map:
value:
- c0148e35-c734-4402-b2fb-1c61aab72550
- a6063468-48aa-4e52-a098-fd9c7902201e
- e3d94912-d8bd-474b-9b90-c32288f84f99
- 0563461d-de5d-4218-9350-43e624f607ee
parameters:
- name: blueprint_id
in: path
required: true
schema:
type: string
/api/v1/blueprints/{blueprint_id}/remove-library-item:
post:
tags:
- Blueprints
summary: Remove Library Item
description: >-
This endpoint allows removing a library item from a specific blueprint
(classic and maps). The response will include a list of library item IDs
assigned to the blueprint.
### Request Parameters
`blueprint_id` (path parameter): The unique identifier of the blueprint.
### Request Body
- `library_item_id` (string, required)
- `assignment_node_id` (string, required for maps)
### Error responses
| **Code** | **Body** |
| --- | --- |
| 400 - Bad Request | Bad Request |
| | "assignment_node_id cannot be provided for Classic Blueprint" |
| | "Must provide assignment_node_id for Assignment Map Blueprint" |
| | "Library Item does not exist on Blueprint" |
| | "Library Item does not exist in Assignment Node" |
operationId: removeLibraryItem
requestBody:
content:
application/json:
examples:
Remove Library Item:
value: "{\n \"library_item_id\": \"{library_item_id}\"\n\t// \"assignment_node_id\": \"{library_item_id}\" // required for assigning to assignment maps.\n}"
responses:
'200':
description: success - map / success - classic
headers:
Allow:
schema:
type: string
example: GET, POST, PATCH, DELETE
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:21:48 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: array
items:
type: string
example: c0148e35-c734-4402-b2fb-1c61aab72550
example:
- c0148e35-c734-4402-b2fb-1c61aab72550
- a6063468-48aa-4e52-a098-fd9c7902201e
- e3d94912-d8bd-474b-9b90-c32288f84f99
- 0563461d-de5d-4218-9350-43e624f607ee
examples:
success - classic:
value:
- c0148e35-c734-4402-b2fb-1c61aab72550
- a6063468-48aa-4e52-a098-fd9c7902201e
- e3d94912-d8bd-474b-9b90-c32288f84f99
success - map:
value:
- c0148e35-c734-4402-b2fb-1c61aab72550
- a6063468-48aa-4e52-a098-fd9c7902201e
- e3d94912-d8bd-474b-9b90-c32288f84f99
- 0563461d-de5d-4218-9350-43e624f607ee
parameters:
- name: blueprint_id
in: path
required: true
schema:
type: string
/api/v1/blueprints/templates/:
get:
tags:
- Blueprints
summary: Get Blueprint Templates
description: Get Blueprint Templates
operationId: getBlueprintTemplates
parameters:
- name: limit
in: query
schema:
type: string
example: '100'
description: Number of results to return per page.
- name: offset
in: query
schema:
type: string
example: '400'
description: The initial index from which to return the results.
responses:
'200':
description: success
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
id:
type: number
example: 2
name:
type: string
example: CIS
templates:
type: array
items:
type: object
properties:
category:
type: number
example: 2
color:
type: string
example: aqua-800
description:
type: string
example: >-
CIS Level 1 and Level 2 Scored parameters,
based on the macOS benchmark created and
maintained by Center for Internet Security.
More details can be found at
benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that
will decrease a final CIS benchmark score if
they fail audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear
security benefit, and not inhibit the utility
of the technology beyond acceptable means.
CIS "Level 2" parameters are intended for
environments or use cases where security is
paramount, and may negatively inhibit the
utility or performance of the technology.
This template is meant to be a starting point
for macOS CIS Level 1 & 2 Scored compliance.
Please review, and make changes as needed.
Always thoroughly test before deploying to a
production environment.
icon:
type: string
example: ss-files
id:
type: number
example: 16
name:
type: string
example: CIS Level 2 Scored
params:
type: object
properties:
0264078c-4555-4b7a-bd90-888eae867830:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
0720f00c-393a-4a66-b676-efa82307ebd4:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
135b1c65-a665-431b-b919-39e984d6d29d:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: true
1cdcd680-f880-4734-9cac-dec627351478:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
1fb8d435-3205-429c-9394-868add3e4822:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
2107e444-9421-4ec8-a7d0-67ac23ed555c:
type: object
properties:
daily:
type: boolean
example: false
details:
type: array
items:
type: string
example: /Library/Application Support/Adobe/
example:
- /Library/Application Support/Adobe/
- >-
/Library/Application
Support/regid.1986-12.com.adobe/
- /Library/Application Support/VMware/
mute:
type: boolean
example: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
34e7d714-5772-416d-9aff-c467504b45eb:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
type: object
properties:
daily:
type: boolean
example: false
details:
type: object
properties:
corner:
type: string
example: wvous-br-corner
method:
type: number
example: 0
mute:
type: boolean
example: false
3e41b186-f713-4b71-9f77-bddff07942f8:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
4911ed60-3c2d-40ba-a5ca-33306f1d1245:
type: object
properties:
daily:
type: boolean
example: false
details:
type: number
example: 15
mute:
type: boolean
example: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
51a763db-716c-4bfa-b721-2f303d203b3b:
type: object
properties:
daily:
type: boolean
example: false
details:
type: string
example: '1'
mute:
type: boolean
example: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
type: object
properties:
daily:
type: boolean
example: false
details:
type: string
example: '0'
mute:
type: boolean
example: false
6d268d72-3859-458c-a413-9a7210b89719:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
6e82a850-901a-47ec-9b4e-03393af029c9:
type: object
properties:
daily:
type: boolean
example: false
details:
type: number
example: 365
mute:
type: boolean
example: false
776f1c86-54ea-4876-a226-a0a07040fec0:
type: object
properties:
daily:
type: boolean
example: false
details:
type: object
properties:
type:
type: string
example: text
value:
type: string
example: >-
This system is reserved for authorized
use only, and the use of this system may
be monitored.
mute:
type: boolean
example: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
type: object
properties:
daily:
type: boolean
example: false
details:
type: array
items:
type: object
properties:
flag:
type: string
example: lo
prefix:
type: string
example: none
example:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute:
type: boolean
example: false
93384921-61aa-46f6-a7d9-d45908babccc:
type: object
properties:
daily:
type: boolean
example: false
details:
type: boolean
example: false
mute:
type: boolean
example: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
b648790a-0fac-43b8-bd96-5682f60f467e:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
b8fa043f-80bd-43d5-aea6-a94626d92c3a:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
type: object
properties:
daily:
type: boolean
example: false
details:
type: object
properties:
days:
type: number
example: 60
modifier:
type: string
example: or
size:
type: number
example: 1
unit:
type: string
example: GB
mute:
type: boolean
example: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
type: object
properties:
daily:
type: boolean
example: false
details:
type: string
example: time.apple.com
mute:
type: boolean
example: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
da3834d5-c315-4ce0-980e-b650f675b630:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
type: object
properties:
daily:
type: boolean
example: false
details:
type: object
properties:
alert_no_backups:
type: boolean
example: false
days_between_backups:
type: number
example: 14
mute:
type: boolean
example: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
f1f19efe-75a1-4ade-8456-8da539433728:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
f228e471-2a6c-4046-b676-02b133a6239d:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
fb63a562-062d-4679-9e16-3dd2453e726d:
type: object
properties:
daily:
type: boolean
example: false
mute:
type: boolean
example: false
rating:
type: number
example: 80
example:
- category: 2
color: aqua-800
description: >-
CIS Level 1 and Level 2 Scored parameters, based
on the macOS benchmark created and maintained by
Center for Internet Security. More details can
be found at benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that will
decrease a final CIS benchmark score if they
fail audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear security
benefit, and not inhibit the utility of the
technology beyond acceptable means.
CIS "Level 2" parameters are intended for
environments or use cases where security is
paramount, and may negatively inhibit the
utility or performance of the technology.
This template is meant to be a starting point
for macOS CIS Level 1 & 2 Scored compliance.
Please review, and make changes as needed.
Always thoroughly test before deploying to a
production environment.
icon: ss-files
id: 16
name: CIS Level 2 Scored
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2107e444-9421-4ec8-a7d0-67ac23ed555c:
daily: false
details:
- /Library/Application Support/Adobe/
- >-
/Library/Application
Support/regid.1986-12.com.adobe/
- /Library/Application Support/VMware/
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
3e41b186-f713-4b71-9f77-bddff07942f8:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
4911ed60-3c2d-40ba-a5ca-33306f1d1245:
daily: false
details: 15
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
51a763db-716c-4bfa-b721-2f303d203b3b:
daily: false
details: '1'
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
b8fa043f-80bd-43d5-aea6-a94626d92c3a:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1
unit: GB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
daily: false
details:
alert_no_backups: false
days_between_backups: 14
mute: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f228e471-2a6c-4046-b676-02b133a6239d:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 80
- category: 2
color: aqua-800
description: >-
CIS Level 1 Scored parameters, based on the
macOS benchmark created and maintained by Center
for Internet Security. More details can be found
at https://benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that will
decrease a final CIS benchmark score if they
fail audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear security
benefit, and not inhibit the utility of the
technology beyond acceptable means.
This template is meant to be a starting point
for macOS CIS Level 1 Scored compliance. Please
review, and make changes as needed. Always
thoroughly test before deploying to a production
environment.
icon: ss-files
id: 15
name: CIS Level 1 Scored
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1
unit: GB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
daily: false
details:
alert_no_backups: false
days_between_backups: 14
mute: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 60
weight:
type: number
example: 20
example:
- id: 2
name: CIS
templates:
- category: 2
color: aqua-800
description: >-
CIS Level 1 and Level 2 Scored parameters, based
on the macOS benchmark created and maintained by
Center for Internet Security. More details can be
found at benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that will
decrease a final CIS benchmark score if they fail
audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear security
benefit, and not inhibit the utility of the
technology beyond acceptable means.
CIS "Level 2" parameters are intended for
environments or use cases where security is
paramount, and may negatively inhibit the utility
or performance of the technology.
This template is meant to be a starting point for
macOS CIS Level 1 & 2 Scored compliance. Please
review, and make changes as needed. Always
thoroughly test before deploying to a production
environment.
icon: ss-files
id: 16
name: CIS Level 2 Scored
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2107e444-9421-4ec8-a7d0-67ac23ed555c:
daily: false
details:
- /Library/Application Support/Adobe/
- >-
/Library/Application
Support/regid.1986-12.com.adobe/
- /Library/Application Support/VMware/
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
3e41b186-f713-4b71-9f77-bddff07942f8:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
4911ed60-3c2d-40ba-a5ca-33306f1d1245:
daily: false
details: 15
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
51a763db-716c-4bfa-b721-2f303d203b3b:
daily: false
details: '1'
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
b8fa043f-80bd-43d5-aea6-a94626d92c3a:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1
unit: GB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
daily: false
details:
alert_no_backups: false
days_between_backups: 14
mute: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f228e471-2a6c-4046-b676-02b133a6239d:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 80
- category: 2
color: aqua-800
description: >-
CIS Level 1 Scored parameters, based on the macOS
benchmark created and maintained by Center for
Internet Security. More details can be found at
https://benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that will
decrease a final CIS benchmark score if they fail
audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear security
benefit, and not inhibit the utility of the
technology beyond acceptable means.
This template is meant to be a starting point for
macOS CIS Level 1 Scored compliance. Please
review, and make changes as needed. Always
thoroughly test before deploying to a production
environment.
icon: ss-files
id: 15
name: CIS Level 1 Scored
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1
unit: GB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
daily: false
details:
alert_no_backups: false
days_between_backups: 14
mute: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 60
weight: 20
- id: 1
name: Kandji
templates:
- category: 1
color: aqua-800
description: >-
Parameters found in Kandji Level II as well as
advanced media and network configurations. Several
built-in macOS features have been disabled.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 11
name: Kandji Level III
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
12167a3a-a134-4d33-aea6-429086b872f5:
daily: false
details: '0'
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8c6b6864-3faa-47f1-b599-e13bb04682ed:
daily: false
details: '0'
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
af5c6286-f084-4369-a14b-7af9b5797aa8:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
c2f95015-c14e-49bd-8d89-27c3f5963dc1:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5fbd8ad-e45b-4fa1-b900-21969fefd2ac:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 70
- category: 1
color: aqua-800
description: >-
Security is paramount by including all that is
enabled in Kandji Level III, with added parameters
disabling iCloud related services, and several
additional macOS functions.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 13
name: Kandji Level IV
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
07cac17b-33b0-4af3-8302-3e5ded562b45:
daily: false
details: '1'
mute: false
08323d29-7296-4fc1-8a74-295b3ac2b081:
daily: false
details: '1'
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
12167a3a-a134-4d33-aea6-429086b872f5:
daily: false
details: '0'
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1636e014-eee6-4858-b508-24594a4b521d:
daily: false
mute: true
19b5c13d-ccc7-49f5-9534-8e5c790a2925:
daily: false
mute: false
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1ce8e700-9636-4420-b9f9-6db1071ebdcb:
daily: false
mute: false
profile: >-
com.apple.applicationaccess.4a273661-7142-4d4e-8566-115b2b29dd27
1e058873-3137-4387-8760-ccab6fa4771e:
daily: false
details: '0'
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2107e444-9421-4ec8-a7d0-67ac23ed555c:
daily: false
details:
- /Library/Application Support/Adobe/
- >-
/Library/Application
Support/regid.1986-12.com.adobe/
- /Library/Application Support/VMware/
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
326e8ed6-0f21-4da6-87fc-00aada554c6d:
daily: false
details: 90
mute: false
3364fb4b-eb12-410a-a471-bc22e8b14725:
daily: false
mute: false
33c9548d-863a-4b9d-82a4-f9d7037054d6:
daily: false
details: 90
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
43d198e0-50c6-43bb-ac7b-4fc5a165a056:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
515313ac-99a2-4961-a132-40beef6291b2:
daily: false
details: 90
mute: false
51a763db-716c-4bfa-b721-2f303d203b3b:
daily: false
details: '0'
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d25c667-0635-4525-b400-fa93841b42e9:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8c6b6864-3faa-47f1-b599-e13bb04682ed:
daily: false
details: '1'
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a1674edc-f788-424d-addc-dea91f3053f3:
daily: false
details: 30
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
af5c6286-f084-4369-a14b-7af9b5797aa8:
daily: false
mute: false
b3aed88b-199d-465c-9277-df152cdb0d5b:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
b8fa043f-80bd-43d5-aea6-a94626d92c3a:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
c2f95015-c14e-49bd-8d89-27c3f5963dc1:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e5fbd8ad-e45b-4fa1-b900-21969fefd2ac:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f228e471-2a6c-4046-b676-02b133a6239d:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb3b7d49-3ed4-4aa7-9c95-b60857783626:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 90
- category: 1
color: aqua-800
description: >-
All of the parameters enabled in Kandji Level I
with additional items that include bolstered
authentication, password complexity, logging, and
data security.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 10
name: Kandji Level II
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8c6b6864-3faa-47f1-b599-e13bb04682ed:
daily: false
details: '0'
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 50
- category: 1
color: aqua-800
description: >-
A minimum level of security that is recommended
for all businesses. Minimal user impact can be
expected.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 9
name: Kandji Level I
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 30
weight: 10
examples:
success:
value:
count: 2
next: null
previous: null
results:
- id: 2
name: CIS
templates:
- category: 2
color: aqua-800
description: >-
CIS Level 1 and Level 2 Scored parameters, based
on the macOS benchmark created and maintained by
Center for Internet Security. More details can be
found at benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that will
decrease a final CIS benchmark score if they fail
audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear security
benefit, and not inhibit the utility of the
technology beyond acceptable means.
CIS "Level 2" parameters are intended for
environments or use cases where security is
paramount, and may negatively inhibit the utility
or performance of the technology.
This template is meant to be a starting point for
macOS CIS Level 1 & 2 Scored compliance. Please
review, and make changes as needed. Always
thoroughly test before deploying to a production
environment.
icon: ss-files
id: 16
name: CIS Level 2 Scored
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2107e444-9421-4ec8-a7d0-67ac23ed555c:
daily: false
details:
- /Library/Application Support/Adobe/
- >-
/Library/Application
Support/regid.1986-12.com.adobe/
- /Library/Application Support/VMware/
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
3e41b186-f713-4b71-9f77-bddff07942f8:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
4911ed60-3c2d-40ba-a5ca-33306f1d1245:
daily: false
details: 15
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
51a763db-716c-4bfa-b721-2f303d203b3b:
daily: false
details: '1'
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
b8fa043f-80bd-43d5-aea6-a94626d92c3a:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1
unit: GB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
daily: false
details:
alert_no_backups: false
days_between_backups: 14
mute: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f228e471-2a6c-4046-b676-02b133a6239d:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 80
- category: 2
color: aqua-800
description: >-
CIS Level 1 Scored parameters, based on the macOS
benchmark created and maintained by Center for
Internet Security. More details can be found at
https://benchmarks.cisecurity.org.
CIS ”Scored" parameters are parameters that will
decrease a final CIS benchmark score if they fail
audit.
CIS “Level 1” parameters are intended to be
practical and prudent, provide a clear security
benefit, and not inhibit the utility of the
technology beyond acceptable means.
This template is meant to be a starting point for
macOS CIS Level 1 Scored compliance. Please
review, and make changes as needed. Always
thoroughly test before deploying to a production
environment.
icon: ss-files
id: 15
name: CIS Level 1 Scored
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1
unit: GB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e9c1d35c-55f1-4ab9-9081-2865091b1fb2:
daily: false
details:
alert_no_backups: false
days_between_backups: 14
mute: true
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 60
weight: 20
- id: 1
name: Kandji
templates:
- category: 1
color: aqua-800
description: >-
Parameters found in Kandji Level II as well as
advanced media and network configurations. Several
built-in macOS features have been disabled.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 11
name: Kandji Level III
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
12167a3a-a134-4d33-aea6-429086b872f5:
daily: false
details: '0'
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8c6b6864-3faa-47f1-b599-e13bb04682ed:
daily: false
details: '0'
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
af5c6286-f084-4369-a14b-7af9b5797aa8:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
c2f95015-c14e-49bd-8d89-27c3f5963dc1:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5fbd8ad-e45b-4fa1-b900-21969fefd2ac:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 70
- category: 1
color: aqua-800
description: >-
Security is paramount by including all that is
enabled in Kandji Level III, with added parameters
disabling iCloud related services, and several
additional macOS functions.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 13
name: Kandji Level IV
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0720f00c-393a-4a66-b676-efa82307ebd4:
daily: false
mute: false
07cac17b-33b0-4af3-8302-3e5ded562b45:
daily: false
details: '1'
mute: false
08323d29-7296-4fc1-8a74-295b3ac2b081:
daily: false
details: '1'
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
12167a3a-a134-4d33-aea6-429086b872f5:
daily: false
details: '0'
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1636e014-eee6-4858-b508-24594a4b521d:
daily: false
mute: true
19b5c13d-ccc7-49f5-9534-8e5c790a2925:
daily: false
mute: false
1cdcd680-f880-4734-9cac-dec627351478:
daily: false
mute: false
1ce8e700-9636-4420-b9f9-6db1071ebdcb:
daily: false
mute: false
profile: >-
com.apple.applicationaccess.4a273661-7142-4d4e-8566-115b2b29dd27
1e058873-3137-4387-8760-ccab6fa4771e:
daily: false
details: '0'
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2107e444-9421-4ec8-a7d0-67ac23ed555c:
daily: false
details:
- /Library/Application Support/Adobe/
- >-
/Library/Application
Support/regid.1986-12.com.adobe/
- /Library/Application Support/VMware/
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
326e8ed6-0f21-4da6-87fc-00aada554c6d:
daily: false
details: 90
mute: false
3364fb4b-eb12-410a-a471-bc22e8b14725:
daily: false
mute: false
33c9548d-863a-4b9d-82a4-f9d7037054d6:
daily: false
details: 90
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
3d81acd3-8d3d-4941-a88e-6b8b9147cc6a:
daily: false
details:
corner: wvous-br-corner
method: 0
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
42a3fdf6-3774-4f56-9fde-c286760a48bf:
daily: false
mute: false
43d198e0-50c6-43bb-ac7b-4fc5a165a056:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
515313ac-99a2-4961-a132-40beef6291b2:
daily: false
details: 90
mute: false
51a763db-716c-4bfa-b721-2f303d203b3b:
daily: false
details: '0'
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d25c667-0635-4525-b400-fa93841b42e9:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
776f1c86-54ea-4876-a226-a0a07040fec0:
daily: false
details:
type: text
value: >-
This system is reserved for authorized use
only, and the use of this system may be
monitored.
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7a49b60a-7793-4fb7-854d-aa12829a8e57:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8c6b6864-3faa-47f1-b599-e13bb04682ed:
daily: false
details: '1'
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
a1674edc-f788-424d-addc-dea91f3053f3:
daily: false
details: 30
mute: false
a189df03-cdfd-4c55-b429-95e7df5a7521:
daily: false
mute: false
af5c6286-f084-4369-a14b-7af9b5797aa8:
daily: false
mute: false
b3aed88b-199d-465c-9277-df152cdb0d5b:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
b8fa043f-80bd-43d5-aea6-a94626d92c3a:
daily: false
mute: false
c248f070-6bce-42b1-9688-27d9bf4c1513:
daily: false
mute: false
c2f95015-c14e-49bd-8d89-27c3f5963dc1:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
e5decad7-7cbf-49b4-99b0-d7e94a21fa47:
daily: false
mute: false
e5fbd8ad-e45b-4fa1-b900-21969fefd2ac:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f228e471-2a6c-4046-b676-02b133a6239d:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb3b7d49-3ed4-4aa7-9c95-b60857783626:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 90
- category: 1
color: aqua-800
description: >-
All of the parameters enabled in Kandji Level I
with additional items that include bolstered
authentication, password complexity, logging, and
data security.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 10
name: Kandji Level II
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
135b1c65-a665-431b-b919-39e984d6d29d:
daily: false
mute: true
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
370625c0-77fe-4972-bac3-6be812fa4dd7:
daily: false
mute: false
3b176bde-d7bc-4086-9cfa-1cf8a6d32757:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
5112c772-bf78-4bf9-81a1-35e45ae2b915:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
56171a5e-27e5-4d6e-86cf-8956ca3b7bca:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
7c368d56-88c9-45b4-b9a0-d389febbe027:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8c6b6864-3faa-47f1-b599-e13bb04682ed:
daily: false
details: '0'
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
91e86fb9-1c25-45b0-b1ed-064f8a478409:
daily: false
details:
- flag: lo
prefix: none
- flag: ad
prefix: none
- flag: fd
prefix: none
- flag: fm
prefix: none
- flag: all
prefix: '-'
mute: false
93384921-61aa-46f6-a7d9-d45908babccc:
daily: false
details: false
mute: false
986a50bc-7cea-4874-b61c-4b2b9b1c318b:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cc59e3c1-eb02-4021-afa2-50977a30cf0a:
daily: false
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
da3834d5-c315-4ce0-980e-b650f675b630:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 50
- category: 1
color: aqua-800
description: >-
A minimum level of security that is recommended
for all businesses. Minimal user impact can be
expected.
Important: Always review and test thoroughly
before deploying. Users day to day impact will be
affected. It is recommended that you review these
changes with end-users before deployment.
icon: ss-files
id: 9
name: Kandji Level I
params:
0264078c-4555-4b7a-bd90-888eae867830:
daily: false
mute: false
0f692ac3-670e-4ee2-b207-3604bd54e32c:
daily: false
mute: false
1e4be748-e072-4c1f-b1ff-a98f076b8e8e:
daily: false
mute: false
1fb8d435-3205-429c-9394-868add3e4822:
daily: false
mute: false
1fd6eac1-2db4-4520-bfc1-b5f972e392fc:
daily: false
mute: false
2ab1b190-c3b2-4f79-8fea-c5a147a0e564:
daily: false
mute: false
34e7d714-5772-416d-9aff-c467504b45eb:
daily: false
mute: false
428d99a1-5ab0-4198-b248-7603d1c2e258:
daily: false
mute: false
52ad1967-3d00-4cb3-93c4-92b49b95a446:
daily: false
mute: false
58513f4e-be5b-4726-8ed5-a9b337bbd973:
daily: false
mute: false
5d78eebc-8552-4f9a-8236-44b9e7a4bff2:
daily: false
details: '0'
mute: false
6d268d72-3859-458c-a413-9a7210b89719:
daily: false
mute: false
6e82a850-901a-47ec-9b4e-03393af029c9:
daily: false
details: 365
mute: false
7888dff6-ad41-41f2-8f07-0f7c43a1c993:
daily: false
mute: false
86e70b82-c7d6-4266-8a89-104e9dde6a30:
daily: false
mute: false
8ed38311-50d7-4165-890e-ac3bdf55047e:
daily: false
mute: false
b648790a-0fac-43b8-bd96-5682f60f467e:
daily: false
mute: false
cbb3b9c5-2db4-476a-9faa-0c61b7354ec1:
daily: false
details:
days: 60
modifier: or
size: 1024
unit: MB
mute: false
cf19344c-572a-4359-a7f1-b02db1df1a43:
daily: false
mute: false
d011e3a4-eebe-4af2-adf8-aa41c11efacf:
daily: false
details: time.apple.com
mute: false
d19e2f27-6ddb-41b1-b76a-1662b6330cd1:
daily: false
mute: false
e5d41a12-a0be-42c8-ada8-0bc0cec1b465:
daily: false
mute: false
ea3bb880-de67-4988-8266-ae2f4f81a05c:
daily: false
mute: false
f1f19efe-75a1-4ade-8456-8da539433728:
daily: false
mute: false
f6b09eeb-a213-4fb5-8b09-1bb4d81583ab:
daily: false
mute: false
fb63a562-062d-4679-9e16-3dd2453e726d:
daily: false
mute: false
rating: 30
weight: 10
/api/v1/devices/{device_id}/notes:
get:
tags:
- Device Information
- Notes
summary: Get Device Notes
description: This request gets all notes for the specified Device ID.
operationId: getDeviceNotes
responses:
'200':
description: Get All Device Notes
headers:
Allow:
schema:
type: string
example: GET, POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '217'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; default-src 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Fri, 09 Apr 2021 17:09:59 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Link:
schema:
type: string
example: ; rel="next", ; rel="prev"
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Total-Count:
schema:
type: string
example: '1'
X-Total-Pages:
schema:
type: string
example: '1'
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: array
items:
type: object
properties:
author:
type: string
example: Test User
content:
type: string
example: This is an example note!
created_at:
type: string
example: '2021-04-09T17:09:07.164617Z'
note_id:
type: string
example: e74f34b0-120b-4149-9c0d-3e2f0d08426c
updated_at:
type: string
example: '2021-04-09T17:09:07.164635Z'
example:
- author: Test User
content: This is an example note!
created_at: '2021-04-09T17:09:07.164617Z'
note_id: e74f34b0-120b-4149-9c0d-3e2f0d08426c
updated_at: '2021-04-09T17:09:07.164635Z'
examples:
Get All Device Notes:
value:
- author: Test User
content: This is an example note!
created_at: '2021-04-09T17:09:07.164617Z'
note_id: e74f34b0-120b-4149-9c0d-3e2f0d08426c
updated_at: '2021-04-09T17:09:07.164635Z'
post:
tags:
- Device Information
- Notes
summary: Create Device Note
description: This request creates a note for the specified device ID.
operationId: createDeviceNote
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
example: This is an example note!
examples:
Create Device Note:
value:
content: This is an example note!
responses:
'201':
description: Create Device Note
headers:
Allow:
schema:
type: string
example: GET, POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '202'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; frame-ancestors 'none';
default-src 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 18:56:25 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
author:
type: string
example: Test User
content:
type: string
example: This is an example note!
created_at:
type: string
example: '2021-04-07T18:56:25.113229Z'
note_id:
type: string
example: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
updated_at:
type: string
example: '2021-04-07T18:56:25.113254Z'
examples:
Create Device Note:
value:
author: Test User
content: This is an example note!
created_at: '2021-04-07T18:56:25.113229Z'
note_id: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
updated_at: '2021-04-07T18:56:25.113254Z'
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/notes/{note_id}:
get:
tags:
- Device Information
- Notes
summary: Retrieve Device Note
description: >-
This request retrieves a specified note (Note ID) for the specified
Device ID.
operationId: retrieveDeviceNote
responses:
'200':
description: Retrieve Device Note
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '202'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; frame-ancestors 'none';
default-src 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 18:59:02 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
author:
type: string
example: Nicholas McDonald
content:
type: string
example: This is an example note!
created_at:
type: string
example: '2021-04-07T18:56:25.113229Z'
note_id:
type: string
example: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
updated_at:
type: string
example: '2021-04-07T18:56:25.113254Z'
examples:
Retrieve Device Note:
value:
author: Nicholas McDonald
content: This is an example note!
created_at: '2021-04-07T18:56:25.113229Z'
note_id: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
updated_at: '2021-04-07T18:56:25.113254Z'
delete:
tags:
- Device Information
- Notes
summary: Delete Device Note
description: >-
This request deletes a specified note (Note ID) for the specified Device
ID.
operationId: deleteDeviceNote
responses:
'200':
description: Delete Device Note
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '93'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; frame-ancestors 'none';
default-src 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 18:59:17 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
deleted_at:
type: string
example: '2021-04-07T18:59:17.734091Z'
note_id:
type: string
example: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
examples:
Delete Device Note:
value:
deleted_at: '2021-04-07T18:59:17.734091Z'
note_id: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
patch:
tags:
- Device Information
- Notes
summary: Update Device Note
description: >-
This request patches a specified note (Note ID) for the specified Device
ID.
operationId: updateDeviceNote
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
example: This is an example of updating a notes contents!
examples:
Update Device Note:
value:
content: This is an example of updating a notes contents!
responses:
'200':
description: Update Device Note
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '226'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; frame-ancestors 'none'; base-uri 'none';
form-action 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 18:59:13 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
author:
type: string
example: Test User
content:
type: string
example: This is an example of updating a notes contents!
created_at:
type: string
example: '2021-04-07T18:56:25.113229Z'
note_id:
type: string
example: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
updated_at:
type: string
example: '2021-04-07T18:56:25.113254Z'
examples:
Update Device Note:
value:
author: Test User
content: This is an example of updating a notes contents!
created_at: '2021-04-07T18:56:25.113229Z'
note_id: c0f5ba78-06a2-4914-aa3c-e3415f3ee21b
updated_at: '2021-04-07T18:56:25.113254Z'
parameters:
- name: device_id
in: path
required: true
schema:
type: string
- name: note_id
in: path
required: true
schema:
type: string
/api/v1/devices:
get:
tags:
- Device Information
summary: List Devices
description: >-
This request returns a list of devices in a Kandji tenant. Optionally.
query parameters can be used to filter results.
There is a hard upper limit of 300 results per request. To return
addtional results pagination must be used. Pagination examples can be
found in the Kandji support
[GitHub](https://github.com/kandji-inc/support/tree/main/api-tools/code-examples).
operationId: listDevices
parameters:
- name: asset_tag
in: query
schema:
type: string
example: '23245'
- name: blueprint_id
in: query
schema:
type: string
example: 91f97957-2353-4f86-a1ab-64d2b044a596
description: Return results "containing" the specified blueprint id
- name: device_id
in: query
schema:
type: string
example: 2cfeb3ac-3b5d-423e-bcff-e2676a3a32da
- name: device_name
in: query
schema:
type: string
example: Johnny's MacBook Pro
- name: filevault_enabled
in: query
schema:
type: string
example: 'true'
description: >-
Query for devices that either have FileVault on (true) or off
(false). This parameter only applies to macOS.
An empty list `[]` will be returned if no devices are found with the
given parameter value.
- name: mac_address
in: query
schema:
type: string
example: 00:0c:29:05:43:b6
description: 'Search for a specific device by MAC address '
- name: model
in: query
schema:
type: string
example: MacBook Air (M1, 2020)
description: Return model results "containing" the specified model string.
- name: ordering
in: query
schema:
type: string
example: device_id
description: >-
The `ordering` parameter can be used to define how the device
records are ordered in the response. Prepending a dash (-) to the
parameter value will reverse the order of the returned results.
`?ordering=-serial_number` will order the response by serial_number
in descending order.
**Possible values**
- `asset_tag`
- `blueprint_id`
- `device_id`
- `device_name`
- `last_check_in` - agent checkin
- `model`
- `platform`
- `os_version`
- `serial_number`
- `user`
Additionally, multiple values can be combined in a comma separated
list to further customize the ordering of the response.
`?ordering=serial_number,platform`
- name: os_version
in: query
schema:
type: string
example: 13.2.3
description: Return all device records with the specified OS version
- name: platform
in: query
schema:
type: string
example: iPad
description: >-
Return all records matching a specific platform. Possible
values:`Mac`, `iPad`, `iPhone`, `AppleTV`
- name: serial_number
in: query
schema:
type: string
example: VMC5qeJ5pDkp
description: >-
Search for a specific device by Serial Number. If partial serial
number is provided in the query, all device containing the partial
string will be returned.
- name: tag_name
in: query
schema:
type: string
example: accuhive_01
description: Return results for given tag name. Case sensitive.
- name: tag_name_in
in: query
schema:
type: string
example: accuhive_01, accuhive_02
description: >-
Return results for given tag names separate by commas. Case
sensitive.
- name: tag_id
in: query
schema:
type: string
example: ''
description: Search for a tag by its ID. Case sensitive.
- name: tag_id_in
in: query
schema:
type: string
example: ''
description: >-
Return results for given tag IDs separated by commas. Case
sensitive.
- name: user
in: query
schema:
type: string
example: Art Vandelay
description: Return results "containing" the user name
- name: user_email
in: query
schema:
type: string
example: [email protected]
description: Return results "containing" search on email address
- name: user_id
in: query
schema:
type: string
example: '1'
description: '"exact" match on kandji user ID number'
- name: user_name
in: query
schema:
type: string
example: Vandelay
description: Return results "containing" the assigned user Display Name
- name: limit
in: query
schema:
type: string
example: '300'
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: '0'
description: Specify the starting record to return
responses:
'200':
description: >-
List Devices / Query for specific serial number / List Mac only /
List iPhone only / List iPad only
content:
application/json:
schema:
example:
- agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
- agent_installed: true
agent_version: 4.2.1 (4115)
asset_tag: this_is_a_test_03
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 912bc505-a7ee-4d0b-906d-2102f332a4b3
device_name: testuser’s MacBook Air
first_enrollment: '2023-04-07 02:30:09.743933+00:00'
is_missing: true
is_removed: false
last_check_in: '2023-04-26T19:46:14.038587Z'
last_enrollment: '2023-04-25 19:03:10.235020+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: '13.3'
platform: Mac
serial_number: C02FL5YXQ6LC
supplemental_build_version: ''
supplemental_os_version_extra: ''
tags: [ ]
user:
email: [email protected]
id: 9519
is_archived: false
name: Steve Rogers
anyOf:
- type: array
items:
type: object
properties:
agent_installed:
type: boolean
example: true
agent_version:
type: string
example: 4.5.9 (5160)
asset_tag:
type: string
example: sending_tag_to_now
blueprint_id:
type: string
example: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name:
type: string
example: main hive
device_id:
type: string
example: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name:
type: string
example: accuhive's MacBook Air
first_enrollment:
type: string
example: '2024-01-26 16:15:36.087016+00:00'
is_missing:
type: boolean
example: false
is_removed:
type: boolean
example: false
last_check_in:
type: string
example: '2024-07-23T14:11:37.150080Z'
last_enrollment:
type: string
example: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status:
type: string
example: ''
mdm_enabled:
type: boolean
example: true
model:
type: string
example: MacBook Air (M1, 2020)
os_version:
type: string
example: 14.4.1
platform:
type: string
example: Mac
serial_number:
type: string
example: FVHHFKF7Q6L4
supplemental_build_version:
type: string
example: '23E224'
supplemental_os_version_extra:
type: string
example: ''
tags:
type: array
items:
type: string
example: accuhive_02
example:
- accuhive_02
user:
oneOf:
- type: string
- type: object
properties:
email:
type: string
example: [email protected]
id:
type: string
example: 24108
is_archived:
type: boolean
example: false
name:
type: string
example: Accuhive Admin
example:
- agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
- agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
examples:
List Devices:
value:
- agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
- agent_installed: true
agent_version: 4.2.1 (4115)
asset_tag: this_is_a_test_03
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 912bc505-a7ee-4d0b-906d-2102f332a4b3
device_name: testuser’s MacBook Air
first_enrollment: '2023-04-07 02:30:09.743933+00:00'
is_missing: true
is_removed: false
last_check_in: '2023-04-26T19:46:14.038587Z'
last_enrollment: '2023-04-25 19:03:10.235020+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: '13.3'
platform: Mac
serial_number: C02FL5YXQ6LC
supplemental_build_version: ''
supplemental_os_version_extra: ''
tags: [ ]
user:
email: [email protected]
id: 9519
is_archived: false
name: Steve Rogers
List Mac only:
value:
- agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
- agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
List iPad only:
value:
- agent_installed: true
agent_version: ''
asset_tag: ''
blueprint_id: dccade80-bddd-43ac-a9b7-e322b17cd7d9
blueprint_name: _testing_ipados
device_id: 4820db3b-dec7-40b2-9c8f-eb771ac1a250
device_name: iPad
first_enrollment: '2022-12-13 19:14:20.455640+00:00'
is_missing: true
is_removed: false
last_check_in: '2023-01-18T21:46:26.879113Z'
last_enrollment: '2022-12-13 19:14:20.455640+00:00'
lost_mode_status: ''
mdm_enabled: true
model: iPad (8th generation) (Wi-Fi)
os_version: 16.1.1
platform: iPad
serial_number: GG7FF8QSQ1GH
supplemental_build_version: 22F66
supplemental_os_version_extra: ''
tags: [ ]
user: ''
List iPhone only:
value:
- agent_installed: true
agent_version: ''
asset_tag: ''
blueprint_id: b7b58cd8-7ca1-4883-9910-d6643c6e8578
blueprint_name: _ios_testing
device_id: 1db874b1-f480-4974-8f2b-c3abf972824e
device_name: Mobile_Avenger_Base
first_enrollment: '2022-07-12 22:54:49.521027+00:00'
is_missing: true
is_removed: false
last_check_in: '2022-07-12T22:55:35.440699Z'
last_enrollment: '2022-07-12 22:54:49.521027+00:00'
lost_mode_status: ''
mdm_enabled: false
model: iPhone 11 Pro Max
os_version: '15.6'
platform: iPhone
serial_number: FCLD57YLN70G
supplemental_build_version: 22F66
supplemental_os_version_extra: ''
tags: [ ]
user: ''
Query for specific serial number:
value:
agent_installed: true
agent_version: 4.5.9 (5160)
asset_tag: sending_tag_to_now
blueprint_id: ab102b9d-8e9c-420d-a498-f2a1123091c7
blueprint_name: main hive
device_id: 03f81208-2b6a-4a77-81f5-cf1633bcfb95
device_name: accuhive's MacBook Air
first_enrollment: '2024-01-26 16:15:36.087016+00:00'
is_missing: false
is_removed: false
last_check_in: '2024-07-23T14:11:37.150080Z'
last_enrollment: '2024-05-13 20:09:27.374451+00:00'
lost_mode_status: ''
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: 14.4.1
platform: Mac
serial_number: FVHHFKF7Q6L4
supplemental_build_version: '23E224'
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 24108
is_archived: false
name: Accuhive Admin
/api/v1/devices/{device_id}:
get:
tags:
- Device Information
summary: Get Device
description: >-
This request returns the high-level information for a specified Device
ID.
operationId: getDevice
responses:
'200':
description: Get Mac / Get iPad
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '536'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'none'; frame-ancestors 'none'; base-uri 'none';
form-action 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 19:47:26 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
agent_installed:
type: boolean
example: true
agent_version:
type: string
example: 2.7.3 (1253)
asset_tag:
type: string
example: ''
blueprint_id:
type: string
example: 2118bda6-8772-4c5b-ae0a-bb506b2b9516
blueprint_name:
type: string
example: All Staff
device_id:
type: string
example: fc60decb-30cb-4db1-b3ec-2fa8ea1b83ed
device_name:
type: string
example: Test MacBook Air
first_enrollment:
type: string
example: '2021-03-29 21:46:13.552931+00:00'
is_missing:
type: boolean
example: false
is_removed:
type: boolean
example: false
last_check_in:
type: string
example: '2021-03-30T17:46:31.864498Z'
last_enrollment:
type: string
example: '2021-03-29 21:46:13.552931+00:00'
mdm_enabled:
type: boolean
example: true
model:
type: string
example: MacBook Air (M1, 2020)
os_version:
type: string
example: '13.4'
platform:
type: string
example: Mac
serial_number:
type: string
example: AAAAAAAA
supplemental_build_version:
type: string
example: 22F66
supplemental_os_version_extra:
type: string
example: ''
tags:
type: array
items:
type: string
example: accuhive_02
example:
- accuhive_02
user:
type: object
properties:
email:
type: string
example: [email protected]
id:
type: number
example: 23
is_archived:
type: boolean
example: false
name:
type: string
example: Test User
examples:
Get Mac:
value:
agent_installed: true
agent_version: 2.7.3 (1253)
asset_tag: ''
blueprint_id: 2118bda6-8772-4c5b-ae0a-bb506b2b9516
blueprint_name: All Staff
device_id: fc60decb-30cb-4db1-b3ec-2fa8ea1b83ed
device_name: Test MacBook Air
first_enrollment: '2021-03-29 21:46:13.552931+00:00'
is_missing: false
is_removed: false
last_check_in: '2021-03-30T17:46:31.864498Z'
last_enrollment: '2021-03-29 21:46:13.552931+00:00'
mdm_enabled: true
model: MacBook Air (M1, 2020)
os_version: '13.4'
platform: Mac
serial_number: AAAAAAAA
supplemental_build_version: 22F66
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 23
is_archived: false
name: Test User
Get iPad:
value:
agent_installed: true
agent_version: ''
asset_tag: ''
blueprint_id: bde5a8fa-4722-490a-a50b-e6a287835604
blueprint_name: Example Blueprint
device_id: 9b534c11-a7e3-4f34-bceb-c674941622d7
device_name: iPad
first_enrollment: '2021-04-06 19:45:27.100221+00:00'
is_missing: false
is_removed: false
last_check_in: ''
last_enrollment: '2021-04-06 19:45:27.100221+00:00'
mdm_enabled: true
model: iPad Air (4th generation) Wi-Fi + Cellular
os_version: '14.1'
platform: iPad
serial_number: AAAAAAAAAAAA
supplemental_build_version: 22F66
supplemental_os_version_extra: ''
tags:
- accuhive_02
user:
email: [email protected]
id: 23
is_archived: false
name: Test User
delete:
tags:
- Device Actions
summary: Delete Device
description: >-
This endpoint sends an MDM command to delete a device. This will remove
the device record from Kandji and send a Remove Management command. For
macOS devices, it will also send an uninstall command to the Kandji
Agent at the next agent checkin.
operationId: deleteDevice
responses:
'204':
description: Delete Device
content: { }
patch:
tags:
- Device Information
summary: Update Device
description: >-
This request allows you to update device information, such as the
assigned blueprint, user, Asset Tag, and Tags. It is not required to use
all attributes in a given request. For example if you only want to
update the assigned blueprint, you only need to pass the `blueprint_id`
in the request payload.
### Request Parameters
`device_id` (path parameter): The unique identifier of the device.
### Additional information
A Blueprint ID can be found using the `list blueprints` API or in the
URL path while on a Blueprint overview page.
For example, for this URL
[https://subdomain.kandji.io/blueprints/6391086e-85a1-4820-813c-f9c75025fff4](https://subdomain.kandji.io/blueprints/6391086e-85a1-4820-813c-f9c75025fff4)
The Blueprint ID would be `6391086e-85a1-4820-813c-f9c75025fff4`
An example script that leverages this API can be found in the [Kandji
Support
GitHub](https://github.com/kandji-inc/support/tree/main/api-tools/update-device-record)
#### Clearing the device asset tag
To clear a device asset tag, set the `asset_tag` value to `null` in the
JSON payload.
``` json
{
"asset_tag": null
}
```
#### Clearing the assigned user attribute
To clear the assigned user for a given device, set the `user` value to
`null` in the JSON payload.
``` json
{
"user": null
}
```
#### Clearing all tags
To clear the assigned tags for a given device, set the `tags` value to
an empty list `[]` in the JSON payload.
``` json
{
"tags": []
}
```
operationId: updateDevice
requestBody:
content:
application/json:
schema:
type: object
properties:
tags:
type: array
items: { }
example: [ ]
examples:
Update Device:
value:
tags: [ ]
responses:
'200':
description: >-
Update all device attributes / Update asset tag and assigned user /
Update blueprint only / Update tags only
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '634'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:30:49 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
agent_installed:
type: boolean
example: true
agent_version:
type: string
example: 2.7.3 (1253)
asset_tag:
type: string
example: '1040'
blueprint_id:
type: string
example: be1a4d67-91d8-4d19-a927-c8be6e77b6b2
blueprint_name:
type: string
example: Support
device_id:
type: string
example: cb808693-e511-469f-8ee7-d1850de78a49
device_name:
type: string
example: Test Mac mini
first_enrollment:
type: string
example: '2021-03-25 16:31:02.313635+00:00'
is_missing:
type: boolean
example: false
is_removed:
type: boolean
example: false
last_check_in:
type: string
example: '2021-03-25T18:47:54.412799Z'
last_enrollment:
type: string
example: '2021-03-25 16:31:02.313635+00:00'
mdm_enabled:
type: boolean
example: true
model:
type: string
example: Mac mini
os_version:
type: string
example: 10.15.7
platform:
type: string
example: Mac
serial_number:
type: string
example: 57NT5OHHKIED
tags:
type: array
items:
type: string
example: tag1
example:
- tag1
- tag2
- tag3
- tag4
- tag5
user:
type: object
properties:
email:
type: string
example: [email protected]
id:
type: number
example: 23
is_archived:
type: boolean
example: false
name:
type: string
example: Test User
examples:
Update all device attributes:
value:
agent_installed: true
agent_version: 2.7.3 (1253)
asset_tag: '1040'
blueprint_id: be1a4d67-91d8-4d19-a927-c8be6e77b6b2
blueprint_name: Support
device_id: cb808693-e511-469f-8ee7-d1850de78a49
device_name: Test Mac mini
first_enrollment: '2021-03-25 16:31:02.313635+00:00'
is_missing: false
is_removed: false
last_check_in: '2021-03-25T18:47:54.412799Z'
last_enrollment: '2021-03-25 16:31:02.313635+00:00'
mdm_enabled: true
model: Mac mini
os_version: 10.15.7
platform: Mac
serial_number: 57NT5OHHKIED
tags:
- tag1
- tag2
- tag3
- tag4
- tag5
user:
email: [email protected]
id: 23
is_archived: false
name: Test User
Update asset tag and assigned user:
value:
agent_installed: true
agent_version: 2.7.3 (1253)
asset_tag: '1040'
blueprint_id: be1a4d67-91d8-4d19-a927-c8be6e77b6b2
blueprint_name: Support
device_id: cb808693-e511-469f-8ee7-d1850de78a49
device_name: Test Mac mini
first_enrollment: '2021-03-25 16:31:02.313635+00:00'
is_missing: false
is_removed: false
last_check_in: '2021-03-25T18:47:54.412799Z'
last_enrollment: '2021-03-25 16:31:02.313635+00:00'
mdm_enabled: true
model: Mac mini
os_version: 10.15.7
platform: Mac
serial_number: 57NT5OHHKIED
tags: [ ]
user:
email: [email protected]
id: 23
is_archived: false
name: Test User
Update blueprint only:
value:
agent_installed: true
agent_version: 2.7.3 (1253)
asset_tag: '1040'
blueprint_id: be1a4d67-91d8-4d19-a927-c8be6e77b6b2
blueprint_name: Support
device_id: cb808693-e511-469f-8ee7-d1850de78a49
device_name: Test Mac mini
first_enrollment: '2021-03-25 16:31:02.313635+00:00'
is_missing: false
is_removed: false
last_check_in: '2021-03-25T18:47:54.412799Z'
last_enrollment: '2021-03-25 16:31:02.313635+00:00'
mdm_enabled: true
model: Mac mini
os_version: 10.15.7
platform: Mac
serial_number: 57NT5OHHKIED
tags: [ ]
user:
email: [email protected]
id: 23
is_archived: false
name: Test User
Update tags only:
value:
agent_installed: true
agent_version: 2.7.3 (1253)
asset_tag: '1040'
blueprint_id: be1a4d67-91d8-4d19-a927-c8be6e77b6b2
blueprint_name: Support
device_id: cb808693-e511-469f-8ee7-d1850de78a49
device_name: Test Mac mini
first_enrollment: '2021-03-25 16:31:02.313635+00:00'
is_missing: false
is_removed: false
last_check_in: '2021-03-25T18:47:54.412799Z'
last_enrollment: '2021-03-25 16:31:02.313635+00:00'
mdm_enabled: true
model: Mac mini
os_version: 10.15.7
platform: Mac
serial_number: 57NT5OHHKIED
tags:
- tag1
- tag2
- tag3
- tag4
- tag5
user:
email: [email protected]
id: 23
is_archived: false
name: Test User
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/details:
get:
tags:
- Device Information
summary: Get Device Details
description: This request returns the device details for a specified Device ID.
operationId: getDeviceDetails
responses:
'200':
description: Get Mac details / Get iPad details / Get AppleTV details
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '1208'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; frame-ancestors 'none';
default-src 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 19:48:12 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
general:
type: object
properties:
device_id:
type: string
format: uuid
example: "03f81208-2b6a-4a77-81f5-cf1633bcfb95"
device_name:
type: string
example: "testuser’s MacBook Air"
last_enrollment:
type: string
format: date-time
example: "2024-05-13T20:09:27.374451+00:00"
first_enrollment:
type: string
format: date-time
example: "2024-01-26T16:15:36.087016+00:00"
model:
type: string
example: "MacBook Air (M1, 2020)"
platform:
type: string
example: "Mac"
os_version:
type: string
example: "14.4.1"
supplemental_build_version:
type: string
example: "23E224"
supplemental_os_version_extra:
type: string
example: ""
system_version:
type: string
example: "14.4.1 (23E224)"
boot_volume:
type: string
example: "Macintosh HD"
time_since_boot:
type: string
example: "1 month ago"
last_user:
type: string
example: "root"
asset_tag:
type: string
example: "sending_tag_to_now"
assigned_user:
oneOf:
- type: string
- type: object
properties:
email:
type: string
format: email
example: "[email protected]"
name:
type: string
example: "Miss Minutes"
id:
type: string
example: 24108
is_archived:
type: boolean
example: false
blueprint_name:
type: string
example: "_test_something"
blueprint_uuid:
type: string
format: uuid
example: "ab102b9d-8e9c-420d-a498-f2a1123091c7"
mdm:
type: object
properties:
mdm_enabled:
type: string
example: "True"
supervised:
type: string
example: "True"
install_date:
type: string
format: date-time
example: "2024-05-13T20:09:27.213607+00:00"
last_check_in:
type: string
format: date-time
example: "2024-07-23T12:43:15.675470+00:00"
mdm_enabled_user:
type: array
items:
type: string
example: [ "testuser" ]
activation_lock:
type: object
properties:
bypass_code_failed:
type: boolean
example: false
user_activation_lock_enabled:
type: boolean
example: false
device_activation_lock_enabled:
type: boolean
example: false
activation_lock_allowed_while_supervised:
type: boolean
example: false
activation_lock_supported:
type: boolean
example: true
filevault:
type: object
properties:
filevault_enabled:
type: boolean
example: false
filevault_recoverykey_type:
type: string
example: ""
filevault_prk_escrowed:
type: boolean
example: false
filevault_next_rotation:
type: string
example: ""
filevault_regen_required:
type: boolean
example: false
lost_mode:
type: object
additionalProperties: false
automated_device_enrollment:
type: object
additionalProperties: false
kandji_agent:
type: object
properties:
agent_installed:
type: string
example: "True"
install_date:
anyOf:
- type: string
- type: string
format: date-time
example: "2024-06-17T11:32:35+00:00"
last_check_in:
anyOf:
- type: string
- type: string
format: date-time
example: "2024-07-23T14:26:49.166267Z"
agent_version:
type: string
example: "4.5.9 (5160)"
hardware_overview:
type: object
properties:
model_name:
type: string
example: "MacBook Air"
model_identifier:
type: string
example: "MacBookAir10,1"
processor_name:
type: string
example: "Apple M1"
processor_speed:
type: string
example: ""
number_of_processors:
type: string
example: "8"
total_number_of_cores:
type: string
example: "8"
memory:
type: string
example: "8 GB LPDDR4"
udid:
type: string
example: "3c976d96-08a0-5014-89e4-66259ab79fe6"
serial_number:
type: string
example: "FVHHFKF7Q6L4"
volumes:
type: array
items:
type: object
properties:
name:
type: string
example: "Macintosh HD"
format:
type: string
example: "APFS"
percent_used:
type: string
example: "19%"
identifier:
type: string
example: "disk3s3s1"
capacity:
type: string
example: "228.27 GB"
available:
type: string
example: "182.66 GB"
encrypted:
type: string
example: "No"
network:
type: object
properties:
local_hostname:
type: string
example: "testusers-MacBook-Air"
mac_address:
type: string
example: "fc:e2:6c:27:1b:e4"
ip_address:
type: string
example: "192.168.1.76"
public_ip:
type: string
example: ""
recovery_information:
type: object
properties:
recovery_lock_enabled:
type: boolean
example: true
firmware_password_exist:
type: boolean
example: false
firmware_password_pending:
type: boolean
example: false
password_rotation_scheduled:
type: string
format: date-time
example: "2024-09-10T11:48:00.610908Z"
password_has_been_set:
type: boolean
example: true
users:
type: object
properties:
regular_users:
type: array
items:
type: object
properties:
username:
type: string
example: "testuser"
uid:
type: string
example: "501"
path:
type: string
example: "/Users/testuser"
admin:
type: string
example: "Yes"
name:
type: string
example: ""
system_users:
type: array
items:
type: object
properties:
username:
type: string
example: "_lp"
uid:
type: string
example: "26"
path:
type: string
example: "/var/spool/cups"
admin:
type: string
example: "No"
installed_profiles:
type: array
items:
type: object
properties:
name:
type: string
example: "MDM Profile"
uuid:
type: string
format: uuid
example: "35fec4f0-88f4-41c5-b3c1-e6da3f0f592d"
verified:
type: string
example: "verified"
identifier:
type: string
example: "com.kandji.profile.mdmprofile"
organization:
type: string
example: "Kandji, Inc."
payload_types:
type: array
items:
type: string
example:
- "com.apple.mdm"
- "com.apple.security.scep"
install_date:
type: string
format: date-time
example: "2024-05-13T20:09:23+00:00"
apple_business_manager:
type: object
additionalProperties: false
security_information:
type: object
properties:
remote_desktop_enabled:
type: boolean
example: true
cellular:
type: object
additionalProperties: false
tags:
type: array
items:
type: string
example: [ "accuhive_02" ]
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/details/lostmode:
get:
tags:
- Device Information
summary: Get Device Lost Mode details
description: >-
This request returns the device lost mode details for a specified Device
ID.
**Note**: Lost Mode is is only available for iOS and iPadOS. For more
information, please see this [Kandji support
artilcle](https://support.kandji.io/a/solutions/articles/72000573873).
operationId: getDeviceLostModeDetails
responses:
'200':
description: Get Device Lost Mode details
content:
application/json:
schema:
type: object
properties:
device_id:
type: string
example: 4820db3b-dec7-40b2-9c8f-eb771ac1a250
lost_mode:
type: object
properties:
disable_status:
type: string
example: ''
disable_status_at:
type: string
example: ''
disabled_by:
type: string
example: ''
enable_status_at:
type: string
example: '2022-12-13T20:19:08.116096Z'
enabled_by:
type: string
example: Accuhive Admin
last_location:
type: object
properties:
latitude:
type: string
example: '33.93410519355257'
longitude:
type: string
example: '-84.47411387632086'
last_location_at:
type: string
example: '2022-12-13T20:20:10.093380Z'
last_location_status:
type: string
example: SUCCESS
last_location_status_at:
type: string
example: '2022-12-13T20:20:10.103693Z'
lock_screen_footnote:
type: string
example: This is an example footnote.
lock_screen_message:
type: string
example: Hey i just did this from the enable lost mode API
lock_screen_phone_number:
type: string
example: '1234567890'
lost_mode_status:
type: string
example: ENABLED
sound_status:
type: string
example: SUCCESS
sound_status_at:
type: string
example: '2022-12-13T20:21:38.992261Z'
examples:
Get Device Lost Mode details:
value:
device_id: 4820db3b-dec7-40b2-9c8f-eb771ac1a250
lost_mode:
disable_status: ''
disable_status_at: ''
disabled_by: ''
enable_status_at: '2022-12-13T20:19:08.116096Z'
enabled_by: Accuhive Admin
last_location:
latitude: '33.93410519355257'
longitude: '-84.47411387632086'
last_location_at: '2022-12-13T20:20:10.093380Z'
last_location_status: SUCCESS
last_location_status_at: '2022-12-13T20:20:10.103693Z'
lock_screen_footnote: This is an example footnote.
lock_screen_message: Hey i just did this from the enable lost mode API
lock_screen_phone_number: '1234567890'
lost_mode_status: ENABLED
sound_status: SUCCESS
sound_status_at: '2022-12-13T20:21:38.992261Z'
'400':
description: Device not in lost mode
content:
application/json:
schema:
type: array
items:
type: string
example: Device is not in lost mode.
example:
- Device is not in lost mode.
examples:
Device not in lost mode:
value:
- Device is not in lost mode.
delete:
tags:
- Device Information
summary: Cancel Lost Mode
description: >-
This endpoint can be used to send a cancelation request if Lost Mode is
in an error state for a given iOS or iPadOS device.
operationId: cancelLostMode
responses:
'200':
description: ''
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/activity:
get:
tags:
- Device Information
summary: Get Device Activity
description: This request returns the device activity for a specified Device ID.
operationId: getDeviceActivity
parameters:
- name: limit
in: query
schema:
type: string
example: '300'
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: '0'
description: Specify the starting record to return
responses:
'200':
description: Get Device Activity
headers:
Allow:
schema:
type: string
example: GET, HEAD, OPTIONS
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '34177'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; frame-ancestors 'none'; form-action 'none';
default-src 'none'
Date:
schema:
type: string
example: Fri, 14 May 2021 00:33:24 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
activity:
type: object
properties:
count:
type: number
example: 46
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
action_type:
type: string
example: enrollment
blueprint:
type: object
properties:
id:
type: string
example: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed:
type: boolean
example: false
name:
type: string
example: NewEnrollment
nullable: true
computer:
type: object
properties:
id:
type: string
example: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed:
type: boolean
example: false
name:
type: string
example: iPad
created_at:
type: string
example: '2021-04-19T18:09:06.865152Z'
details:
type: object
properties:
attempts:
type: number
example: 1
blueprint_name:
type: string
example: NewEnrollment
command_type:
type: string
example: ActivationLockBypassCode
date_completed:
type: string
example: '2021-03-30T18:07:28.186776Z'
date_requested:
type: string
example: '2021-03-30T18:07:27.804250Z'
enrollment_type:
type: string
example: DEP
error_chain:
type: array
items: { }
example: [ ]
from:
type: string
example: iPad
is_silent:
type: boolean
example: false
last_pushed:
type: string
example: '2021-03-30T18:07:27.869132Z'
metadata:
type: object
properties:
Items:
type: array
items:
type: string
example: MDMOptions
example:
- MDMOptions
request:
type: string
example: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority:
type: number
example: 0
profile_name:
nullable: true
example: null
profile_uuid:
nullable: true
example: null
request_requires_network_tether:
type: boolean
example: false
request_type:
type: string
example: ActivationLockBypassCode
status:
type: number
example: 3
to:
type: string
example: No name
user:
nullable: true
example: null
username:
nullable: true
example: null
uuid:
type: string
example: 7f3b07eb-6de5-4fde-9942-d02ae1a0513d
id:
type: number
example: 6361
user:
nullable: true
example: null
example:
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:06.865152Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 6361
user: null
- action_type: name_changed
blueprint: null
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:07.135278Z'
details:
from: iPad
to: No name
id: 6363
user: null
- action_type: name_changed
blueprint: null
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:34.061554Z'
details:
from: iPad
to: No name
id: 6389
user: null
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:25.717406Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 5973
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:28.195017Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-03-30T18:07:28.186776Z'
date_requested: '2021-03-30T18:07:27.804250Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:27.869132Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 3
user: null
username: null
uuid: 7f3b07eb-6de5-4fde-9942-d02ae1a0513d
id: 5975
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:28.616944Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-03-30T18:07:28.609114Z'
date_requested: '2021-03-30T18:07:27.823122Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:28.215228Z'
metadata:
Items:
- MDMOptions
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 7e677dc1-550c-49f2-90b2-4825f2ae3f79
id: 5976
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:28.969436Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-03-30T18:07:28.962094Z'
date_requested: '2021-03-30T18:07:27.841671Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:28.637185Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: 498d01e5-f4d3-4eb8-8c4f-c15fe29f8190
id: 5977
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:41.722973Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-03-30T18:07:41.715109Z'
date_requested: '2021-03-30T18:07:41.065813Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:41.363998Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: 1a231ea7-9f92-4c62-b56e-d422c092bddf
id: 5978
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:42.186834Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-03-30T18:07:42.179027Z'
date_requested: '2021-03-30T18:07:41.096045Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:41.732682Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 35d2078c-13f3-42a2-889e-8fc90609f9d4
id: 5979
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:42.548608Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-03-30T18:07:42.541505Z'
date_requested: '2021-03-30T18:07:41.115379Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:42.197706Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: 34635ea9-d9cf-4684-ab8b-6e95752584c6
id: 5980
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:42.912740Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-03-30T18:07:42.904447Z'
date_requested: '2021-03-30T18:07:41.138287Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:42.558635Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: 7162a4f2-780a-4031-9417-76d9da080880
id: 5981
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:43.267503Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-03-30T18:07:43.258979Z'
date_requested: '2021-03-30T18:07:41.186337Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:42.922462Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: a297a98f-74ab-460a-b7a4-b01ef7ba8e0d
id: 5982
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:43.723105Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-03-30T18:07:43.715321Z'
date_requested: '2021-03-30T18:07:41.590898Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:43.277496Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: a1626e84-c496-4900-b4fd-b32e3a1a562d
id: 5983
user: null
- action_type: mdm_command_failed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:08.925704Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-04-19T18:09:08.918306Z'
date_requested: '2021-04-19T18:09:08.534803Z'
error_chain:
- code: 12021
domain: MCMDMErrorDomain
localized_description: >-
“ActivationLockBypassCode” is not a valid
request type.
us_english_description: >-
“ActivationLockBypassCode” is not a valid
request type.
is_silent: false
last_pushed: '2021-04-19T18:09:08.631369Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 4
user: null
username: null
uuid: b48b7da0-9a2b-40b9-9ded-4e3a95310e7f
id: 6364
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:09.281529Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-04-19T18:09:09.274604Z'
date_requested: '2021-04-19T18:09:08.566561Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:08.933652Z'
metadata:
Items:
- MDMOptions
- SharedDeviceConfiguration
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 37213033-5c07-407c-92a0-e3c29e4bf6fb
id: 6365
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:09.624498Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-04-19T18:09:09.617146Z'
date_requested: '2021-04-19T18:09:08.591847Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:09.292711Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: 043bb907-c914-4a25-bfa2-7ec384095037
id: 6366
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:21.873645Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-04-19T18:09:21.867942Z'
date_requested: '2021-04-19T18:09:11.928261Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:18.999928Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: 2e6233b7-84e8-4f7a-9375-c95009be10dd
id: 6367
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:23.162151Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-04-19T18:09:23.155317Z'
date_requested: '2021-04-19T18:09:11.961863Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:21.880775Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 7946e11f-eba9-4bc9-9533-761fe9526931
id: 6368
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:23.476951Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-04-19T18:09:23.471023Z'
date_requested: '2021-04-19T18:09:11.988118Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:23.169619Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: cbcdd2d3-d56a-4293-a521-7eca743cf499
id: 6369
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:23.792486Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-04-19T18:09:23.785834Z'
date_requested: '2021-04-19T18:09:12.010806Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:23.490562Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: e776b938-781a-419b-8cd9-bcd98bd9a9c1
id: 6370
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:24.120121Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-04-19T18:09:24.112750Z'
date_requested: '2021-04-19T18:09:12.064613Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:23.802034Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: bef660f1-08ef-4e3c-bbcb-13e20794d8ef
id: 6371
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:24.467448Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-04-19T18:09:24.459467Z'
date_requested: '2021-04-19T18:09:12.567187Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:24.129840Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: f4aecf33-14ba-480e-a892-597b5bdf9872
id: 6372
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:46.358090Z'
details:
attempts: 1
command_type: DeveloperCustomCommand
date_completed: '2021-04-19T18:09:46.352281Z'
date_requested: '2021-04-19T18:09:45.323246Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:46.035918Z'
metadata:
request: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: a1caae28-8608-4c31-a9b0-a3e5d520a5df
id: 6373
user: null
- action_type: mdm_command_failed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:36.471936Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-04-19T20:00:36.461599Z'
date_requested: '2021-04-19T20:00:36.039100Z'
error_chain:
- code: 12021
domain: MCMDMErrorDomain
localized_description: >-
“ActivationLockBypassCode” is not a valid
request type.
us_english_description: >-
“ActivationLockBypassCode” is not a valid
request type.
is_silent: false
last_pushed: '2021-04-19T20:00:36.117200Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 4
user: null
username: null
uuid: 318f74ec-3bd5-4286-9c79-59f548f6f93e
id: 6390
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:13:39.102708Z'
details:
attempts: 1
command_type: DeveloperCustomCommand
date_completed: '2021-04-19T18:13:39.095812Z'
date_requested: '2021-04-19T18:13:37.908670Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:13:38.766762Z'
metadata:
request: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 65d9342e-dd45-4928-bb1a-0ce0bf8a036a
id: 6374
user: null
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:10.193630Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 6375
user: null
- action_type: name_changed
blueprint: null
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:10.518165Z'
details:
from: iPad
to: No name
id: 6377
user: null
- action_type: mdm_command_failed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:12.754227Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-04-19T19:57:12.745386Z'
date_requested: '2021-04-19T19:57:12.091036Z'
error_chain:
- code: 12021
domain: MCMDMErrorDomain
localized_description: >-
“ActivationLockBypassCode” is not a valid
request type.
us_english_description: >-
“ActivationLockBypassCode” is not a valid
request type.
is_silent: false
last_pushed: '2021-04-19T19:57:12.410977Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 4
user: null
username: null
uuid: de121f7e-4b5b-4896-b151-6697ab49516f
id: 6378
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:13.109205Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-04-19T19:57:13.100251Z'
date_requested: '2021-04-19T19:57:12.359723Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:12.763863Z'
metadata:
Items:
- MDMOptions
- SharedDeviceConfiguration
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: bbdabcc4-4849-4801-af31-4d9d21d486a2
id: 6379
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:13.438439Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-04-19T19:57:13.431462Z'
date_requested: '2021-04-19T19:57:12.382582Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:13.119505Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: 98702232-a826-48d7-acc3-983628d18100
id: 6380
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:25.821757Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-04-19T19:57:25.812174Z'
date_requested: '2021-04-19T19:57:15.682921Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:22.665806Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: cee43b29-19bd-41b9-8b25-20c5b598a3d5
id: 6381
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:26.920393Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-04-19T19:57:26.909327Z'
date_requested: '2021-04-19T19:57:15.702621Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:25.833448Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 1410e124-7b01-4b08-bed3-d17805a7f91b
id: 6382
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:27.388310Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-04-19T19:57:27.375605Z'
date_requested: '2021-04-19T19:57:15.716198Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:26.936713Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: 3384ade9-140a-4bca-ac72-e72729fe9da5
id: 6383
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:27.704612Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-04-19T19:57:27.696659Z'
date_requested: '2021-04-19T19:57:15.731508Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:27.398171Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: 8e015b3d-1a51-4c9f-8c01-8b29b72abf52
id: 6384
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:27.989064Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-04-19T19:57:27.983476Z'
date_requested: '2021-04-19T19:57:15.766025Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:27.711417Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: 3b4668bc-c925-4b25-a838-8483180350b4
id: 6385
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:28.313299Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-04-19T19:57:28.307171Z'
date_requested: '2021-04-19T19:57:16.135218Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:27.995398Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: 6900f511-b3c3-4a9f-90f8-4dcf3f34dd0f
id: 6386
user: null
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:33.788794Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 6387
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:36.809282Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-04-19T20:00:36.800503Z'
date_requested: '2021-04-19T20:00:36.069502Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:36.482120Z'
metadata:
Items:
- MDMOptions
- SharedDeviceConfiguration
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 99ba9521-4873-402f-a143-66ef8a1daeac
id: 6391
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:37.167181Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-04-19T20:00:37.160875Z'
date_requested: '2021-04-19T20:00:36.091346Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:36.819036Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: d4e69629-0fcb-4724-9c49-ac65eac61534
id: 6392
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:46.024064Z'
details:
attempts: 1
command_type: DeveloperCustomCommand
date_completed: '2021-04-19T20:00:46.017324Z'
date_requested: '2021-04-19T20:00:37.438733Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:37.511888Z'
metadata:
request: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: b10b0d06-6866-4ac7-a729-e8f139fa581e
id: 6393
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:53.024422Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-04-19T20:00:53.017565Z'
date_requested: '2021-04-19T20:00:39.297026Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:46.036906Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: fd922d7d-da83-4507-ba1a-1b272a7c690a
id: 6394
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:54.924227Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-04-19T20:00:54.918635Z'
date_requested: '2021-04-19T20:00:39.337038Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:53.033987Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 5de58bae-ac69-4ff4-a83d-64a2b9d922b6
id: 6395
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:55.259870Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-04-19T20:00:55.252769Z'
date_requested: '2021-04-19T20:00:39.359373Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:54.930565Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: dd0dd5d1-244e-4ef0-86f5-23fe68134038
id: 6396
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:55.624451Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-04-19T20:00:55.616124Z'
date_requested: '2021-04-19T20:00:39.391303Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:55.269212Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: 2616627a-d5d6-4cc2-b776-9f756e1e17d9
id: 6397
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:55.952184Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-04-19T20:00:55.947010Z'
date_requested: '2021-04-19T20:00:39.503698Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:55.634775Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: 6d7c44fc-c0d4-4aab-96ad-51cf27f752f8
id: 6398
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:56.312728Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-04-19T20:00:56.303598Z'
date_requested: '2021-04-19T20:00:40.017581Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:55.961876Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: b02bcaf8-2195-4da3-9c90-2fcfb871696e
id: 6399
user: null
device_id:
type: string
example: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
examples:
Get Device Activity:
value:
activity:
count: 46
next: null
previous: null
results:
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:06.865152Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 6361
user: null
- action_type: name_changed
blueprint: null
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:07.135278Z'
details:
from: iPad
to: No name
id: 6363
user: null
- action_type: name_changed
blueprint: null
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:34.061554Z'
details:
from: iPad
to: No name
id: 6389
user: null
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:25.717406Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 5973
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:28.195017Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-03-30T18:07:28.186776Z'
date_requested: '2021-03-30T18:07:27.804250Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:27.869132Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 3
user: null
username: null
uuid: 7f3b07eb-6de5-4fde-9942-d02ae1a0513d
id: 5975
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:28.616944Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-03-30T18:07:28.609114Z'
date_requested: '2021-03-30T18:07:27.823122Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:28.215228Z'
metadata:
Items:
- MDMOptions
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 7e677dc1-550c-49f2-90b2-4825f2ae3f79
id: 5976
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:28.969436Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-03-30T18:07:28.962094Z'
date_requested: '2021-03-30T18:07:27.841671Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:28.637185Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: 498d01e5-f4d3-4eb8-8c4f-c15fe29f8190
id: 5977
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:41.722973Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-03-30T18:07:41.715109Z'
date_requested: '2021-03-30T18:07:41.065813Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:41.363998Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: 1a231ea7-9f92-4c62-b56e-d422c092bddf
id: 5978
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:42.186834Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-03-30T18:07:42.179027Z'
date_requested: '2021-03-30T18:07:41.096045Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:41.732682Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 35d2078c-13f3-42a2-889e-8fc90609f9d4
id: 5979
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:42.548608Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-03-30T18:07:42.541505Z'
date_requested: '2021-03-30T18:07:41.115379Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:42.197706Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: 34635ea9-d9cf-4684-ab8b-6e95752584c6
id: 5980
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:42.912740Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-03-30T18:07:42.904447Z'
date_requested: '2021-03-30T18:07:41.138287Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:42.558635Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: 7162a4f2-780a-4031-9417-76d9da080880
id: 5981
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:43.267503Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-03-30T18:07:43.258979Z'
date_requested: '2021-03-30T18:07:41.186337Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:42.922462Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: a297a98f-74ab-460a-b7a4-b01ef7ba8e0d
id: 5982
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-03-30T18:07:43.723105Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-03-30T18:07:43.715321Z'
date_requested: '2021-03-30T18:07:41.590898Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-03-30T18:07:43.277496Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: a1626e84-c496-4900-b4fd-b32e3a1a562d
id: 5983
user: null
- action_type: mdm_command_failed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:08.925704Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-04-19T18:09:08.918306Z'
date_requested: '2021-04-19T18:09:08.534803Z'
error_chain:
- code: 12021
domain: MCMDMErrorDomain
localized_description: >-
“ActivationLockBypassCode” is not a valid
request type.
us_english_description: >-
“ActivationLockBypassCode” is not a valid
request type.
is_silent: false
last_pushed: '2021-04-19T18:09:08.631369Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 4
user: null
username: null
uuid: b48b7da0-9a2b-40b9-9ded-4e3a95310e7f
id: 6364
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:09.281529Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-04-19T18:09:09.274604Z'
date_requested: '2021-04-19T18:09:08.566561Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:08.933652Z'
metadata:
Items:
- MDMOptions
- SharedDeviceConfiguration
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 37213033-5c07-407c-92a0-e3c29e4bf6fb
id: 6365
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:09.624498Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-04-19T18:09:09.617146Z'
date_requested: '2021-04-19T18:09:08.591847Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:09.292711Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: 043bb907-c914-4a25-bfa2-7ec384095037
id: 6366
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:21.873645Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-04-19T18:09:21.867942Z'
date_requested: '2021-04-19T18:09:11.928261Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:18.999928Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: 2e6233b7-84e8-4f7a-9375-c95009be10dd
id: 6367
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:23.162151Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-04-19T18:09:23.155317Z'
date_requested: '2021-04-19T18:09:11.961863Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:21.880775Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 7946e11f-eba9-4bc9-9533-761fe9526931
id: 6368
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:23.476951Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-04-19T18:09:23.471023Z'
date_requested: '2021-04-19T18:09:11.988118Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:23.169619Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: cbcdd2d3-d56a-4293-a521-7eca743cf499
id: 6369
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:23.792486Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-04-19T18:09:23.785834Z'
date_requested: '2021-04-19T18:09:12.010806Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:23.490562Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: e776b938-781a-419b-8cd9-bcd98bd9a9c1
id: 6370
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:24.120121Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-04-19T18:09:24.112750Z'
date_requested: '2021-04-19T18:09:12.064613Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:23.802034Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: bef660f1-08ef-4e3c-bbcb-13e20794d8ef
id: 6371
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:24.467448Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-04-19T18:09:24.459467Z'
date_requested: '2021-04-19T18:09:12.567187Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:24.129840Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: f4aecf33-14ba-480e-a892-597b5bdf9872
id: 6372
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:09:46.358090Z'
details:
attempts: 1
command_type: DeveloperCustomCommand
date_completed: '2021-04-19T18:09:46.352281Z'
date_requested: '2021-04-19T18:09:45.323246Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:09:46.035918Z'
metadata:
request: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: a1caae28-8608-4c31-a9b0-a3e5d520a5df
id: 6373
user: null
- action_type: mdm_command_failed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:36.471936Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-04-19T20:00:36.461599Z'
date_requested: '2021-04-19T20:00:36.039100Z'
error_chain:
- code: 12021
domain: MCMDMErrorDomain
localized_description: >-
“ActivationLockBypassCode” is not a valid
request type.
us_english_description: >-
“ActivationLockBypassCode” is not a valid
request type.
is_silent: false
last_pushed: '2021-04-19T20:00:36.117200Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 4
user: null
username: null
uuid: 318f74ec-3bd5-4286-9c79-59f548f6f93e
id: 6390
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T18:13:39.102708Z'
details:
attempts: 1
command_type: DeveloperCustomCommand
date_completed: '2021-04-19T18:13:39.095812Z'
date_requested: '2021-04-19T18:13:37.908670Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T18:13:38.766762Z'
metadata:
request: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 65d9342e-dd45-4928-bb1a-0ce0bf8a036a
id: 6374
user: null
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:10.193630Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 6375
user: null
- action_type: name_changed
blueprint: null
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:10.518165Z'
details:
from: iPad
to: No name
id: 6377
user: null
- action_type: mdm_command_failed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:12.754227Z'
details:
attempts: 1
command_type: ActivationLockBypassCode
date_completed: '2021-04-19T19:57:12.745386Z'
date_requested: '2021-04-19T19:57:12.091036Z'
error_chain:
- code: 12021
domain: MCMDMErrorDomain
localized_description: >-
“ActivationLockBypassCode” is not a valid
request type.
us_english_description: >-
“ActivationLockBypassCode” is not a valid
request type.
is_silent: false
last_pushed: '2021-04-19T19:57:12.410977Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ActivationLockBypassCode
status: 4
user: null
username: null
uuid: de121f7e-4b5b-4896-b151-6697ab49516f
id: 6378
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:13.109205Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-04-19T19:57:13.100251Z'
date_requested: '2021-04-19T19:57:12.359723Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:12.763863Z'
metadata:
Items:
- MDMOptions
- SharedDeviceConfiguration
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: bbdabcc4-4849-4801-af31-4d9d21d486a2
id: 6379
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:13.438439Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-04-19T19:57:13.431462Z'
date_requested: '2021-04-19T19:57:12.382582Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:13.119505Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: 98702232-a826-48d7-acc3-983628d18100
id: 6380
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:25.821757Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-04-19T19:57:25.812174Z'
date_requested: '2021-04-19T19:57:15.682921Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:22.665806Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: cee43b29-19bd-41b9-8b25-20c5b598a3d5
id: 6381
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:26.920393Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-04-19T19:57:26.909327Z'
date_requested: '2021-04-19T19:57:15.702621Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:25.833448Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 1410e124-7b01-4b08-bed3-d17805a7f91b
id: 6382
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:27.388310Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-04-19T19:57:27.375605Z'
date_requested: '2021-04-19T19:57:15.716198Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:26.936713Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: 3384ade9-140a-4bca-ac72-e72729fe9da5
id: 6383
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:27.704612Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-04-19T19:57:27.696659Z'
date_requested: '2021-04-19T19:57:15.731508Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:27.398171Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: 8e015b3d-1a51-4c9f-8c01-8b29b72abf52
id: 6384
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:27.989064Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-04-19T19:57:27.983476Z'
date_requested: '2021-04-19T19:57:15.766025Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:27.711417Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: 3b4668bc-c925-4b25-a838-8483180350b4
id: 6385
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T19:57:28.313299Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-04-19T19:57:28.307171Z'
date_requested: '2021-04-19T19:57:16.135218Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T19:57:27.995398Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: 6900f511-b3c3-4a9f-90f8-4dcf3f34dd0f
id: 6386
user: null
- action_type: enrollment
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:33.788794Z'
details:
blueprint_name: NewEnrollment
enrollment_type: DEP
id: 6387
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:36.809282Z'
details:
attempts: 1
command_type: SetInitialConfiguration
date_completed: '2021-04-19T20:00:36.800503Z'
date_requested: '2021-04-19T20:00:36.069502Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:36.482120Z'
metadata:
Items:
- MDMOptions
- SharedDeviceConfiguration
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: 99ba9521-4873-402f-a143-66ef8a1daeac
id: 6391
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:37.167181Z'
details:
attempts: 1
command_type: DeviceConfigured
date_completed: '2021-04-19T20:00:37.160875Z'
date_requested: '2021-04-19T20:00:36.091346Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:36.819036Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceConfigured
status: 3
user: null
username: null
uuid: d4e69629-0fcb-4724-9c49-ac65eac61534
id: 6392
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:46.024064Z'
details:
attempts: 1
command_type: DeveloperCustomCommand
date_completed: '2021-04-19T20:00:46.017324Z'
date_requested: '2021-04-19T20:00:37.438733Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:37.511888Z'
metadata:
request: >-
'\n\n\n\nCommand \n\nRequestType \nSettings \nSettings \n\n\nItem \nSharedDeviceConfiguration \nTemporarySessionTimeout \n30 \n \n \n \nCommandUUID \nwill-be-changed \n \n '
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: Settings
status: 3
user: null
username: null
uuid: b10b0d06-6866-4ac7-a729-e8f139fa581e
id: 6393
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:53.024422Z'
details:
attempts: 1
command_type: DeviceInformation
date_completed: '2021-04-19T20:00:53.017565Z'
date_requested: '2021-04-19T20:00:39.297026Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:46.036906Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: DeviceInformation
status: 3
user: null
username: null
uuid: fd922d7d-da83-4507-ba1a-1b272a7c690a
id: 6394
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:54.924227Z'
details:
attempts: 1
command_type: AvailableOSUpdates
date_completed: '2021-04-19T20:00:54.918635Z'
date_requested: '2021-04-19T20:00:39.337038Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:53.033987Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: AvailableOSUpdates
status: 3
user: null
username: null
uuid: 5de58bae-ac69-4ff4-a83d-64a2b9d922b6
id: 6395
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:55.259870Z'
details:
attempts: 1
command_type: CertificateList
date_completed: '2021-04-19T20:00:55.252769Z'
date_requested: '2021-04-19T20:00:39.359373Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:54.930565Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: CertificateList
status: 3
user: null
username: null
uuid: dd0dd5d1-244e-4ef0-86f5-23fe68134038
id: 6396
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:55.624451Z'
details:
attempts: 1
command_type: SecurityInfo
date_completed: '2021-04-19T20:00:55.616124Z'
date_requested: '2021-04-19T20:00:39.391303Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:55.269212Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: SecurityInfo
status: 3
user: null
username: null
uuid: 2616627a-d5d6-4cc2-b776-9f756e1e17d9
id: 6397
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:55.952184Z'
details:
attempts: 1
command_type: ProfileList
date_completed: '2021-04-19T20:00:55.947010Z'
date_requested: '2021-04-19T20:00:39.503698Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:55.634775Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: ProfileList
status: 3
user: null
username: null
uuid: 6d7c44fc-c0d4-4aab-96ad-51cf27f752f8
id: 6398
user: null
- action_type: mdm_command_completed
blueprint:
id: 8c7e0b97-54e4-4ea0-8cf9-184ddb47de4b
is_removed: false
name: NewEnrollment
computer:
id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
is_removed: false
name: iPad
created_at: '2021-04-19T20:00:56.312728Z'
details:
attempts: 1
command_type: InstalledApplicationList
date_completed: '2021-04-19T20:00:56.303598Z'
date_requested: '2021-04-19T20:00:40.017581Z'
error_chain: [ ]
is_silent: false
last_pushed: '2021-04-19T20:00:55.961876Z'
metadata: { }
priority: 0
profile_name: null
profile_uuid: null
request_requires_network_tether: false
request_type: InstalledApplicationList
status: 3
user: null
username: null
uuid: b02bcaf8-2195-4da3-9c90-2fcfb871696e
id: 6399
user: null
device_id: 9d6eda80-6058-40bb-94f0-3c7ba4a63eb6
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/apps:
get:
tags:
- Device Information
summary: Get Device Apps
description: >-
This request returns a list of all installed apps for a specified Device
ID.
For iPhone and iPad, the preinstalled Apple apps are not reported.
operationId: getDeviceApps
responses:
'200':
description: Mac apps / iPad apps
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '20184'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:23:27 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Link:
schema:
type: string
example: ; rel="next", ; rel="prev"
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Total-Count:
schema:
type: string
example: '55'
X-Total-Pages:
schema:
type: string
example: '1'
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
apps:
type: array
items:
type: object
properties:
app_id:
type: string
example: '83068'
app_name:
type: string
example: Activity Monitor
app_store_vendable:
type: string
example: ''
bundle_id:
type: string
example: com.apple.ActivityMonitor
bundle_size:
type: string
example: '1'
creation_date:
type: string
example: '2023-06-06T19:43:15.206870Z'
device_based_vpp:
type: string
example: ''
modification_date:
type: string
example: '2023-06-06T19:43:15.206888Z'
path:
type: string
example: /System/Applications/Utilities/Activity Monitor.app
process:
type: string
example: Activity Monitor
signature:
type: string
example: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source:
type: string
example: Apple
version:
type: string
example: '10.14'
example:
- app_id: '83068'
app_name: Activity Monitor
app_store_vendable: ''
bundle_id: com.apple.ActivityMonitor
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206870Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206888Z'
path: /System/Applications/Utilities/Activity Monitor.app
process: Activity Monitor
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.14'
- app_id: '83069'
app_name: AirPort Utility
app_store_vendable: ''
bundle_id: com.apple.airport.airportutility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206937Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206941Z'
path: /System/Applications/Utilities/AirPort Utility.app
process: AirPort Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 6.3.9
- app_id: '83070'
app_name: App Store
app_store_vendable: ''
bundle_id: com.apple.AppStore
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206966Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206969Z'
path: /System/Applications/App Store.app
process: App Store
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.0'
- app_id: '83071'
app_name: Audio MIDI Setup
app_store_vendable: ''
bundle_id: com.apple.audio.AudioMIDISetup
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206991Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206995Z'
path: /System/Applications/Utilities/Audio MIDI Setup.app
process: Audio MIDI Setup
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.5'
- app_id: '83072'
app_name: Automator
app_store_vendable: ''
bundle_id: com.apple.Automator
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207017Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207021Z'
path: /System/Applications/Automator.app
process: Automator
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.10'
- app_id: '83073'
app_name: Bluetooth File Exchange
app_store_vendable: ''
bundle_id: com.apple.BluetoothFileExchange
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207043Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207047Z'
path: >-
/System/Applications/Utilities/Bluetooth File
Exchange.app
process: Bluetooth File Exchange
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '9.0'
- app_id: '83074'
app_name: Books
app_store_vendable: ''
bundle_id: com.apple.iBooksX
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207070Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207073Z'
path: /System/Applications/Books.app
process: Books
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '5.2'
- app_id: '83075'
app_name: Boot Camp Assistant
app_store_vendable: ''
bundle_id: com.apple.bootcampassistant
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207095Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207099Z'
path: /System/Applications/Utilities/Boot Camp Assistant.app
process: Boot Camp Assistant
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 6.1.0
- app_id: '83076'
app_name: Calculator
app_store_vendable: ''
bundle_id: com.apple.calculator
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207120Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207124Z'
path: /System/Applications/Calculator.app
process: Calculator
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.16'
- app_id: '83077'
app_name: Calendar
app_store_vendable: ''
bundle_id: com.apple.iCal
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207150Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207156Z'
path: /System/Applications/Calendar.app
process: Calendar
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '13.0'
- app_id: '83078'
app_name: Chess
app_store_vendable: ''
bundle_id: com.apple.Chess
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207191Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207197Z'
path: /System/Applications/Chess.app
process: Chess
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.18'
- app_id: '83079'
app_name: Clock
app_store_vendable: ''
bundle_id: com.apple.clock
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207235Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207240Z'
path: /System/Applications/Clock.app
process: Clock
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83080'
app_name: ColorSync Utility
app_store_vendable: ''
bundle_id: com.apple.ColorSyncUtility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207276Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207282Z'
path: /System/Applications/Utilities/ColorSync Utility.app
process: ColorSync Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 12.0.0
- app_id: '83081'
app_name: Console
app_store_vendable: ''
bundle_id: com.apple.Console
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207323Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207329Z'
path: /System/Applications/Utilities/Console.app
process: Console
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.1'
- app_id: '83082'
app_name: Contacts
app_store_vendable: ''
bundle_id: com.apple.AddressBook
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207363Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207370Z'
path: /System/Applications/Contacts.app
process: Contacts
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: No value
- app_id: '83083'
app_name: Dictionary
app_store_vendable: ''
bundle_id: com.apple.Dictionary
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207407Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207415Z'
path: /System/Applications/Dictionary.app
process: Dictionary
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 2.3.0
- app_id: '83084'
app_name: Digital Color Meter
app_store_vendable: ''
bundle_id: com.apple.DigitalColorMeter
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207442Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207446Z'
path: /System/Applications/Utilities/Digital Color Meter.app
process: Digital Color Meter
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '5.22'
- app_id: '83085'
app_name: Disk Utility
app_store_vendable: ''
bundle_id: com.apple.DiskUtility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207468Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207472Z'
path: /System/Applications/Utilities/Disk Utility.app
process: Disk Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '22.6'
- app_id: '83086'
app_name: FaceTime
app_store_vendable: ''
bundle_id: com.apple.FaceTime
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207495Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207499Z'
path: /System/Applications/FaceTime.app
process: FaceTime
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '5.0'
- app_id: '83087'
app_name: FindMy
app_store_vendable: ''
bundle_id: com.apple.findmy
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207522Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207526Z'
path: /System/Applications/FindMy.app
process: FindMy
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '4.0'
- app_id: '83088'
app_name: Font Book
app_store_vendable: ''
bundle_id: com.apple.FontBook
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207549Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207553Z'
path: /System/Applications/Font Book.app
process: Font Book
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83089'
app_name: Freeform
app_store_vendable: ''
bundle_id: com.apple.freeform
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207575Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207580Z'
path: /System/Applications/Freeform.app
process: Freeform
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.2'
- app_id: '83090'
app_name: Grapher
app_store_vendable: ''
bundle_id: com.apple.grapher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207602Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207606Z'
path: /System/Applications/Utilities/Grapher.app
process: Grapher
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.7'
- app_id: '83091'
app_name: Home
app_store_vendable: ''
bundle_id: com.apple.Home
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207629Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207633Z'
path: /System/Applications/Home.app
process: Home
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '7.0'
- app_id: '83092'
app_name: Image Capture
app_store_vendable: ''
bundle_id: com.apple.Image_Capture
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207655Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207659Z'
path: /System/Applications/Image Capture.app
process: Image Capture
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '8.0'
- app_id: '83093'
app_name: Kandji Extension Manager
app_store_vendable: ''
bundle_id: io.kandji.Extension-Manager
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207680Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207684Z'
path: /Applications/Utilities/Kandji Extension Manager.app
process: Kandji Extension Manager
signature: >-
Developer ID Application: Kandji, Inc. (P3FGV63VK7),
Developer ID Certification Authority, Apple Root CA
source: Identified Developer
version: 1.5.4
- app_id: '83094'
app_name: Kandji Self Service
app_store_vendable: ''
bundle_id: io.kandji.Self-Service
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207705Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207709Z'
path: /Applications/Kandji Self Service.app
process: Kandji Self Service
signature: >-
Developer ID Application: Kandji, Inc. (P3FGV63VK7),
Developer ID Certification Authority, Apple Root CA
source: Identified Developer
version: 1.5.12
- app_id: '83095'
app_name: Keychain Access
app_store_vendable: ''
bundle_id: com.apple.keychainaccess
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207731Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207735Z'
path: /System/Applications/Utilities/Keychain Access.app
process: Keychain Access
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83096'
app_name: Launchpad
app_store_vendable: ''
bundle_id: com.apple.launchpad.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207757Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207761Z'
path: /System/Applications/Launchpad.app
process: Launchpad
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83097'
app_name: Mail
app_store_vendable: ''
bundle_id: com.apple.mail
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207782Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207786Z'
path: /System/Applications/Mail.app
process: Mail
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '16.0'
- app_id: '83098'
app_name: Maps
app_store_vendable: ''
bundle_id: com.apple.Maps
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207808Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207812Z'
path: /System/Applications/Maps.app
process: Maps
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.0'
- app_id: '83099'
app_name: Messages
app_store_vendable: ''
bundle_id: com.apple.MobileSMS
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207834Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207838Z'
path: /System/Applications/Messages.app
process: Messages
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '14.0'
- app_id: '83100'
app_name: Migration Assistant
app_store_vendable: ''
bundle_id: com.apple.MigrateAssistant
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207860Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207864Z'
path: /System/Applications/Utilities/Migration Assistant.app
process: Migration Assistant
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '13.4'
- app_id: '83101'
app_name: Mission Control
app_store_vendable: ''
bundle_id: com.apple.exposelauncher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207886Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207890Z'
path: /System/Applications/Mission Control.app
process: Mission Control
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.2'
- app_id: '83102'
app_name: Music
app_store_vendable: ''
bundle_id: com.apple.Music
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207912Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207916Z'
path: /System/Applications/Music.app
process: Music
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 1.3.5
- app_id: '83103'
app_name: News
app_store_vendable: ''
bundle_id: com.apple.news
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207939Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207943Z'
path: /System/Applications/News.app
process: News
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '8.4'
- app_id: '83104'
app_name: Notes
app_store_vendable: ''
bundle_id: com.apple.Notes
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207965Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207969Z'
path: /System/Applications/Notes.app
process: Notes
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '4.10'
- app_id: '83105'
app_name: Okta Verify
app_store_vendable: ''
bundle_id: com.okta.mobile
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207991Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207995Z'
path: /Applications/Okta Verify.app
process: Okta Verify
signature: >-
Apple Mac OS Application Signing, Apple Worldwide
Developer Relations Certification Authority, Apple
Root CA
source: Apple Business Manager
version: 8.1.1
- app_id: '83106'
app_name: Photo Booth
app_store_vendable: ''
bundle_id: com.apple.PhotoBooth
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208034Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208038Z'
path: /System/Applications/Photo Booth.app
process: Photo Booth
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '13.0'
- app_id: '83107'
app_name: Photos
app_store_vendable: ''
bundle_id: com.apple.Photos
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208060Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208064Z'
path: /System/Applications/Photos.app
process: Photos
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '8.0'
- app_id: '83108'
app_name: Podcasts
app_store_vendable: ''
bundle_id: com.apple.podcasts
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208086Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208090Z'
path: /System/Applications/Podcasts.app
process: Podcasts
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 1.1.0
- app_id: '83109'
app_name: Preview
app_store_vendable: ''
bundle_id: com.apple.Preview
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208112Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208116Z'
path: /System/Applications/Preview.app
process: Preview
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83110'
app_name: QuickTime Player
app_store_vendable: ''
bundle_id: com.apple.QuickTimePlayerX
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208138Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208142Z'
path: /System/Applications/QuickTime Player.app
process: QuickTime Player
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.5'
- app_id: '83111'
app_name: Reminders
app_store_vendable: ''
bundle_id: com.apple.reminders
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208174Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208178Z'
path: /System/Applications/Reminders.app
process: Reminders
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '7.0'
- app_id: '83112'
app_name: Safari
app_store_vendable: ''
bundle_id: com.apple.Safari
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208201Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208205Z'
path: >-
/System/Volumes/Preboot/Cryptexes/App/System/Applications/Safari.app
process: Safari
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '16.5'
- app_id: '83113'
app_name: Screenshot
app_store_vendable: ''
bundle_id: com.apple.screenshot.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208227Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208230Z'
path: /System/Applications/Utilities/Screenshot.app
process: Screenshot
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83114'
app_name: Script Editor
app_store_vendable: ''
bundle_id: com.apple.ScriptEditor2
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208252Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208256Z'
path: /System/Applications/Utilities/Script Editor.app
process: Script Editor
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.11'
- app_id: '83115'
app_name: Shortcuts
app_store_vendable: ''
bundle_id: com.apple.shortcuts
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208278Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208282Z'
path: /System/Applications/Shortcuts.app
process: Shortcuts
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '6.0'
- app_id: '83116'
app_name: Siri
app_store_vendable: ''
bundle_id: com.apple.siri.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208314Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208318Z'
path: /System/Applications/Siri.app
process: Siri
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83117'
app_name: Stickies
app_store_vendable: ''
bundle_id: com.apple.Stickies
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208339Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208343Z'
path: /System/Applications/Stickies.app
process: Stickies
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.2'
- app_id: '83118'
app_name: Stocks
app_store_vendable: ''
bundle_id: com.apple.stocks
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208364Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208368Z'
path: /System/Applications/Stocks.app
process: Stocks
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 5.3.1
- app_id: '83119'
app_name: System Information
app_store_vendable: ''
bundle_id: com.apple.SystemProfiler
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208389Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208393Z'
path: /System/Applications/Utilities/System Information.app
process: System Information
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83120'
app_name: System Settings
app_store_vendable: ''
bundle_id: com.apple.systempreferences
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208414Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208418Z'
path: /System/Applications/System Settings.app
process: System Settings
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '15.0'
- app_id: '83121'
app_name: TV
app_store_vendable: ''
bundle_id: com.apple.TV
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208440Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208444Z'
path: /System/Applications/TV.app
process: TV
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 1.3.5
- app_id: '83122'
app_name: Terminal
app_store_vendable: ''
bundle_id: com.apple.Terminal
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208466Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208470Z'
path: /System/Applications/Utilities/Terminal.app
process: Terminal
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.13'
- app_id: '83123'
app_name: TextEdit
app_store_vendable: ''
bundle_id: com.apple.TextEdit
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208492Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208496Z'
path: /System/Applications/TextEdit.app
process: TextEdit
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.18'
- app_id: '83124'
app_name: Time Machine
app_store_vendable: ''
bundle_id: com.apple.backup.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208518Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208522Z'
path: /System/Applications/Time Machine.app
process: Time Machine
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.3'
- app_id: '83125'
app_name: VoiceMemos
app_store_vendable: ''
bundle_id: com.apple.VoiceMemos
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208545Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208548Z'
path: /System/Applications/VoiceMemos.app
process: VoiceMemos
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.3'
- app_id: '83126'
app_name: VoiceOver Utility
app_store_vendable: ''
bundle_id: com.apple.VoiceOverUtility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208571Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208575Z'
path: /System/Applications/Utilities/VoiceOver Utility.app
process: VoiceOver Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10'
- app_id: '83127'
app_name: Weather
app_store_vendable: ''
bundle_id: com.apple.weather
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208596Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208600Z'
path: /System/Applications/Weather.app
process: Weather
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 3.3.1
device_id:
type: string
example: bd4eb679-d679-4071-a395-5855807b6829
examples:
Mac apps:
value:
apps:
- app_id: '83068'
app_name: Activity Monitor
app_store_vendable: ''
bundle_id: com.apple.ActivityMonitor
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206870Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206888Z'
path: /System/Applications/Utilities/Activity Monitor.app
process: Activity Monitor
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.14'
- app_id: '83069'
app_name: AirPort Utility
app_store_vendable: ''
bundle_id: com.apple.airport.airportutility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206937Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206941Z'
path: /System/Applications/Utilities/AirPort Utility.app
process: AirPort Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 6.3.9
- app_id: '83070'
app_name: App Store
app_store_vendable: ''
bundle_id: com.apple.AppStore
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206966Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206969Z'
path: /System/Applications/App Store.app
process: App Store
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.0'
- app_id: '83071'
app_name: Audio MIDI Setup
app_store_vendable: ''
bundle_id: com.apple.audio.AudioMIDISetup
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.206991Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.206995Z'
path: /System/Applications/Utilities/Audio MIDI Setup.app
process: Audio MIDI Setup
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.5'
- app_id: '83072'
app_name: Automator
app_store_vendable: ''
bundle_id: com.apple.Automator
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207017Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207021Z'
path: /System/Applications/Automator.app
process: Automator
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.10'
- app_id: '83073'
app_name: Bluetooth File Exchange
app_store_vendable: ''
bundle_id: com.apple.BluetoothFileExchange
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207043Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207047Z'
path: >-
/System/Applications/Utilities/Bluetooth File
Exchange.app
process: Bluetooth File Exchange
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '9.0'
- app_id: '83074'
app_name: Books
app_store_vendable: ''
bundle_id: com.apple.iBooksX
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207070Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207073Z'
path: /System/Applications/Books.app
process: Books
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '5.2'
- app_id: '83075'
app_name: Boot Camp Assistant
app_store_vendable: ''
bundle_id: com.apple.bootcampassistant
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207095Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207099Z'
path: /System/Applications/Utilities/Boot Camp Assistant.app
process: Boot Camp Assistant
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 6.1.0
- app_id: '83076'
app_name: Calculator
app_store_vendable: ''
bundle_id: com.apple.calculator
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207120Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207124Z'
path: /System/Applications/Calculator.app
process: Calculator
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.16'
- app_id: '83077'
app_name: Calendar
app_store_vendable: ''
bundle_id: com.apple.iCal
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207150Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207156Z'
path: /System/Applications/Calendar.app
process: Calendar
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '13.0'
- app_id: '83078'
app_name: Chess
app_store_vendable: ''
bundle_id: com.apple.Chess
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207191Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207197Z'
path: /System/Applications/Chess.app
process: Chess
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.18'
- app_id: '83079'
app_name: Clock
app_store_vendable: ''
bundle_id: com.apple.clock
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207235Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207240Z'
path: /System/Applications/Clock.app
process: Clock
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83080'
app_name: ColorSync Utility
app_store_vendable: ''
bundle_id: com.apple.ColorSyncUtility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207276Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207282Z'
path: /System/Applications/Utilities/ColorSync Utility.app
process: ColorSync Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 12.0.0
- app_id: '83081'
app_name: Console
app_store_vendable: ''
bundle_id: com.apple.Console
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207323Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207329Z'
path: /System/Applications/Utilities/Console.app
process: Console
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.1'
- app_id: '83082'
app_name: Contacts
app_store_vendable: ''
bundle_id: com.apple.AddressBook
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207363Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207370Z'
path: /System/Applications/Contacts.app
process: Contacts
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: No value
- app_id: '83083'
app_name: Dictionary
app_store_vendable: ''
bundle_id: com.apple.Dictionary
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207407Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207415Z'
path: /System/Applications/Dictionary.app
process: Dictionary
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 2.3.0
- app_id: '83084'
app_name: Digital Color Meter
app_store_vendable: ''
bundle_id: com.apple.DigitalColorMeter
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207442Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207446Z'
path: /System/Applications/Utilities/Digital Color Meter.app
process: Digital Color Meter
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '5.22'
- app_id: '83085'
app_name: Disk Utility
app_store_vendable: ''
bundle_id: com.apple.DiskUtility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207468Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207472Z'
path: /System/Applications/Utilities/Disk Utility.app
process: Disk Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '22.6'
- app_id: '83086'
app_name: FaceTime
app_store_vendable: ''
bundle_id: com.apple.FaceTime
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207495Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207499Z'
path: /System/Applications/FaceTime.app
process: FaceTime
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '5.0'
- app_id: '83087'
app_name: FindMy
app_store_vendable: ''
bundle_id: com.apple.findmy
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207522Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207526Z'
path: /System/Applications/FindMy.app
process: FindMy
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '4.0'
- app_id: '83088'
app_name: Font Book
app_store_vendable: ''
bundle_id: com.apple.FontBook
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207549Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207553Z'
path: /System/Applications/Font Book.app
process: Font Book
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83089'
app_name: Freeform
app_store_vendable: ''
bundle_id: com.apple.freeform
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207575Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207580Z'
path: /System/Applications/Freeform.app
process: Freeform
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.2'
- app_id: '83090'
app_name: Grapher
app_store_vendable: ''
bundle_id: com.apple.grapher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207602Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207606Z'
path: /System/Applications/Utilities/Grapher.app
process: Grapher
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.7'
- app_id: '83091'
app_name: Home
app_store_vendable: ''
bundle_id: com.apple.Home
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207629Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207633Z'
path: /System/Applications/Home.app
process: Home
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '7.0'
- app_id: '83092'
app_name: Image Capture
app_store_vendable: ''
bundle_id: com.apple.Image_Capture
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207655Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207659Z'
path: /System/Applications/Image Capture.app
process: Image Capture
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '8.0'
- app_id: '83093'
app_name: Kandji Extension Manager
app_store_vendable: ''
bundle_id: io.kandji.Extension-Manager
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207680Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207684Z'
path: /Applications/Utilities/Kandji Extension Manager.app
process: Kandji Extension Manager
signature: >-
Developer ID Application: Kandji, Inc. (P3FGV63VK7),
Developer ID Certification Authority, Apple Root CA
source: Identified Developer
version: 1.5.4
- app_id: '83094'
app_name: Kandji Self Service
app_store_vendable: ''
bundle_id: io.kandji.Self-Service
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207705Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207709Z'
path: /Applications/Kandji Self Service.app
process: Kandji Self Service
signature: >-
Developer ID Application: Kandji, Inc. (P3FGV63VK7),
Developer ID Certification Authority, Apple Root CA
source: Identified Developer
version: 1.5.12
- app_id: '83095'
app_name: Keychain Access
app_store_vendable: ''
bundle_id: com.apple.keychainaccess
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207731Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207735Z'
path: /System/Applications/Utilities/Keychain Access.app
process: Keychain Access
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83096'
app_name: Launchpad
app_store_vendable: ''
bundle_id: com.apple.launchpad.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207757Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207761Z'
path: /System/Applications/Launchpad.app
process: Launchpad
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83097'
app_name: Mail
app_store_vendable: ''
bundle_id: com.apple.mail
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207782Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207786Z'
path: /System/Applications/Mail.app
process: Mail
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '16.0'
- app_id: '83098'
app_name: Maps
app_store_vendable: ''
bundle_id: com.apple.Maps
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207808Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207812Z'
path: /System/Applications/Maps.app
process: Maps
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '3.0'
- app_id: '83099'
app_name: Messages
app_store_vendable: ''
bundle_id: com.apple.MobileSMS
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207834Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207838Z'
path: /System/Applications/Messages.app
process: Messages
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '14.0'
- app_id: '83100'
app_name: Migration Assistant
app_store_vendable: ''
bundle_id: com.apple.MigrateAssistant
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207860Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207864Z'
path: /System/Applications/Utilities/Migration Assistant.app
process: Migration Assistant
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '13.4'
- app_id: '83101'
app_name: Mission Control
app_store_vendable: ''
bundle_id: com.apple.exposelauncher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207886Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207890Z'
path: /System/Applications/Mission Control.app
process: Mission Control
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.2'
- app_id: '83102'
app_name: Music
app_store_vendable: ''
bundle_id: com.apple.Music
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207912Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207916Z'
path: /System/Applications/Music.app
process: Music
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 1.3.5
- app_id: '83103'
app_name: News
app_store_vendable: ''
bundle_id: com.apple.news
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207939Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207943Z'
path: /System/Applications/News.app
process: News
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '8.4'
- app_id: '83104'
app_name: Notes
app_store_vendable: ''
bundle_id: com.apple.Notes
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207965Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207969Z'
path: /System/Applications/Notes.app
process: Notes
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '4.10'
- app_id: '83105'
app_name: Okta Verify
app_store_vendable: ''
bundle_id: com.okta.mobile
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.207991Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.207995Z'
path: /Applications/Okta Verify.app
process: Okta Verify
signature: >-
Apple Mac OS Application Signing, Apple Worldwide
Developer Relations Certification Authority, Apple
Root CA
source: Apple Business Manager
version: 8.1.1
- app_id: '83106'
app_name: Photo Booth
app_store_vendable: ''
bundle_id: com.apple.PhotoBooth
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208034Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208038Z'
path: /System/Applications/Photo Booth.app
process: Photo Booth
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '13.0'
- app_id: '83107'
app_name: Photos
app_store_vendable: ''
bundle_id: com.apple.Photos
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208060Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208064Z'
path: /System/Applications/Photos.app
process: Photos
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '8.0'
- app_id: '83108'
app_name: Podcasts
app_store_vendable: ''
bundle_id: com.apple.podcasts
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208086Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208090Z'
path: /System/Applications/Podcasts.app
process: Podcasts
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 1.1.0
- app_id: '83109'
app_name: Preview
app_store_vendable: ''
bundle_id: com.apple.Preview
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208112Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208116Z'
path: /System/Applications/Preview.app
process: Preview
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83110'
app_name: QuickTime Player
app_store_vendable: ''
bundle_id: com.apple.QuickTimePlayerX
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208138Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208142Z'
path: /System/Applications/QuickTime Player.app
process: QuickTime Player
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.5'
- app_id: '83111'
app_name: Reminders
app_store_vendable: ''
bundle_id: com.apple.reminders
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208174Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208178Z'
path: /System/Applications/Reminders.app
process: Reminders
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '7.0'
- app_id: '83112'
app_name: Safari
app_store_vendable: ''
bundle_id: com.apple.Safari
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208201Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208205Z'
path: >-
/System/Volumes/Preboot/Cryptexes/App/System/Applications/Safari.app
process: Safari
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '16.5'
- app_id: '83113'
app_name: Screenshot
app_store_vendable: ''
bundle_id: com.apple.screenshot.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208227Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208230Z'
path: /System/Applications/Utilities/Screenshot.app
process: Screenshot
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83114'
app_name: Script Editor
app_store_vendable: ''
bundle_id: com.apple.ScriptEditor2
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208252Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208256Z'
path: /System/Applications/Utilities/Script Editor.app
process: Script Editor
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.11'
- app_id: '83115'
app_name: Shortcuts
app_store_vendable: ''
bundle_id: com.apple.shortcuts
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208278Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208282Z'
path: /System/Applications/Shortcuts.app
process: Shortcuts
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '6.0'
- app_id: '83116'
app_name: Siri
app_store_vendable: ''
bundle_id: com.apple.siri.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208314Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208318Z'
path: /System/Applications/Siri.app
process: Siri
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.0'
- app_id: '83117'
app_name: Stickies
app_store_vendable: ''
bundle_id: com.apple.Stickies
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208339Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208343Z'
path: /System/Applications/Stickies.app
process: Stickies
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10.2'
- app_id: '83118'
app_name: Stocks
app_store_vendable: ''
bundle_id: com.apple.stocks
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208364Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208368Z'
path: /System/Applications/Stocks.app
process: Stocks
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 5.3.1
- app_id: '83119'
app_name: System Information
app_store_vendable: ''
bundle_id: com.apple.SystemProfiler
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208389Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208393Z'
path: /System/Applications/Utilities/System Information.app
process: System Information
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '11.0'
- app_id: '83120'
app_name: System Settings
app_store_vendable: ''
bundle_id: com.apple.systempreferences
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208414Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208418Z'
path: /System/Applications/System Settings.app
process: System Settings
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '15.0'
- app_id: '83121'
app_name: TV
app_store_vendable: ''
bundle_id: com.apple.TV
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208440Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208444Z'
path: /System/Applications/TV.app
process: TV
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 1.3.5
- app_id: '83122'
app_name: Terminal
app_store_vendable: ''
bundle_id: com.apple.Terminal
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208466Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208470Z'
path: /System/Applications/Utilities/Terminal.app
process: Terminal
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.13'
- app_id: '83123'
app_name: TextEdit
app_store_vendable: ''
bundle_id: com.apple.TextEdit
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208492Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208496Z'
path: /System/Applications/TextEdit.app
process: TextEdit
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.18'
- app_id: '83124'
app_name: Time Machine
app_store_vendable: ''
bundle_id: com.apple.backup.launcher
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208518Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208522Z'
path: /System/Applications/Time Machine.app
process: Time Machine
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '1.3'
- app_id: '83125'
app_name: VoiceMemos
app_store_vendable: ''
bundle_id: com.apple.VoiceMemos
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208545Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208548Z'
path: /System/Applications/VoiceMemos.app
process: VoiceMemos
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '2.3'
- app_id: '83126'
app_name: VoiceOver Utility
app_store_vendable: ''
bundle_id: com.apple.VoiceOverUtility
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208571Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208575Z'
path: /System/Applications/Utilities/VoiceOver Utility.app
process: VoiceOver Utility
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: '10'
- app_id: '83127'
app_name: Weather
app_store_vendable: ''
bundle_id: com.apple.weather
bundle_size: '1'
creation_date: '2023-06-06T19:43:15.208596Z'
device_based_vpp: ''
modification_date: '2023-06-06T19:43:15.208600Z'
path: /System/Applications/Weather.app
process: Weather
signature: >-
Software Signing, Apple Code Signing Certification
Authority, Apple Root CA
source: Apple
version: 3.3.1
device_id: bd4eb679-d679-4071-a395-5855807b6829
iPad apps:
value:
apps:
- app_id: f7333eb1-421e-4088-8690-a358169c0421
app_name: Okta Verify
app_store_vendable: 'False'
bundle_id: com.okta.mobile
bundle_size: '68390912'
creation_date: ''
device_based_vpp: 'True'
modification_date: ''
path: ''
process: ''
signature: ''
source: ''
version: '47'
device_id: 4820db3b-dec7-40b2-9c8f-eb771ac1a250
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/library-items:
get:
tags:
- Device Information
summary: Get Device Library Items
description: >-
This request gets all library items and their statuses for a specified
Device ID
#### Possible library item status values
| **Value** | **Type** | **Additional Info** |
| --- | --- | --- |
| AVAILABLE | string | Library item available in Self Service |
| CACHED | string | Library item downloaded for install but not yet
installed |
| CHANGE_PENDING | string | Recovery Password library item has changes
that have not yet been applied |
| DOWNLOADING | string | Library item downloading |
| ERROR | string | Audit failure |
| EXCLUDED | string | Not in scope for assignment rule |
| INCOMPATIBLE | string | Not compatible with device or OS version |
| INSTALLING | string | Library item installing |
| PASS | string | Device meets requirements |
| PENDING| string | Waiting on device, not yet installed (All library
items except for config profiles) |
| failed | string | Configuration profile failed to install |
| pending | string | Waiting on device, Configuration profile not yet
installed |
| success | string | Configuration profile installed |
operationId: getDeviceLibraryItems
responses:
'200':
description: success / edr status
headers:
Allow:
schema:
type: string
example: GET, HEAD, OPTIONS
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '3308'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; frame-ancestors 'none'; form-action 'none';
default-src 'none'
Date:
schema:
type: string
example: Fri, 14 May 2021 00:41:26 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
device_id:
type: string
example: bd4eb679-d679-4071-a395-5855807b6829
library_items:
type: array
items:
type: object
properties:
blueprint:
type: object
properties:
id:
type: string
example: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name:
type: string
example: _testing_apple_silicon
computer:
type: object
properties:
id:
type: string
example: bd4eb679-d679-4071-a395-5855807b6829
name:
type: string
example: testuser’s MacBook Air
control_log:
nullable: true
example: null
control_reported_at:
nullable: true
example: null
id:
type: number
example: 102029
item_id:
type: string
example: 109df9e8-3917-4fe9-8a36-51fa35e36f8a
last_audit_log:
type: string
nullable: true
example: null
last_audit_run:
type: string
nullable: true
example: null
log:
type: string
nullable: true
example: null
name:
type: string
example: 00_rosetta_2
reported_at:
nullable: true
example: null
rules_present:
type: boolean
example: false
status:
type: string
example: PENDING
type:
type: string
example: custom-script
example:
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102029
item_id: 109df9e8-3917-4fe9-8a36-51fa35e36f8a
last_audit_log: null
last_audit_run: null
log: null
name: 00_rosetta_2
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102036
item_id: 1412480d-f377-4fb1-8bda-98461ae1bc52
last_audit_log: null
last_audit_run: null
log: null
name: zzz_add-self-service-to-dock
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102031
item_id: 2c3cddcc-b8dd-4f0b-bf00-0d6afa7af155
last_audit_log: null
last_audit_run: null
log: null
name: enforce_min_app_version
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102034
item_id: 523b4f58-f317-49b4-a226-2ec781e61eea
last_audit_log: null
last_audit_run: null
log: null
name: debug-audit
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102032
item_id: 73c1bf7c-a128-4ba2-899a-ffe1ff516abb
last_audit_log: null
last_audit_run: null
log: null
name: macOS 13 Ventura
reported_at: null
rules_present: false
status: PENDING
type: macos-release
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102026
item_id: 76b99c23-b890-4f43-b218-efaad623e2e6
last_audit_log: null
last_audit_run: null
log: null
name: audit_atom
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102035
item_id: 88055f85-d191-422d-b968-64aa2d631b86
last_audit_log: null
last_audit_run: null
log: null
name: homebrew-uninstall
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102028
item_id: 9a3fc3e0-f6bd-4a59-bbad-a9c0f5f48121
last_audit_log: null
last_audit_run: null
log: null
name: homebrew
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102027
item_id: 9f7345f7-a5b1-442a-882b-82889527d1df
last_audit_log: null
last_audit_run: null
log: null
name: Liftoff Test
reported_at: null
rules_present: false
status: PENDING
type: kandji-setup
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102022
item_id: df1244ff-e6fd-4cd0-8705-f6e0c6917d98
last_audit_log: The profile installation has been initiated.
last_audit_run: '2023-06-07T05:47:40.015381Z'
log: ''
name: terminal_access_aa_pppc
reported_at: null
rules_present: false
status: pending
type: profile
examples:
edr status:
value:
device_id: bd4eb679-d679-4071-a395-5855807b6829
library_items:
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 912bc505-a7ee-4d0b-906d-2102f332a4b3
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
edr_status:
baseline_scan_runtime: >-
Kandji checked 339,254 files in 3 minutes, 41
seconds.
last_baseline_scan: Feb 27, 2024 at 7:34:21 AM
malware_posture: Protect
next_baseline_scan: Mar 26, 2024 at 5:48:10 AM
pup_posture: Protect
status: enabled
id: 14603
item_id: f16e7f13-ba73-4c30-9640-a31b2758bcbe
last_audit_log: null
last_audit_run: null
log: null
name: Avert
reported_at: null
rules_present: false
status: PENDING
type: threat-security-policy
success:
value:
device_id: bd4eb679-d679-4071-a395-5855807b6829
library_items:
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102029
item_id: 109df9e8-3917-4fe9-8a36-51fa35e36f8a
last_audit_log: null
last_audit_run: null
log: null
name: 00_rosetta_2
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102036
item_id: 1412480d-f377-4fb1-8bda-98461ae1bc52
last_audit_log: null
last_audit_run: null
log: null
name: zzz_add-self-service-to-dock
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102031
item_id: 2c3cddcc-b8dd-4f0b-bf00-0d6afa7af155
last_audit_log: null
last_audit_run: null
log: null
name: enforce_min_app_version
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102034
item_id: 523b4f58-f317-49b4-a226-2ec781e61eea
last_audit_log: null
last_audit_run: null
log: null
name: debug-audit
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102032
item_id: 73c1bf7c-a128-4ba2-899a-ffe1ff516abb
last_audit_log: null
last_audit_run: null
log: null
name: macOS 13 Ventura
reported_at: null
rules_present: false
status: PENDING
type: macos-release
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102026
item_id: 76b99c23-b890-4f43-b218-efaad623e2e6
last_audit_log: null
last_audit_run: null
log: null
name: audit_atom
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102035
item_id: 88055f85-d191-422d-b968-64aa2d631b86
last_audit_log: null
last_audit_run: null
log: null
name: homebrew-uninstall
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102028
item_id: 9a3fc3e0-f6bd-4a59-bbad-a9c0f5f48121
last_audit_log: null
last_audit_run: null
log: null
name: homebrew
reported_at: null
rules_present: false
status: PENDING
type: custom-script
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102027
item_id: 9f7345f7-a5b1-442a-882b-82889527d1df
last_audit_log: null
last_audit_run: null
log: null
name: Liftoff Test
reported_at: null
rules_present: false
status: PENDING
type: kandji-setup
- blueprint:
id: 97e4e175-1631-43f6-a02b-33fd1c748ab8
name: _testing_apple_silicon
computer:
id: bd4eb679-d679-4071-a395-5855807b6829
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 102022
item_id: df1244ff-e6fd-4cd0-8705-f6e0c6917d98
last_audit_log: The profile installation has been initiated.
last_audit_run: '2023-06-07T05:47:40.015381Z'
log: ''
name: terminal_access_aa_pppc
reported_at: null
rules_present: false
status: pending
type: profile
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/parameters:
get:
tags:
- Device Information
summary: Get Device Parameters
description: >-
This request returns the parameters and their statuses for a specified
Device ID
This endpoint is only applicable to macOS clients.
The parameters will be returned as a list of IDs. These IDs can be
correlated with the parameter names available here:
[https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations](https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations)
**Possible parameter status values**
| **Value** | **Type** | **Additional Info** |
| --- | --- | --- |
| ERROR | string | Audit failure |
| INCOMPATIBLE | string | Not compatible with device or OS version |
| PASS | string | Device meets requirements |
| PENDING | string | Waiting on device. Not yet run. |
| REMEDIATED | string | Parameter remediated |
| WARNING | string | Muted alert |
operationId: getDeviceParameters
responses:
'200':
description: Get Device Parameters
headers:
Allow:
schema:
type: string
example: GET, HEAD, OPTIONS
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '243'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; frame-ancestors 'none'; form-action 'none';
default-src 'none'
Date:
schema:
type: string
example: Fri, 14 May 2021 00:41:05 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
device_id:
type: string
example: 77883d40-5656-4a24-9d70-49b6e751a923
parameters:
type: array
items:
type: object
properties:
category:
type: string
example: User Accounts & Authentication
item_id:
type: string
example: 1e4be748-e072-4c1f-b1ff-a98f076b8e8e
name:
type: string
example: Disable the "root" user
status:
type: string
example: PASS
subcategory:
type: string
example: User Accounts
example:
- category: User Accounts & Authentication
item_id: 1e4be748-e072-4c1f-b1ff-a98f076b8e8e
name: Disable the "root" user
status: PASS
subcategory: User Accounts
examples:
Get Device Parameters:
value:
device_id: 77883d40-5656-4a24-9d70-49b6e751a923
parameters:
- category: User Accounts & Authentication
item_id: 1e4be748-e072-4c1f-b1ff-a98f076b8e8e
name: Disable the "root" user
status: PASS
subcategory: User Accounts
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/status:
get:
tags:
- Device Information
summary: Get Device Status
description: >-
This request returns the full status (parameters and library items) for
a specified Device ID.
The parameters will be returned as a list of IDs. These IDs can be
correlated with the parameter names available here:
[https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations](https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations)
#### Possible status values
**Library items**
| **Value** | **Type** | **Additional Info** |
| --- | --- | --- |
| AVAILABLE | string | Library item available in Self Service |
| ERROR | string | Audit failure |
| EXCLUDED | string | Not in scope for assignment rule |
| INCOMPATIBLE | string | Not compatible with device or OS version |
| PASS | string | Device meets requirements |
| PENDING| string | Waiting on device, not yet installed (All library
items except for config profiles) |
| failed | string | Configuration profile failed to install |
| pending | string | Waiting on device, Configuration profile not yet
installed |
| success | string | Configuration profile installed |
**Parameters**
| **Value** | **Type** | **Additional Info** |
| --- | --- | --- |
| ERROR | string | Audit failure |
| INCOMPATIBLE | string | Not compatible with device or OS version |
| PASS | string | Device meets requirements |
| PENDING | string | Waiting on device. Not yet run. |
| REMEDIATED | string | Parameter remediated |
| WARNING | string | Muted alert |
operationId: getDeviceStatus
responses:
'200':
description: Get Device Status
headers:
Allow:
schema:
type: string
example: GET, HEAD, OPTIONS
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '3499'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; frame-ancestors 'none'; form-action 'none';
default-src 'none'
Date:
schema:
type: string
example: Fri, 14 May 2021 00:45:32 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
device_id:
type: string
example: 77883d40-5656-4a24-9d70-49b6e751a923
library_items:
type: array
items:
type: object
properties:
id:
type: number
example: 1222
item_id:
type: string
example: 4a98cb3d-3b55-46bf-829d-7dd7bd6ed832
last_audit_log:
type: string
nullable: true
example: |-
Executing audit script...
Script exited with non-zero status.
log:
type: string
example: |-
Executing audit script...
Script exited with non-zero status.
Downloading zoom
Completed download in four minutes, fifty seconds.
Installing zoom
Completed package installation in four seconds.
name:
type: string
example: zoom
reported_at:
type: string
example: '2021-05-11T19:45:19Z'
status:
type: string
example: PASS
type:
type: string
example: custom-app
example:
- id: 1222
item_id: 4a98cb3d-3b55-46bf-829d-7dd7bd6ed832
last_audit_log: |-
Executing audit script...
Script exited with non-zero status.
log: |-
Executing audit script...
Script exited with non-zero status.
Downloading zoom
Completed download in four minutes, fifty seconds.
Installing zoom
Completed package installation in four seconds.
name: zoom
reported_at: '2021-05-11T19:45:19Z'
status: PASS
type: custom-app
- id: 1218
item_id: b81b0ed6-c703-45a0-8d49-8255ff21d413
last_audit_log: >-
Kandji is set to automatically enforce updates for
Microsoft Edge two weeks after they are released.
Microsoft Edge 90.0.818.56 is installed, which is
newer than the version being enforced.
log: >-
Downloading Microsoft Edge
Completed download in six seconds.
Installing Microsoft Edge
Completed package installation in twenty-three
seconds.
Added icon to end of Dock for all users.
name: Microsoft Edge
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1224
item_id: 59be1e8e-5ba5-4bbc-bead-8b3e2006c3e5
last_audit_log: null
log: |-
Executing Custom Script...
Exit code: 0
name: Custom Script
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: custom-script
- id: 1220
item_id: e517e593-5d9b-4492-abc1-64247f242f21
last_audit_log: >-
Brave 81.1.8.95 is installed and up to date.
Kandji is set to enforce a minimum version (81.1.8.95)
of Brave.
log: |-
Downloading Brave
Completed download in three seconds.
Installing Brave
Completed package installation in eight seconds.
name: Brave
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1219
item_id: ba02261d-e482-4e4f-b0ce-c108ba7b35a4
last_audit_log: >-
Firefox 82.0.2 is installed and up to date.
Kandji is set to enforce a minimum version (82.0.2) of
Firefox.
log: |-
Downloading Firefox
Completed download in three seconds.
Installing Firefox
Completed package installation in seven seconds.
name: Firefox
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1221
item_id: 62189209-7f84-4132-a4f7-89a12cb5a9c3
last_audit_log: >-
Atom 1.53.0 is installed and up to date.
Kandji is set to enforce a minimum version (1.46.0) of
Atom.
log: >-
Downloading Atom
Completed download in six seconds.
Installing Atom
Completed package installation in one minute, one
second.
Added icon to end of Dock for all users.
name: Atom
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1225
item_id: ae55bb5f-d1fc-4bab-a2ca-d4f34c703b5f
last_audit_log: >-
Notion 2.0.7 is installed and up to date.
Kandji is set to enforce a minimum version (2.0.7) of
Notion.
log: |-
Downloading Notion
Completed download in four seconds.
Installing Notion
Completed package installation in ten seconds.
name: Notion
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1223
item_id: 73be2f87-6ea8-4db9-8e42-af8a4dfec36f
last_audit_log: null
log: |-
Downloading Chrome
Completed download in two seconds.
Installing Chrome
Completed package installation in twenty-four seconds.
name: Chrome
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: custom-app
parameters:
type: array
items:
type: object
properties:
category:
type: string
example: User Accounts & Authentication
item_id:
type: string
example: 1e4be748-e072-4c1f-b1ff-a98f076b8e8e
name:
type: string
example: Disable the "root" user
status:
type: string
example: PASS
subcategory:
type: string
example: User Accounts
example:
- category: User Accounts & Authentication
item_id: 1e4be748-e072-4c1f-b1ff-a98f076b8e8e
name: Disable the "root" user
status: PASS
subcategory: User Accounts
examples:
Get Device Status:
value:
device_id: 77883d40-5656-4a24-9d70-49b6e751a923
library_items:
- id: 1222
item_id: 4a98cb3d-3b55-46bf-829d-7dd7bd6ed832
last_audit_log: |-
Executing audit script...
Script exited with non-zero status.
log: |-
Executing audit script...
Script exited with non-zero status.
Downloading zoom
Completed download in four minutes, fifty seconds.
Installing zoom
Completed package installation in four seconds.
name: zoom
reported_at: '2021-05-11T19:45:19Z'
status: PASS
type: custom-app
- id: 1218
item_id: b81b0ed6-c703-45a0-8d49-8255ff21d413
last_audit_log: >-
Kandji is set to automatically enforce updates for
Microsoft Edge two weeks after they are released.
Microsoft Edge 90.0.818.56 is installed, which is
newer than the version being enforced.
log: >-
Downloading Microsoft Edge
Completed download in six seconds.
Installing Microsoft Edge
Completed package installation in twenty-three
seconds.
Added icon to end of Dock for all users.
name: Microsoft Edge
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1224
item_id: 59be1e8e-5ba5-4bbc-bead-8b3e2006c3e5
last_audit_log: null
log: |-
Executing Custom Script...
Exit code: 0
name: Custom Script
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: custom-script
- id: 1220
item_id: e517e593-5d9b-4492-abc1-64247f242f21
last_audit_log: >-
Brave 81.1.8.95 is installed and up to date.
Kandji is set to enforce a minimum version (81.1.8.95)
of Brave.
log: |-
Downloading Brave
Completed download in three seconds.
Installing Brave
Completed package installation in eight seconds.
name: Brave
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1219
item_id: ba02261d-e482-4e4f-b0ce-c108ba7b35a4
last_audit_log: >-
Firefox 82.0.2 is installed and up to date.
Kandji is set to enforce a minimum version (82.0.2) of
Firefox.
log: |-
Downloading Firefox
Completed download in three seconds.
Installing Firefox
Completed package installation in seven seconds.
name: Firefox
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1221
item_id: 62189209-7f84-4132-a4f7-89a12cb5a9c3
last_audit_log: >-
Atom 1.53.0 is installed and up to date.
Kandji is set to enforce a minimum version (1.46.0) of
Atom.
log: >-
Downloading Atom
Completed download in six seconds.
Installing Atom
Completed package installation in one minute, one
second.
Added icon to end of Dock for all users.
name: Atom
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1225
item_id: ae55bb5f-d1fc-4bab-a2ca-d4f34c703b5f
last_audit_log: >-
Notion 2.0.7 is installed and up to date.
Kandji is set to enforce a minimum version (2.0.7) of
Notion.
log: |-
Downloading Notion
Completed download in four seconds.
Installing Notion
Completed package installation in ten seconds.
name: Notion
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: automatic-app
- id: 1223
item_id: 73be2f87-6ea8-4db9-8e42-af8a4dfec36f
last_audit_log: null
log: |-
Downloading Chrome
Completed download in two seconds.
Installing Chrome
Completed package installation in twenty-four seconds.
name: Chrome
reported_at: '2021-05-10T17:20:55Z'
status: PASS
type: custom-app
parameters:
- category: User Accounts & Authentication
item_id: 1e4be748-e072-4c1f-b1ff-a98f076b8e8e
name: Disable the "root" user
status: PASS
subcategory: User Accounts
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/enablelostmode:
post:
tags:
- Device Actions
- Lost Mode
summary: Enable Lost Mode
description: >-
This endpoint sends an MDM command to remotely turn on lost mode on iOS
and iPadOS.
Optionally, a JSON payload can be sent in the request to set a lock
message, phone number, and footnote on the target device.
operationId: enableLostMode
requestBody:
content:
application/json:
schema:
type: object
properties:
Footnote:
type: string
example: This is an example footnote.
Message:
type: string
example: Hey i just did this from the enable lost mode API
PhoneNumber:
type: string
example: '1234567890'
examples:
Enable Lost Mode:
value:
Footnote: This is an example footnote.
Message: Hey i just did this from the enable lost mode API
PhoneNumber: '1234567890'
responses:
'200':
description: Enable Lost Mode
content:
text/plain:
examples:
Enable Lost Mode:
value: No body returned for response
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/disablelostmode:
post:
tags:
- Device Actions
- Lost Mode
summary: Disable Lost Mode
description: >-
This command will send a request to turn off lost mode on iOS and
iPadOS.
If the command is already pending, the message "_Disable lost mode is
already pending for this device._" will be in the response.
operationId: disableLostMode
responses:
'200':
description: Disable Lost Mode
content:
text/plain:
examples:
Disable Lost Mode:
value: No body returned for response
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/playlostmodesound:
post:
tags:
- Device Actions
- Lost Mode
summary: Play Lost Mode Sound
description: >-
This command will tell the target iOS or iPadOS device to play the lost
mode sound.
**Note**: The Lost Mode sound will play for 2 minutes, even if the
device is in silent mode. Anyone finding the device can silence the
sound by pressing any of its side buttons.
operationId: playLostModeSound
responses:
'200':
description: Play Lost Mode Sound
content:
text/plain:
examples:
Play Lost Mode Sound:
value: No body returned for response
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/updatelocation:
post:
tags:
- Device Actions
- Lost Mode
summary: Update Location
description: >-
This endpoint sends an MDM command to update the location data on iOS
and iPadOS.
operationId: updateLocation
responses:
'200':
description: Update Location
content:
text/plain:
examples:
Update Location:
value: No body returned for response
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/clearpasscode:
post:
tags:
- Device Actions
summary: Clear Passcode
description: >-
This endpoint sends an MDM command to clear a device passcode. Available
for iPhone and iPad.
operationId: clearPasscode
responses:
'200':
description: Clear Passcode
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; default-src 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 17:07:16 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/deleteuser:
post:
tags:
- Device Actions
summary: Delete User
description: >-
This endpoint sends an MDM command to delete a local user account on
macOS and Shared iPad (Device Supervision via Automated Device
Enrollment is required).
**Request Body Parameters**: application/json
* * *
`DeleteAllUsers` - `boolean`
`ForceDeletion` - `boolean`
`UserName` - `string`
operationId: deleteUser
requestBody:
content:
application/json:
schema:
type: object
properties:
DeleteAllUsers:
type: boolean
example: false
ForceDeletion:
type: boolean
example: false
UserName:
type: string
example: testuser
examples:
Delete User:
value:
DeleteAllUsers: false
ForceDeletion: false
UserName: testuser
responses:
'200':
description: Delete User
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/erase:
post:
tags:
- Device Actions
summary: Erase Device
description: >-
This endpoint sends an MDM command to erase the device.
iOS 4.0+, iPadOS 4.0+, macOS 10.7+, tvOS 10.2+
**Request Body Parameters: application/json**
| Key | Type | Description |
| --- | --- | --- |
| `PIN` | `string` | The six-character PIN for Find My. This value is
available in macOS 10.8 and later. |
| `PreserveDataPlan` | `boolean` | If true, preserve the data plan on an
iPhone or iPad with eSIM functionality, if one exists. This value is
available in iOS 11 and later.
Default: true |
| `DisallowProximitySetup` | `boolean` | If true, disable Proximity
Setup on the next reboot and skip the pane in Setup Assistant. This
value is available in iOS 11 and later. Prior to iOS 14, don’t use this
option with any other option.
Default: false |
| `ReturnToService` | `object` | (iOS 17 and later and iPadOS 17 and
later and with Shared iPad ) When sending the erase device command to
mobile devices, use this key to enable Return to Service. Include an
optional Wi-Fi payload ProfileId to allow the device to connect to a
Wi-Fi network automatically after being erased. If a Wi-Fi ProfileId is
not provided and the mobile device is not tethered to a Mac to share the
network connection, the end-user will be required to select a Wi-Fi
network to complete the setup.
If sent to any macOS computer
or to mobile devices on iOS 16 or iPadOS 16 and below, the RTS keys will
be ignored, and only the erase device command will be issued to the
device. |
| \- `Enabled` | `boolean` | (Required) If true, the device tries to
re-enroll itself automatically after erasure. The user needs to
deactivate all activation locks for this feature to work correctly. |
| \- `ProfileId` | `string` | Profile ID value associated with a Wi-Fi
profile payload. This is required when the device doesn’t have ethernet
access. |
operationId: eraseDevice
requestBody:
content:
application/json:
schema:
type: object
properties:
DisallowProximitySetup:
type: boolean
example: false
PIN:
type: string
example: '123456'
PreserveDataPlan:
type: boolean
example: true
ReturnToService:
type: object
properties:
Enabled:
type: boolean
example: true
ProfileId:
type: string
example: 8a9f88d9-e7f4-47e6-9326-fd4b39534c4e
examples:
Erase Device:
value:
DisallowProximitySetup: false
PIN: '123456'
PreserveDataPlan: true
ReturnToService:
Enabled: true
ProfileId: 8a9f88d9-e7f4-47e6-9326-fd4b39534c4e
responses:
'200':
description: macOS / Return to service
content: { }
'400':
description: RTS - Profile not in scope
content:
application/octet-stream:
examples:
RTS - Profile not in scope:
value: '"The specified profile is not in scope for the device"'
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/commands:
get:
tags:
- Device Actions
summary: Get Device Commands
description: >-
This endpoint sends a request to get information about the commands sent
to a given device ID.
### MDM Status Codes
* 1 : Command is Pending
* 2 : Command is running
* 3 : Command completed
* 4 : Command failed
* 5 : Command received "Not Now" response
operationId: getDeviceCommands
parameters:
- name: limit
in: query
schema:
type: string
example: '300'
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return
responses:
'200':
description: Get Device Commands
content:
text/plain:
examples:
Get Device Commands:
value: |-
{
"device_id": "0bc8f610-5b88-49a6-b9ef-a68bf04e1e59",
"commands": {
"count": 41,
"next": null,
"previous": null,
"results": [
{
"uuid": "d2b2eafe-2dc2-4b13-bd2b-f93735f0e59f",
"error_chain": [],
"command_type": "ActivationLockBypassCode",
"request_type": "ActivationLockBypassCode",
"metadata": {},
"request_requires_network_tether": false,
"status": 3,
"attempts": 1,
"date_requested": "2022-08-18T15:07:22.133248Z",
"date_completed": "2022-08-18T15:07:23.240937Z",
"last_pushed": "2022-08-18T15:07:22.507520Z",
"user": null,
"priority": 0
},
{
"uuid": "b4b6fa7b-2e61-4907-a1fc-58666e7fd52e",
"error_chain": [],
"command_type": "SetInitialConfiguration",
"request_type": "Settings",
"metadata": {
"Items": [
"MDMOptions"
]
},
"request_requires_network_tether": false,
"status": 3,
"attempts": 1,
"date_requested": "2022-08-18T15:07:22.205070Z",
"date_completed": "2022-08-18T15:07:24.130091Z",
"last_pushed": "2022-08-18T15:07:23.270136Z",
"user": null,
"priority": 0
},
{
"uuid": "165b781e-e36d-4cb8-8af5-c155effaacee",
"error_chain": [],
"command_type": "DeviceConfigured",
"request_type": "DeviceConfigured",
"metadata": {},
"request_requires_network_tether": false,
"status": 3,
"attempts": 1,
"date_requested": "2022-08-18T15:07:22.377306Z",
"date_completed": "2022-08-18T15:07:24.716537Z",
"last_pushed": "2022-08-18T15:07:24.158953Z",
"user": null,
"priority": 0
},
{
"uuid": "c39338a2-d979-415c-81c1-2bae7f066071",
"error_chain": [],
"command_type": "AvailableOSUpdates",
"request_type": "AvailableOSUpdates",
"metadata": {},
"request_requires_network_tether": false,
"status": 3,
"attempts": 1,
"date_requested": "2022-08-18T15:07:22.474435Z",
"date_completed": "2022-08-18T15:07:26.870850Z",
"last_pushed": "2022-08-18T15:07:25.982228Z",
"user": null,
"priority": 0
},
{
"uuid": "839b17f0-9fc6-4e7c-bb4d-1e16e7d445c8",
"error_chain": [],
"command_type": "DeviceInformation",
"request_type": "DeviceInformation",
"metadata": {},
"request_requires_network_tether": false,
"status": 3,
"attempts": 1,
"date_requested": "2022-08-18T15:07:27.365589Z",
"date_completed": "2022-08-18T15:07:28.244997Z",
"last_pushed": "2022-08-18T15:07:27.515012Z",
"user": null,
"priority": 0
},
{
"uuid": "4c6c46ab-70fe-4f22-aee7-472c42b32775",
"error_chain": [],
"command_type": "AvailableOSUpdates",
"request_type": "AvailableOSUpdates",
"metadata": {},
"request_requires_network_tether": false,
"status": 3,
"attempts": 1,
"date_requested": "2022-08-18T15:07:27.437605Z",
"date_completed": "2022-08-18T15:07:30.728527Z",
"last_pushed": "2022-08-18T15:07:28.277193Z",
"user": null,
"priority": 0
},
{...},
]
}
}
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/lock:
post:
tags:
- Device Actions
summary: Lock Device
description: >-
This endpoint sends an MDM command to remotely lock a device.
For macOS clients, an unlock PIN will be created, and returned in the
response.
> **Caution !!!**
> _For a Mac with Apple silicon running a version of macOS before 11.5
will deactivate the Mac. To reactivate, the Mac requires a network
connection and authentication by a Secure Token enabled local
administrator._
Optionally, a JSON payload can be sent in the request to set a lock
message and phone number on the target device.
**Note:** For macOS, although the lock message is displayed on all types
of Mac computers, the phone number is displayed only on a Mac with Apple
silicon.
#### Response properties
Property | Description | Type
:-----|:-----|:-----
PIN | Six digit pin code used to unlock a Mac. | String
operationId: lockDevice
requestBody:
content:
application/json:
schema:
type: object
properties:
Message:
type: string
example: This device is locked!
PhoneNumber:
type: string
example: '1234567890'
examples:
Lock Device:
value:
Message: This device is locked!
PhoneNumber: '1234567890'
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '16'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; frame-ancestors 'none';
default-src 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 19:00:46 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
PIN:
type: string
example: '496406'
examples:
success:
value:
PIN: '496406'
'400':
description: Device already locked
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '16'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; frame-ancestors 'none';
default-src 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 19:00:46 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/octet-stream:
examples:
Device already locked:
value: '"This device is already locked."'
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/reinstallagent:
post:
tags:
- Device Actions
summary: Reinstall Agent
description: >-
This endpoint sends an MDM command reinstall the Kandji Agent. Available
for macOS devices.
operationId: reinstallAgent
responses:
'200':
description: Reinstall Agent
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 17:02:06 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/remotedesktop:
post:
tags:
- Device Actions
summary: Remote Desktop
description: >-
This endpoint sends an MDM command to control the Remote Management
status on a Mac. This MDM command turns on (or turns off) Remote
Management with *Observe* and *Control* permissions given to all
users*.*
**Request Body Parameters**: application/json
* * *
`EnableRemoteDesktop` - `boolean`
operationId: remoteDesktop
requestBody:
content:
application/json:
schema:
type: object
properties:
EnableRemoteDesktop:
type: boolean
example: false
examples:
Remote Desktop:
value:
EnableRemoteDesktop: false
responses:
'200':
description: Turn on Remote Desktop / Turn off Remote Desktop
content:
text/plain:
examples:
Turn on Remote Desktop:
value: ''
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/renewmdmprofile:
post:
tags:
- Device Actions
summary: Renew MDM Profile
description: >-
This endpoint sends an MDM command to re-install the existing root MDM
profile for a given device ID. This command will not impact any existing
configurations, apps, or profiles.
operationId: renewMdmProfile
responses:
'200':
description: Renew MDM Profile
content:
text/plain:
examples:
Renew MDM Profile:
value: No body returned for response
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/restart:
post:
tags:
- Device Actions
summary: Restart Device
description: >-
This endpoint sends an MDM command to remotely restart a device.
- `RebuildKernelCache` - If `true`, the system rebuilds the kernel cache
during a device restart. If `BootstrapTokenAllowedForAuthentication` is
`true` inSecurityInfoResponse.SecurityInfo, the device requests the
bootstrap token from MDM before executing this command. This value is
available in macOS 11 and later. Default: false
- `NotifyUser` - If `true`, notifies the user to restart the device at
their convenience. Forced restart if the device is at `loginwindow` with
no logged-in users. The user can dismiss the notification and ignore the
request. No further notifications display unless you resend the command.
This value is available in macOS 11.3 and later. Default: false
operationId: restartDevice
requestBody:
content:
application/json:
schema:
type: object
properties:
NotifyUser:
type: boolean
example: false
RebuildKernelCache:
type: boolean
example: false
examples:
Restart Device:
value:
NotifyUser: false
RebuildKernelCache: false
responses:
'200':
description: Restart Device
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 17:08:03 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/blankpush:
post:
tags:
- Device Actions
summary: Send Blankpush
description: >-
This endpoint sends an MDM command to initiate a blank push.
[Using the Blank Push
command](https://support.kandji.io/what-is-a-blank-push)
operationId: sendBlankpush
responses:
'200':
description: Send Blankpush
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; default-src 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 17:07:54 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/setname:
post:
tags:
- Device Actions
summary: Set Name
description: |-
This endpoint sends an MDM command to set the device name.
**Request Body Parameters**: application/json
* * *
`DeviceName` - `string`
operationId: setName
requestBody:
content:
application/json:
schema:
type: object
properties:
DeviceName:
type: string
example: Test Mac Mini
examples:
Set Name:
value:
DeviceName: Test Mac Mini
responses:
'200':
description: Set Name
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:54:40 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/shutdown:
post:
tags:
- Device Actions
summary: Shutdown
description: This endpoint sends an MDM command to shutdown a device.
operationId: shutdown
responses:
'200':
description: Shutdown
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; default-src 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 17:01:59 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/updateinventory:
post:
tags:
- Device Actions
summary: Update Inventory
description: >-
This endpoint sends an MDM command to start a check-in for a device,
initiating the daily MDM commands and MDM logic.
operationId: updateInventory
responses:
'200':
description: Update Inventory
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; default-src 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:52:53 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/action/unlockaccount:
post:
tags:
- Device Actions
summary: Unlock Account
description: >-
This endpoint sends an MDM command to unlock a user account that locked
by the system because of too many failed password attempts. Available
for macOS.
**Request Body Parameters**: application/json
* * *
`UserName` - `string`
operationId: unlockAccount
requestBody:
content:
application/json:
schema:
type: object
properties:
UserName:
type: string
example: LocalUserToUnlock
examples:
Unlock Account:
value:
UserName: LocalUserToUnlock
responses:
'200':
description: Unlock Account
headers:
Allow:
schema:
type: string
example: POST
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; base-uri 'none'; default-src 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 17:01:21 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content: { }
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/secrets/bypasscode:
get:
tags:
- Device Secrets
summary: Get Activation Lock Bypass Code
description: >-
This request allows you to retrieve the Activation Lock Bypass code.
user_based_albc is the user-based Activation Lock bypass code for when
Activation Lock is enabled using an personal Apple ID and Find My.
device_based_albc is the device-based Activation Lock bypass code for
when Activation Lock is enabled by the MDM server.
### Request Parameters
`device_id` (path parameter): The unique identifier of the device.
operationId: getActivationLockBypassCode
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '42'
Content-Security-Policy:
schema:
type: string
example: >-
frame-ancestors 'none'; default-src 'none'; form-action
'none'; base-uri 'none'
Date:
schema:
type: string
example: Fri, 14 May 2021 00:46:21 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
device_based_albc:
type: string
example: A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5
user_based_albc:
type: string
example: A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5
examples:
success:
value:
device_based_albc: A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5
user_based_albc: A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/secrets/filevaultkey:
get:
tags:
- Device Secrets
summary: Get FileVault Recovery Key
description: >-
This request allows you to retrieve the FileVault Recovery key for a
macOS device.
### Request Parameters
`device_id` (path parameter): The unique identifier of the device.
operationId: getFilevaultRecoveryKey
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '39'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:11:50 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
key:
type: string
example: 9A2U-CDK6-P6NH-FAB3-LTUH-2MYP
examples:
success:
value:
key: 9A2U-CDK6-P6NH-FAB3-LTUH-2MYP
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/secrets/unlockpin:
get:
tags:
- Device Secrets
summary: Get Unlock Pin
description: >-
This request allows you to retrieve the device unlock pin for a macOS
device.
### Request Parameters
`device_id` (path parameter): The unique identifier of the device.
operationId: getUnlockPin
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '10'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:12:20 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
pin:
type: string
example: '192746'
examples:
success:
value:
pin: '192746'
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/devices/{device_id}/secrets/recoverypassword:
get:
tags:
- Device Secrets
summary: Get Recovery Lock Password
description: >-
This request returns the Recovery Lock password for a Mac with an Apple
Silicon processor and the legacy EFI firmware password for a Mac with an
Intel processor.
For more details on setting and managing Recovery passwords, see this
[Kandji support
article](https://support.kandji.io/support/solutions/articles/72000560472-configure-the-recovery-password-library-item).
### Request Parameters
`device_id` (path parameter): The unique identifier of the device.
operationId: getRecoveryLockPassword
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '10'
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'none'; base-uri 'none';
frame-ancestors 'none'
Date:
schema:
type: string
example: Wed, 07 Apr 2021 16:12:20 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: gunicorn/20.0.4
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
content:
application/json:
schema:
type: object
properties:
recovery_password:
type: string
example: AAAAA-BBBBB-CCCC-1111-2222-3333
examples:
success:
value:
recovery_password: AAAAA-BBBBB-CCCC-1111-2222-3333
parameters:
- name: device_id
in: path
required: true
schema:
type: string
/api/v1/library/custom-apps:
get:
tags:
- Library items
- Custom Apps
summary: List Custom Apps
description: >-
This endpoint makes a request to retrieve a list of custom apps from the
Kandji library.
operationId: listCustomApps
parameters:
- name: page
in: query
schema:
type: string
example: '1'
description: >-
Optional page number. Used when results exceed pagination threshold.
A hard upper `limit` is set at 300 device records returned per
request.
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, POST
Content-Length:
schema:
type: string
example: '122936'
Content-Security-Policy:
schema:
type: string
example: >-
style-src 'self' 'unsafe-inline' unpkg.com; frame-ancestors
'none'; base-uri 'none'; form-action 'none'; default-src
'self'; script-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 05 Oct 2023 18:07:28 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
active:
type: boolean
example: true
audit_script:
type: string
example: ''
created_at:
type: string
example: '2024-01-20T20:07:53.612150Z'
file_key:
type: string
example: >-
companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
file_size:
type: number
example: 42375997
file_updated:
type: string
example: '2024-01-20T20:07:48Z'
file_url:
type: string
example: shortlived S3 URL
id:
type: string
example: 03fd3564-1e29-433f-8e67-6f987f3d242d
install_enforcement:
type: string
example: install_once
install_type:
type: string
example: package
name:
type: string
example: ms_company_portal
postinstall_script:
type: string
example: ''
preinstall_script:
type: string
example: ''
restart:
type: boolean
example: false
show_in_self_service:
type: boolean
example: false
unzip_location:
type: string
example: ''
updated_at:
type: string
example: '2024-02-26T22:31:53.632505Z'
example:
- active: true
audit_script: ''
created_at: '2024-01-20T20:07:53.612150Z'
file_key: >-
companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
file_size: 42375997
file_updated: '2024-01-20T20:07:48Z'
file_url: shortlived S3 URL
id: 03fd3564-1e29-433f-8e67-6f987f3d242d
install_enforcement: install_once
install_type: package
name: ms_company_portal
postinstall_script: ''
preinstall_script: ''
restart: false
show_in_self_service: false
unzip_location: ''
updated_at: '2024-02-26T22:31:53.632505Z'
examples:
success:
value:
count: 2
next: null
previous: null
results:
- active: true
audit_script: ''
created_at: '2024-01-20T20:07:53.612150Z'
file_key: >-
companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
file_size: 42375997
file_updated: '2024-01-20T20:07:48Z'
file_url: shortlived S3 URL
id: 03fd3564-1e29-433f-8e67-6f987f3d242d
install_enforcement: install_once
install_type: package
name: ms_company_portal
postinstall_script: ''
preinstall_script: ''
restart: false
show_in_self_service: false
unzip_location: ''
updated_at: '2024-02-26T22:31:53.632505Z'
post:
tags:
- Library items
- Custom Apps
summary: Create Custom App
description: >-
This request allows you to create a custom app in the Kandji library.
Must have already generated a `file_key` via `Create custom app`
endpoint and uploaded the file to S3 using a request similar to the
`Upload to S3` example.
operationId: createCustomApp
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
active:
type: string
example: 'false'
audit_script:
type: string
example: ''
file_key:
type: string
example: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
install_enforcement:
type: string
example: install_once
install_type:
type: string
example: package
name:
type: string
example: Custom Apps Test
postinstall_script:
type: string
example: ''
preinstall_script:
type: string
example: ''
restart:
type: string
example: 'true'
self_service_category_id:
type: string
example: e6f6d5b4-0659-4b37-872c-5471115d453b
self_service_recommended:
type: string
example: 'true'
show_in_self_service:
type: string
example: 'true'
unzip_location:
type: string
example: /Applications
examples:
Create Custom App:
value:
active: 'false'
audit_script: ''
file_key: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
install_enforcement: install_once
install_type: package
name: Custom Apps Test
postinstall_script: ''
preinstall_script: ''
restart: 'true'
self_service_category_id: e6f6d5b4-0659-4b37-872c-5471115d453b
self_service_recommended: 'true'
show_in_self_service: 'true'
unzip_location: /Applications
responses:
'201':
description: success
headers:
Allow:
schema:
type: string
example: GET, POST
Content-Length:
schema:
type: string
example: '1524'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:25:46 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: true
audit_script:
type: string
example: ''
created_at:
type: string
example: '2023-10-13T17:25:45.868709Z'
file_key:
type: string
example: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
file_size:
type: number
example: 1048576
file_updated:
type: string
example: '2023-10-05T21:25:19Z'
file_url:
type: string
example: (temporary download link from S3)
id:
type: string
example: 58429143-b55c-42d3-a9a3-7c699ddd0ce1
install_enforcement:
type: string
example: install_once
install_type:
type: string
example: package
name:
type: string
example: Custom Apps Test
postinstall_script:
type: string
example: ''
preinstall_script:
type: string
example: ''
restart:
type: boolean
example: false
self_service_category_id:
type: string
example: e6f6d5b4-0659-4b37-872c-5471115d453b
self_service_recommended:
type: boolean
example: true
sha256:
type: string
example: >-
30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
show_in_self_service:
type: boolean
example: true
unzip_location:
type: string
example: ''
updated_at:
type: string
example: '2023-10-13T17:25:45.868789Z'
examples:
success:
value:
active: true
audit_script: ''
created_at: '2023-10-13T17:25:45.868709Z'
file_key: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
file_size: 1048576
file_updated: '2023-10-05T21:25:19Z'
file_url: (temporary download link from S3)
id: 58429143-b55c-42d3-a9a3-7c699ddd0ce1
install_enforcement: install_once
install_type: package
name: Custom Apps Test
postinstall_script: ''
preinstall_script: ''
restart: false
self_service_category_id: e6f6d5b4-0659-4b37-872c-5471115d453b
self_service_recommended: true
sha256: >-
30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
show_in_self_service: true
unzip_location: ''
updated_at: '2023-10-13T17:25:45.868789Z'
/api/v1/library/custom-apps/{library_item_id}:
get:
tags:
- Library items
- Custom Apps
summary: Get Custom App
description: >-
This endpoint retrieves details about a specific custom app from the
Kandji library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: getCustomApp
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '1452'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; form-action 'none'; script-src 'self'
'unsafe-inline' unpkg.com; frame-ancestors 'none'; default-src
'self'; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 05 Oct 2023 19:06:32 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: true
audit_script:
type: string
example: ''
created_at:
type: string
example: '2024-01-20T20:07:53.612150Z'
file_key:
type: string
example: >-
companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
file_size:
type: number
example: 42375997
file_updated:
type: string
example: '2024-01-20T20:07:48Z'
file_url:
type: string
example: shortlived S3 URL
id:
type: string
example: 03fd3564-1e29-433f-8e67-6f987f3d242d
install_enforcement:
type: string
example: install_once
install_type:
type: string
example: package
name:
type: string
example: ms_company_portal
postinstall_script:
type: string
example: ''
preinstall_script:
type: string
example: ''
restart:
type: boolean
example: false
show_in_self_service:
type: boolean
example: false
unzip_location:
type: string
example: ''
updated_at:
type: string
example: '2024-02-26T22:31:53.632505Z'
examples:
success:
value:
active: true
audit_script: ''
created_at: '2024-01-20T20:07:53.612150Z'
file_key: >-
companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
file_size: 42375997
file_updated: '2024-01-20T20:07:48Z'
file_url: shortlived S3 URL
id: 03fd3564-1e29-433f-8e67-6f987f3d242d
install_enforcement: install_once
install_type: package
name: ms_company_portal
postinstall_script: ''
preinstall_script: ''
restart: false
show_in_self_service: false
unzip_location: ''
updated_at: '2024-02-26T22:31:53.632505Z'
delete:
tags:
- Library items
- Custom Apps
summary: Delete Custom App
description: >-
NOTICE: This is permanent so be careful.
This endpoint sends a request to delete a specific custom app from the
Kandji library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: deleteCustomApp
responses:
'204':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:29:08 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content: { }
'404':
description: requested library item not found
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; style-src 'self'
'unsafe-inline' unpkg.com; frame-ancestors 'none'; form-action
'none'; script-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Sat, 20 Jan 2024 20:41:25 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '108'
X-Kong-Upstream-Latency:
schema:
type: string
example: '18'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9985'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300062-BFI, cache-bur-kbur8200143-BUR
X-Timer:
schema:
type: string
example: S1705783285.064267,VS0,VE193
transfer-encoding:
schema:
type: string
example: chunked
content:
text/plain:
examples:
requested library item not found:
value: >
Not
Found Not Found
The requested
resource was not found on this server.
patch:
tags:
- Library items
- Custom Apps
summary: Update Custom App
description: >-
This request allows you to update a custom app in the Kandji library.
Must have already generated a `file_key` via `Create custom app`
endpoint and uploaded the file to S3 using a request similar to the
`Upload to S3` example.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: updateCustomApp
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
example: New Custom App Test Name
examples:
Update Custom App:
value:
name: New Custom App Test Name
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '1532'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:28:31 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: true
audit_script:
type: string
example: ''
created_at:
type: string
example: '2023-10-13T17:25:45.868709Z'
file_key:
type: string
example: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
file_size:
type: number
example: 1048576
file_updated:
type: string
example: '2023-10-05T21:25:19Z'
file_url:
type: string
example: (temporary S3 download URL)
id:
type: string
example: 58429143-b55c-42d3-a9a3-7c699ddd0ce1
install_enforcement:
type: string
example: install_once
install_type:
type: string
example: package
name:
type: string
example: New Custom App Test Name
postinstall_script:
type: string
example: ''
preinstall_script:
type: string
example: ''
restart:
type: boolean
example: false
self_service_category_id:
type: string
example: e6f6d5b4-0659-4b37-872c-5471115d453b
self_service_recommended:
type: boolean
example: true
sha256:
type: string
example: >-
30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
show_in_self_service:
type: boolean
example: true
unzip_location:
type: string
example: ''
updated_at:
type: string
example: '2023-10-13T17:28:30.388475Z'
examples:
success:
value:
active: true
audit_script: ''
created_at: '2023-10-13T17:25:45.868709Z'
file_key: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
file_size: 1048576
file_updated: '2023-10-05T21:25:19Z'
file_url: (temporary S3 download URL)
id: 58429143-b55c-42d3-a9a3-7c699ddd0ce1
install_enforcement: install_once
install_type: package
name: New Custom App Test Name
postinstall_script: ''
preinstall_script: ''
restart: false
self_service_category_id: e6f6d5b4-0659-4b37-872c-5471115d453b
self_service_recommended: true
sha256: >-
30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
show_in_self_service: true
unzip_location: ''
updated_at: '2023-10-13T17:28:30.388475Z'
parameters:
- name: library_item_id
in: path
required: true
schema:
type: string
/api/v1/library/custom-apps/upload:
post:
tags:
- Library items
- Custom Apps
summary: Upload Custom App
description: >-
This request retrieves the S3 upload details need for uploading the app
to Amazon S3.
Creates a pre-signed `post_url` to upload a new Custom App to S3.
The provided `name` will be used to calculate a unique `file_key` in S3.
A separate request will have to be made to the `Upload to S3` endpoint
to upload the file to S3 directly using the `post_url` and `post_data`
from the `Upload Custom App` response.
operationId: uploadCustomApp
requestBody:
content:
application/json:
examples:
Upload Custom App:
value: "{\n\t// required - name of file being uploaded\n\t\"name\": \"example.pkg\"\n}"
responses:
'201':
description: success - create s3 upload
headers:
Allow:
schema:
type: string
example: POST
Content-Length:
schema:
type: string
example: '1955'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; form-action 'none'; script-src 'self'
'unsafe-inline' unpkg.com; frame-ancestors 'none'; default-src
'self'; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 05 Oct 2023 19:07:11 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
text/plain:
examples:
success - create s3 upload:
value: |-
{
"name": "test.pkg",
"expires": "2023-10-06T19:07:11.391656Z",
"post_url": "(url of S3 bucket to POST to)",
"post_data": {
"key": "(field to post along with file to S3 -- the key for the uploaded file)",
"x-amz-algorithm": "(field to post along with file to S3)",
"x-amz-credential": "(field to post along with file to S3)",
"x-amz-date": "(field to post along with file to S3)",
"x-amz-security-token": "(field to post along with file to S3)",
"policy": "(field to post along with file to S3)",
"x-amz-signature": "(field to post along with file to S3)",
},
"file_key": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_ae245110.pkg"
}
/:
post:
tags:
- Library items
- Custom Apps
summary: Upload to S3
description: >-
Example showing separate post request to upload the file to Amazon S3.
### Request Parameters
`post_url` (path parameter): The `post_url` from the `Upload custom app`
response.
### Request Body
For the request body, use the contents of the `post_data` object from
the `Upload custom app` response and supply the path to the custom app
file in the `file` request parameter.
operationId: uploadToS3
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
description: (Required) Your file to upload
type: string
format: binary
key:
description: Value provided by "Create S3 Upload"
type: string
example: >-
companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
policy:
description: Value provided by "Create S3 Upload"
type: string
example: ...
x-amz-algorithm:
description: Value provided by "Create S3 Upload"
type: string
example: ...
x-amz-credential:
description: Value provided by "Create S3 Upload"
type: string
example: ...
x-amz-date:
description: Value provided by "Create S3 Upload"
type: string
example: ...
x-amz-security-token:
description: Value provided by "Create S3 Upload"
type: string
example: ...
x-amz-signature:
description: Value provided by "Create S3 Upload"
type: string
example: ...
responses:
'204':
description: success
headers:
Date:
schema:
type: string
example: Thu, 05 Oct 2023 21:25:16 GMT
ETag:
schema:
type: string
example: '"b6d81b360a5672d80c27430f39153e2c"'
Location:
schema:
type: string
example: >-
https://kandji-dev.s3.amazonaws.com/companies%2Fcompanies%2Fd934a231-e183-4951-b0a0-763e20572c1d%2Flibrary%2Fcustom_apps%2Ftest_18cf0dfc.pkg
Server:
schema:
type: string
example: AmazonS3
x-amz-id-2:
schema:
type: string
example: >-
EA/1YKU6SauCFhH6YA+2bDGGTm2LX7fNFSHKJSg4/I5rAd7QyYHseGVzcqj3G/HBcNU0fMfrsIU=
x-amz-request-id:
schema:
type: string
example: E4ATXGBVBJF7KWGC
x-amz-server-side-encryption:
schema:
type: string
example: AES256
x-amz-version-id:
schema:
type: string
example: j35cEd0o3S64P4ug0_SpFP7T4b4IeO0o
content: { }
security:
- { }
/api/v1/library/custom-profiles:
get:
tags:
- Library items
- Custom Profiles
summary: List Custom Profiles
description: >-
This endpoint makes a request to retrieve a list of custom profiles from
the Kandji library.
operationId: listCustomProfiles
parameters:
- name: page
in: query
schema:
type: string
example: '1'
description: Optional page number (when results exceed pagination threshold)
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, POST
Content-Length:
schema:
type: string
example: '3414731'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; script-src 'self' 'unsafe-inline' unpkg.com;
form-action 'none'; default-src 'self'; frame-ancestors
'none'; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 05 Oct 2023 19:36:48 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
active:
type: boolean
example: false
created_at:
type: string
example: '2023-03-10T19:27:58.677287Z'
id:
type: string
example: a403f056-b1ec-4053-a79d-72ad2fe92485
mdm_identifier:
type: string
example: >-
com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485
name:
type: string
example: odt-sso-ext-test
profile:
type: string
example:
updated_at:
type: string
example: '2023-03-10T20:06:28.622392Z'
example:
- active: false
created_at: '2023-03-10T19:27:58.677287Z'
id: a403f056-b1ec-4053-a79d-72ad2fe92485
mdm_identifier: >-
com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485
name: odt-sso-ext-test
profile:
updated_at: '2023-03-10T20:06:28.622392Z'
- active: false
created_at: '2024-01-28T12:12:40.716224Z'
id: fdf05e37-f157-4cbf-9eab-2e2ef43938ab
mdm_identifier: >-
com.kandji.profile.custom.fdf05e37-f157-4cbf-9eab-2e2ef43938ab
name: Custom Profile New Name
profile:
updated_at: '2024-01-28T12:19:47.897192Z'
examples:
success:
value:
count: 2
next: null
previous: null
results:
- active: false
created_at: '2023-03-10T19:27:58.677287Z'
id: a403f056-b1ec-4053-a79d-72ad2fe92485
mdm_identifier: >-
com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485
name: odt-sso-ext-test
profile:
updated_at: '2023-03-10T20:06:28.622392Z'
- active: false
created_at: '2024-01-28T12:12:40.716224Z'
id: fdf05e37-f157-4cbf-9eab-2e2ef43938ab
mdm_identifier: >-
com.kandji.profile.custom.fdf05e37-f157-4cbf-9eab-2e2ef43938ab
name: Custom Profile New Name
profile:
updated_at: '2024-01-28T12:19:47.897192Z'
post:
tags:
- Library items
- Custom Profiles
summary: Create Custom Profile
description: >-
This request allows you to create a custom profile in the Kandji
library.
operationId: createCustomProfile
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
active:
description: (Optional, default=true) Whether this library item is active
type: string
example: 'false'
file:
description: (Required) The profile's .mobileconfig file
type: string
format: binary
name:
description: (Required) The profile name
type: string
example: Custom Profile Test
responses:
'201':
description: success
headers:
Allow:
schema:
type: string
example: GET, POST
Content-Length:
schema:
type: string
example: '2001'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:29:58 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: true
created_at:
type: string
example: '2023-10-13T17:29:57.339336Z'
id:
type: string
example: e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
mdm_identifier:
type: string
example: >-
com.kandji.profile.custom.e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
name:
type: string
example: Custom Profile Test
profile:
type: string
example: (XML contents of profile)
updated_at:
type: string
example: '2023-10-13T17:29:57.339416Z'
examples:
success:
value:
active: true
created_at: '2023-10-13T17:29:57.339336Z'
id: e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
mdm_identifier: >-
com.kandji.profile.custom.e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
name: Custom Profile Test
profile: (XML contents of profile)
updated_at: '2023-10-13T17:29:57.339416Z'
/api/v1/library/custom-profiles/{library_item_id}:
get:
tags:
- Library items
- Custom Profiles
summary: Get Custom Profile
description: >-
This endpoint retrieves details about a specific custom app from the
Kandji library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: getCustomProfile
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '1452'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; form-action 'none'; script-src 'self'
'unsafe-inline' unpkg.com; frame-ancestors 'none'; default-src
'self'; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 05 Oct 2023 19:06:32 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: false
created_at:
type: string
example: '2023-03-10T19:27:58.677287Z'
id:
type: string
example: a403f056-b1ec-4053-a79d-72ad2fe92485
mdm_identifier:
type: string
example: >-
com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485
name:
type: string
example: odt-sso-ext-test
profile:
type: string
example:
updated_at:
type: string
example: '2023-03-10T20:06:28.622392Z'
examples:
success:
value:
active: false
created_at: '2023-03-10T19:27:58.677287Z'
id: a403f056-b1ec-4053-a79d-72ad2fe92485
mdm_identifier: >-
com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485
name: odt-sso-ext-test
profile:
updated_at: '2023-03-10T20:06:28.622392Z'
delete:
tags:
- Library items
- Custom Profiles
summary: Delete Custom Profile
description: >-
NOTICE: This is permanent so be careful.
This endpoint sends a request to delete a specific custom profile from
the Kandji library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: deleteCustomProfile
responses:
'204':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:31:45 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content: { }
'404':
description: requested library item not found
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; style-src 'self'
'unsafe-inline' unpkg.com; frame-ancestors 'none'; form-action
'none'; script-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Sat, 20 Jan 2024 20:41:25 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '108'
X-Kong-Upstream-Latency:
schema:
type: string
example: '18'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9985'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300062-BFI, cache-bur-kbur8200143-BUR
X-Timer:
schema:
type: string
example: S1705783285.064267,VS0,VE193
transfer-encoding:
schema:
type: string
example: chunked
content:
text/plain:
examples:
requested library item not found:
value: >
Not
Found Not Found
The requested
resource was not found on this server.
patch:
tags:
- Library items
- Custom Profiles
summary: Update Custom Profile
description: >-
This request allows you to update a custom profile in the Kandji
library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: updateCustomProfile
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
description: Renaming a custom profile
type: string
example: Custom Profile New Name
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '2009'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:31:09 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: true
created_at:
type: string
example: '2023-10-13T17:29:57.339336Z'
id:
type: string
example: e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
mdm_identifier:
type: string
example: >-
com.kandji.profile.custom.e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
name:
type: string
example: Custom Profile New Name
profile:
type: string
example: (XML of profile, including new name)
updated_at:
type: string
example: '2023-10-13T17:31:08.086441Z'
examples:
success:
value:
active: true
created_at: '2023-10-13T17:29:57.339336Z'
id: e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
mdm_identifier: >-
com.kandji.profile.custom.e8f93d8e-77da-45a3-b5bf-ede2cf1a330d
name: Custom Profile New Name
profile: (XML of profile, including new name)
updated_at: '2023-10-13T17:31:08.086441Z'
parameters:
- name: library_item_id
in: path
required: true
schema:
type: string
/api/v1/library/custom-scripts:
get:
tags:
- Library items
- Custom Scripts
summary: List Custom Scripts
description: >-
This endpoint makes a request to retrieve a list of custom scripts from
the Kandji library.
operationId: listCustomScripts
parameters:
- name: page
in: query
schema:
type: string
example: '1'
description: Optional page number (when results exceed pagination threshold)
responses:
'200':
description: success
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Allow:
schema:
type: string
example: GET, POST
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; frame-ancestors 'none'; form-action
'none'; base-uri 'none'; script-src 'self' 'unsafe-inline'
unpkg.com; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 11 Jan 2024 22:49:47 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '157'
X-Kong-Upstream-Latency:
schema:
type: string
example: '159'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9995'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-kbfi7400072-BFI, cache-mia-kmia1760095-MIA
X-Timer:
schema:
type: string
example: S1705013387.443589,VS0,VE433
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
active:
type: boolean
example: true
created_at:
type: string
example: '2022-03-24T17:30:26.625839Z'
execution_frequency:
type: string
example: no_enforcement
id:
type: string
example: a155ffb7-ab75-4e5f-ab1d-1334153efad3
name:
type: string
example: Custom Script One
remediation_script:
type: string
example: ''
restart:
type: boolean
example: false
script:
type: string
example: echo "Hello World!"
updated_at:
type: string
example: '2022-03-24T17:30:26.625856Z'
example:
- active: true
created_at: '2022-03-24T17:30:26.625839Z'
execution_frequency: no_enforcement
id: a155ffb7-ab75-4e5f-ab1d-1334153efad3
name: Custom Script One
remediation_script: ''
restart: false
script: echo "Hello World!"
updated_at: '2022-03-24T17:30:26.625856Z'
- active: true
created_at: '2023-08-02T16:25:38.479746Z'
execution_frequency: every_day
id: 2b1aa89d-88f8-4fca-a075-af774615015a
name: Custom Script Two
remediation_script: ''
restart: false
script: echo "Test script"
updated_at: '2023-08-02T16:28:17.209484Z'
examples:
success:
value:
count: 2
next: null
previous: null
results:
- active: true
created_at: '2022-03-24T17:30:26.625839Z'
execution_frequency: no_enforcement
id: a155ffb7-ab75-4e5f-ab1d-1334153efad3
name: Custom Script One
remediation_script: ''
restart: false
script: echo "Hello World!"
updated_at: '2022-03-24T17:30:26.625856Z'
- active: true
created_at: '2023-08-02T16:25:38.479746Z'
execution_frequency: every_day
id: 2b1aa89d-88f8-4fca-a075-af774615015a
name: Custom Script Two
remediation_script: ''
restart: false
script: echo "Test script"
updated_at: '2023-08-02T16:28:17.209484Z'
post:
tags:
- Library items
- Custom Scripts
summary: Create Custom Script
description: This request allows you to create a custom script in the Kandji library.
operationId: createCustomScript
requestBody:
content:
application/json:
examples:
Create Custom Script:
value: "{\n\t\"name\": \"new_custom_script\",\n\t\"execution_frequency\": \"once\", // once, every_15_min, every_day, no_enforcement\n\t\"script\": \"/usr/bin/env zsh\\necho \\\"hi, hello world!\\\"\",\n\t// \"remediation_script\": \"echo \\\"goodbye\\\"\",\n\t\"show_in_self_service\": false,\n\t// \"self_service_category_id\": \"e6f6d5b4-0659-4b37-872c-5471115d453b\", // this is in the \"List Self Service Categories\" endpoint\n\t//\"self_service_recommended\": false,\n\t\"active\": false,\n\t\"restart\": false\n}"
responses:
'201':
description: success
headers:
Allow:
schema:
type: string
example: GET, POST
Content-Length:
schema:
type: string
example: '391'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:32:50 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: false
created_at:
type: string
example: '2024-05-08T23:06:49.419056Z'
execution_frequency:
type: string
example: once
id:
type: string
example: 1cdbbf21-682b-4573-aa22-5aff027a337b
name:
type: string
example: new_custom_script
remediation_script:
type: string
example: ''
restart:
type: boolean
example: false
script:
type: string
example: |-
/usr/bin/env zsh
echo "hi, hello world!"
show_in_self_service:
type: boolean
example: false
updated_at:
type: string
example: '2024-05-08T23:06:49.419071Z'
examples:
success:
value:
active: false
created_at: '2024-05-08T23:06:49.419056Z'
execution_frequency: once
id: 1cdbbf21-682b-4573-aa22-5aff027a337b
name: new_custom_script
remediation_script: ''
restart: false
script: |-
/usr/bin/env zsh
echo "hi, hello world!"
show_in_self_service: false
updated_at: '2024-05-08T23:06:49.419071Z'
/api/v1/library/custom-scripts/{library_item_id}:
get:
tags:
- Library items
- Custom Scripts
summary: Get Custom Script
description: >-
This endpoint retrieves details about a specific custom script from the
Kandji library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: getCustomScript
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '415'
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; script-src 'self' 'unsafe-inline' unpkg.com;
form-action 'none'; default-src 'self'; frame-ancestors
'none'; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 05 Oct 2023 19:40:57 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: true
created_at:
type: string
example: '2022-03-24T17:30:26.625839Z'
execution_frequency:
type: string
example: no_enforcement
id:
type: string
example: a155ffb7-ab75-4e5f-ab1d-1334153efad3
name:
type: string
example: Custom Script One
remediation_script:
type: string
example: ''
restart:
type: boolean
example: false
script:
type: string
example: echo "Hello World!"
updated_at:
type: string
example: '2022-03-24T17:30:26.625856Z'
examples:
success:
value:
active: true
created_at: '2022-03-24T17:30:26.625839Z'
execution_frequency: no_enforcement
id: a155ffb7-ab75-4e5f-ab1d-1334153efad3
name: Custom Script One
remediation_script: ''
restart: false
script: echo "Hello World!"
updated_at: '2022-03-24T17:30:26.625856Z'
delete:
tags:
- Library items
- Custom Scripts
summary: Delete Custom Script
description: >-
NOTICE: This is permanent so be careful.
This endpoint sends a request to delete a specific custom scripts from
the Kandji library.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: deleteCustomScript
responses:
'204':
description: success
headers:
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Content-Length:
schema:
type: string
example: '0'
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; frame-ancestors 'none';
script-src 'self' 'unsafe-inline' unpkg.com; style-src 'self'
'unsafe-inline' unpkg.com; form-action 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 17:36:33 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content: { }
'404':
description: requested library item not found
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
default-src 'self'; base-uri 'none'; style-src 'self'
'unsafe-inline' unpkg.com; frame-ancestors 'none'; form-action
'none'; script-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Sat, 20 Jan 2024 20:41:25 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '108'
X-Kong-Upstream-Latency:
schema:
type: string
example: '18'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9985'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300062-BFI, cache-bur-kbur8200143-BUR
X-Timer:
schema:
type: string
example: S1705783285.064267,VS0,VE193
transfer-encoding:
schema:
type: string
example: chunked
content:
text/plain:
examples:
requested library item not found:
value: >
Not
Found Not Found
The requested
resource was not found on this server.
patch:
tags:
- Library items
- Custom Scripts
summary: Update Custom Script
description: This request allows you to update a custom script in the Kandji library.
operationId: updateCustomScript
requestBody:
content:
application/json:
examples:
Update Custom Script:
value: "{\n\t\"name\": \"updated_custom_script\",\n\t\"execution_frequency\": \"once\", // once, every_15_min, every_day, no_enforcement\n\t\"script\": \"/usr/bin/env zsh\\necho \\\"hi, hello world!\\\"\",\n\t// \"remediation_script\": \"echo \\\"goodbye\\\"\",\n\t\"show_in_self_service\": false,\n\t// \"self_service_category_id\": \"e6f6d5b4-0659-4b37-872c-5471115d453b\", // this is in the \"List Self Service Categories\" endpoint\n\t//\"self_service_recommended\": false,\n\t\"active\": false,\n\t\"restart\": false\n}"
responses:
'200':
description: success / success - zsh example
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Allow:
schema:
type: string
example: GET, PATCH, DELETE
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
base-uri 'none'; frame-ancestors 'none'; default-src 'self';
script-src 'self' 'unsafe-inline' unpkg.com; form-action
'none'; style-src 'self' 'unsafe-inline' unpkg.com
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Sun, 28 Jan 2024 21:31:59 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '31'
X-Kong-Upstream-Latency:
schema:
type: string
example: '248'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9998'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300108-BFI, cache-mia-kmia1760040-MIA
X-Timer:
schema:
type: string
example: S1706477519.885420,VS0,VE381
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
example: false
created_at:
type: string
example: '2024-05-06T23:32:44.597037Z'
execution_frequency:
type: string
example: once
id:
type: string
example: f673d61c-a174-43c5-8e85-412442fb0a2a
name:
type: string
example: updated_custom_script
remediation_script:
type: string
example: ''
restart:
type: boolean
example: false
script:
type: string
example: echo "hi, hello world!"
show_in_self_service:
type: boolean
example: false
updated_at:
type: string
example: '2024-05-08T23:03:09.606424Z'
examples:
success:
value:
active: false
created_at: '2024-05-06T23:32:44.597037Z'
execution_frequency: once
id: f673d61c-a174-43c5-8e85-412442fb0a2a
name: updated_custom_script
remediation_script: ''
restart: false
script: echo "hi, hello world!"
show_in_self_service: false
updated_at: '2024-05-08T23:03:09.606424Z'
success - zsh example:
value:
active: false
created_at: '2024-05-06T23:32:44.597037Z'
execution_frequency: once
id: f673d61c-a174-43c5-8e85-412442fb0a2a
name: updated_custom_script
remediation_script: ''
restart: false
script: |-
/usr/bin/env zsh
echo "hi, hello world!"
show_in_self_service: false
updated_at: '2024-05-08T23:05:39.462672Z'
parameters:
- name: library_item_id
in: path
required: true
schema:
type: string
/api/v1/self-service/categories:
get:
tags:
- Library items
- Self Service
summary: List Self Service Categories
description: >-
This endpoint retrieves a list of self-service categories and their
associated IDs.
If you are planning to make a Library item available in Self Service
under a specific category, you can call this endpoint to get the
category ID and then use that ID when creating or updating the library
item via the Kandji API.
operationId: listSelfServiceCategories
responses:
'200':
description: success
headers:
Allow:
schema:
type: string
example: GET, POST, PATCH, DELETE
Content-Length:
schema:
type: string
example: '717'
Content-Security-Policy:
schema:
type: string
example: >-
script-src 'self' 'unsafe-inline' unpkg.com; base-uri 'none';
frame-ancestors 'none'; form-action 'none'; style-src 'self'
'unsafe-inline' unpkg.com; default-src 'self'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Fri, 13 Oct 2023 16:49:08 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: WSGIServer/0.2 CPython/3.9.10
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
example: e9010a08-a546-470b-a633-04ee27dadfb3
name:
type: string
example: Apps
example:
- id: e9010a08-a546-470b-a633-04ee27dadfb3
name: Apps
- id: 1087f69d-37a3-44f6-a0d8-2b33f5a336bb
name: Productivity
- id: 26a01803-f871-40b7-8c1a-6cae9983c22e
name: Utilities
- id: 2f9912d1-d784-4248-905c-3834812c5537
name: Security
examples:
success:
value:
- id: e9010a08-a546-470b-a633-04ee27dadfb3
name: Apps
- id: 1087f69d-37a3-44f6-a0d8-2b33f5a336bb
name: Productivity
- id: 26a01803-f871-40b7-8c1a-6cae9983c22e
name: Utilities
- id: 2f9912d1-d784-4248-905c-3834812c5537
name: Security
/api/v1/library/library-items/{library_item_id}/activity:
get:
tags:
- Library items
summary: Get Library Item Activity
description: >-
This endpoint retrieves the activity related to a specific library item.
Activity is listed from newest to oldest.
To see a delta of the activity events between now and the last request,
you can store the newest entry from the previous request and then look
for that entry in the next request. Any entry post that will be the
delta.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: getLibraryItemActivity
parameters:
- name: activity_type
in: query
schema:
type: string
example: library_item_assignment_changed
description: >-
Filter actions by this activity type. Choices are:
library_item_created, library_item_edited, library_item_deleted,
library_item_duplicated, library_item_assignment_changed
- name: user_id
in: query
schema:
type: string
example: '{user uuid}'
description: Filter actions by this user (id)
- name: user_email
in: query
schema:
type: string
example: [email protected]
description: Filter actions by this user (email)
- name: limit
in: query
schema:
type: string
example: '10'
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: '100'
description: Specify the starting record to return
responses:
'200':
description: success
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
style-src 'self' 'unsafe-inline' unpkg.com; form-action
'none'; frame-ancestors 'none'; default-src 'self'; script-src
'self' 'unsafe-inline' unpkg.com; base-uri 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 11 Jan 2024 22:40:42 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '135'
X-Kong-Upstream-Latency:
schema:
type: string
example: '180'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9997'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300038-BFI, cache-mia-kmia1760095-MIA
X-Timer:
schema:
type: string
example: S1705012842.098515,VS0,VE408
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 8
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
activity_time:
type: string
example: '2024-01-20T20:31:30.325831Z'
activity_type:
type: string
example: library_item_assignment_changed
details:
type: array
nullable: true
example: null
id:
type: number
example: 1862
user_email:
type: string
example: [email protected]
user_id:
type: string
example: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
example:
- activity_time: '2024-01-20T20:31:30.325831Z'
activity_type: library_item_assignment_changed
details: null
id: 1862
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:31:28.430284Z'
activity_type: library_item_assignment_changed
details: null
id: 1860
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:27:34.379144Z'
activity_type: library_item_assignment_changed
details: null
id: 1858
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:20:20.845315Z'
activity_type: library_item_assignment_changed
details: null
id: 1856
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:20:14.628260Z'
activity_type: library_item_assignment_changed
details: null
id: 1854
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:09:09.539169Z'
activity_type: library_item_edited
details:
- 'Name: test_custom_app → ms_company_portal'
id: 1852
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:08:19.874100Z'
activity_type: library_item_assignment_changed
details: null
id: 1851
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:07:53.701713Z'
activity_type: library_item_created
details: null
id: 1849
user_email: [email protected]`
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
examples:
success:
value:
count: 8
next: null
previous: null
results:
- activity_time: '2024-01-20T20:31:30.325831Z'
activity_type: library_item_assignment_changed
details: null
id: 1862
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:31:28.430284Z'
activity_type: library_item_assignment_changed
details: null
id: 1860
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:27:34.379144Z'
activity_type: library_item_assignment_changed
details: null
id: 1858
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:20:20.845315Z'
activity_type: library_item_assignment_changed
details: null
id: 1856
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:20:14.628260Z'
activity_type: library_item_assignment_changed
details: null
id: 1854
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:09:09.539169Z'
activity_type: library_item_edited
details:
- 'Name: test_custom_app → ms_company_portal'
id: 1852
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:08:19.874100Z'
activity_type: library_item_assignment_changed
details: null
id: 1851
user_email: [email protected]
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
- activity_time: '2024-01-20T20:07:53.701713Z'
activity_type: library_item_created
details: null
id: 1849
user_email: [email protected]`
user_id: 4b9b080b-f82b-41e9-814b-a5668fdd8a3e
parameters:
- name: library_item_id
in: path
required: true
schema:
type: string
/api/v1/library/library-items/{library_item_id}/status:
get:
tags:
- Library items
summary: Get Library Item Statuses
description: >-
This endpoint retrieves the statuses related to a specific library item.
### Request Parameters
`library_item_id` (path parameter): The unique identifier of the library
item.
operationId: getLibraryItemStatuses
parameters:
- name: computer_id
in: query
schema:
type: string
example: '{device_id}'
description: Query for the status of one device.
- name: limit
in: query
schema:
type: string
example: '300'
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return
responses:
'200':
description: success / edr status
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Allow:
schema:
type: string
example: GET
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Content-Security-Policy:
schema:
type: string
example: >-
form-action 'none'; default-src 'self'; script-src 'self'
'unsafe-inline' unpkg.com; style-src 'self' 'unsafe-inline'
unpkg.com; frame-ancestors 'none'; base-uri 'none'
Cross-Origin-Opener-Policy:
schema:
type: string
example: same-origin
Date:
schema:
type: string
example: Thu, 11 Jan 2024 22:41:46 GMT
Feature-Policy:
schema:
type: string
example: >-
accelerometer 'none'; camera 'none'; geolocation 'none';
gyroscope 'none'; magnetometer 'none'; microphone 'none';
payment 'none'; usb 'none'
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Referrer-Policy:
schema:
type: string
example: no-referrer
Server:
schema:
type: string
example: waitress
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000; includeSubDomains; preload
Vary:
schema:
type: string
example: Origin, Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: DENY
X-Kong-Proxy-Latency:
schema:
type: string
example: '108'
X-Kong-Upstream-Latency:
schema:
type: string
example: '139'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9996'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-kbfi7400080-BFI, cache-mia-kmia1760095-MIA
X-Timer:
schema:
type: string
example: S1705012906.049298,VS0,VE340
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 5
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
blueprint:
type: object
properties:
id:
type: string
example: ab102b9d-8e9c-420d-a498-f2a1123091c7
name:
type: string
example: _test_something
computer:
type: object
properties:
id:
type: string
example: 2f25e13e-3b1c-4717-bf7e-7d23e61bb68c
name:
type: string
example: Mac mini
control_log:
nullable: true
example: null
control_reported_at:
nullable: true
example: null
id:
type: number
example: 13908
last_audit_log:
nullable: true
example: null
last_audit_run:
nullable: true
example: null
log:
type: string
nullable: true
example: null
reported_at:
type: string
nullable: true
example: null
status:
type: string
example: PENDING
example:
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 2f25e13e-3b1c-4717-bf7e-7d23e61bb68c
name: Mac mini
control_log: null
control_reported_at: null
id: 13908
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 912bc505-a7ee-4d0b-906d-2102f332a4b3
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 13907
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 977942ac-8303-4ec9-b7bf-439f4e9f18dd
name: as_13_4_dummy_vm_009
control_log: null
control_reported_at: null
id: 13906
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 83b91e8a-23ad-4883-99fb-ffea6d10a049
name: dev_odt_testing_01
control_log: null
control_reported_at: null
id: 13905
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: d238e6c6-2b9d-4d38-acba-03893a66ef20
name: managed_os_macos
computer:
id: ce0e6bbc-1665-471a-9c4c-1c47237c773e
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 13904
last_audit_log: null
last_audit_run: null
log: |-
Executing agent_debug_logging...
Exit code: 0
Script results:
Kandji Agent log level set to DEBUG already ...
reported_at: '2023-10-23T19:47:33Z'
status: PASS
examples:
edr status:
value:
count: 3
next: null
previous: null
results:
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 912bc505-a7ee-4d0b-906d-2102f332a4b3
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
edr_status:
baseline_scan_runtime: >-
Kandji checked 339,254 files in 3 minutes, 41
seconds.
last_baseline_scan: Feb 27, 2024 at 7:34:21 AM
malware_posture: Protect
next_baseline_scan: Mar 26, 2024 at 5:48:10 AM
pup_posture: Protect
status: enabled
id: 14603
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
type: threat-security-policy
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 977942ac-8303-4ec9-b7bf-439f4e9f18dd
name: as_13_4_dummy_vm_009
control_log: null
control_reported_at: null
edr_status: null
id: 14602
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
type: threat-security-policy
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 2f25e13e-3b1c-4717-bf7e-7d23e61bb68c
name: Mac mini
control_log: null
control_reported_at: null
edr_status: null
id: 14600
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
type: threat-security-policy
success:
value:
count: 5
next: null
previous: null
results:
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 2f25e13e-3b1c-4717-bf7e-7d23e61bb68c
name: Mac mini
control_log: null
control_reported_at: null
id: 13908
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 912bc505-a7ee-4d0b-906d-2102f332a4b3
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 13907
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 977942ac-8303-4ec9-b7bf-439f4e9f18dd
name: as_13_4_dummy_vm_009
control_log: null
control_reported_at: null
id: 13906
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: ab102b9d-8e9c-420d-a498-f2a1123091c7
name: _test_something
computer:
id: 83b91e8a-23ad-4883-99fb-ffea6d10a049
name: dev_odt_testing_01
control_log: null
control_reported_at: null
id: 13905
last_audit_log: null
last_audit_run: null
log: null
reported_at: null
status: PENDING
- blueprint:
id: d238e6c6-2b9d-4d38-acba-03893a66ef20
name: managed_os_macos
computer:
id: ce0e6bbc-1665-471a-9c4c-1c47237c773e
name: testuser’s MacBook Air
control_log: null
control_reported_at: null
id: 13904
last_audit_log: null
last_audit_run: null
log: |-
Executing agent_debug_logging...
Exit code: 0
Script results:
Kandji Agent log level set to DEBUG already ...
reported_at: '2023-10-23T19:47:33Z'
status: PASS
parameters:
- name: library_item_id
in: path
required: true
schema:
type: string
/api/v1/prism/activation_lock:
get:
tags:
- Prism
summary: Activation lock
description: Get activation lock attributes for devices.
operationId: activationLock
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
- name: filter
in: query
schema:
type: string
example: ''
- name: sort_by
in: query
schema:
type: string
example: ''
- name: limit
in: query
schema:
type: string
example: ''
- name: offset
in: query
schema:
type: string
example: ''
responses:
'200':
description: success
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Thu, 08 Feb 2024 20:54:54 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Vary:
schema:
type: string
example: Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Kong-Proxy-Latency:
schema:
type: string
example: '50'
X-Kong-Upstream-Latency:
schema:
type: string
example: '233'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9995'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300028-BFI, cache-pdk-katl1840069-PDK
X-Timer:
schema:
type: string
example: S1707425694.207829,VS0,VE356
transfer-encoding:
schema:
type: string
example: chunked
content:
text/plain:
examples:
success:
value: "{\n \"offset\": null,\n \"limit\": 25,\n \"total\": 10,\n \"data\": [\n {\n \"blueprint_id\": \"ac4aba12-d2e5-430a-b7aa-42d25f9e6ead\",\n \"blueprint_name\": \"_ipados_testing\",\n \"device__user_id\": \"\",\n \"device__user_name\": \"\",\n \"device__user_email\": \"\",\n \"device__name\": \"captam3rica's ipad\",\n \"device__family\": \"iPad\",\n \"asset_tag\": null,\n \"serial_number\": \"GG7FF8QSQ1GH\",\n \"model_id\": null,\n \"device_id\": \"0389e9cb-a512-46b9-a743-a8d41551ad15\",\n \"updated_at\": \"2024-04-02T07:20:53.759745+00:00\",\n \"last_changed_at\": null,\n \"last_collected_at\": \"2024-04-02T07:20:53.759745+00:00\",\n \"device_activation_lock_status\": null,\n \"user_activation_lock_status\": false,\n \"device_albc\": null,\n \"user_albc_escrowed\": true,\n \"bypass_code_expired\": false,\n \"user_activation_lock_allowed\": false,\n \"is_activation_lock_supported\": true\n },\n {\n \"blueprint_id\": \"accceac3-d3ee-4277-943e-9f5b52bc9d05\",\n \"blueprint_name\": \"Default Blueprint\",\n \"device__user_id\": \"31250\",\n \"device__user_name\": \"Miss Minutes\",\n \"device__user_email\": \"[email protected]\",\n \"device__name\": \"as-dummy-vm-006\",\n \"device__family\": \"Mac\",\n \"asset_tag\": null,\n \"serial_number\": \"ZGFRNNQGQD\",\n \"model_id\": null,\n \"device_id\": \"05319095-401f-42f4-8a3f-adda27d9830a\",\n \"updated_at\": \"2024-03-12T18:34:18.328180+00:00\",\n \"last_changed_at\": null,\n \"last_collected_at\": \"2024-03-12T18:34:18.328180+00:00\",\n \"device_activation_lock_status\": null,\n \"user_activation_lock_status\": false,\n \"device_albc\": null,s\n \"user_albc_escrowed\": true,\n \"bypass_code_expired\": false,\n \"user_activation_lock_allowed\": false,\n \"is_activation_lock_supported\": true\n },\n\t],\n \"cursor\": null\n}"
/api/v1/prism/apps:
get:
tags:
- Prism
summary: Applications
description: Get the applications installed on macOS, iOS, iPadOS, and tvOS devices.
operationId: applications
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: >-
{"name":{"not_in":["Okta
Verify"]},"device__name":{"not_in":["testuser’s MacBook Air"]}}
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Thu, 08 Feb 2024 20:55:53 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Vary:
schema:
type: string
example: Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Kong-Proxy-Latency:
schema:
type: string
example: '68'
X-Kong-Upstream-Latency:
schema:
type: string
example: '261'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9994'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300066-BFI, cache-pdk-katl1840069-PDK
X-Timer:
schema:
type: string
example: S1707425753.382761,VS0,VE415
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
cursor:
type: string
example: >-
NzgyZjQwNTQtYjk3MS00YmVjLTg1MGItN2JmMTNjZTgwNmZlfDIyMzc1M2VkLTE3NjgtNGU1Zi05ZGRjLTUxNDhiYmQyZGY1NQ==
data:
type: array
items:
type: object
properties:
ad_hoc_code_signed:
type: boolean
example: false
app_clip:
type: boolean
example: false
app_store_vendable:
type: boolean
example: false
apple_scriptable:
nullable: true
example: null
asset_tag:
nullable: true
example: null
beta_app:
type: boolean
example: false
blueprint_id:
type: string
example: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name:
type: string
example: _ipados_testing
bundle_display_name:
nullable: true
example: null
bundle_id:
type: string
example: com.okta.mobile
bundle_name:
nullable: true
example: null
bundle_region:
nullable: true
example: null
bundle_size:
type: number
example: 78786560
bundle_type:
nullable: true
example: null
category:
nullable: true
example: null
compiler:
nullable: true
example: null
copyright:
nullable: true
example: null
developer_name:
nullable: true
example: null
device__family:
type: string
example: iPad
device__name:
type: string
example: captam3rica's ipad
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_based_vpp:
type: boolean
example: true
device_id:
type: string
example: 0389e9cb-a512-46b9-a743-a8d41551ad15
download_canceled:
type: boolean
example: false
download_failed:
type: boolean
example: false
download_paused:
type: boolean
example: false
download_waiting:
type: boolean
example: false
dynamic_size:
type: number
example: 3371008
environment_variables:
nullable: true
example: null
executable:
nullable: true
example: null
external_version_identifier:
type: number
example: 864454422
has_update_available:
type: boolean
example: false
info:
nullable: true
example: null
installing:
type: boolean
example: false
last_changed_at:
nullable: true
example: null
last_collected_at:
type: string
example: '2024-03-29T07:22:51.853635+00:00'
minimum_system_version:
nullable: true
example: null
model_id:
nullable: true
example: null
name:
type: string
example: Okta Verify
obtained_from:
nullable: true
example: null
path:
nullable: true
example: null
serial_number:
type: string
example: GG7FF8QSQ1GH
short_version:
type: string
example: 9.13.0
signature:
nullable: true
example: null
team_id:
nullable: true
example: null
updated_at:
type: string
example: '2024-03-29T07:22:51.931740+00:00'
validated:
type: boolean
example: true
version:
type: string
example: 2024.301.1750
example:
- ad_hoc_code_signed: false
app_clip: false
app_store_vendable: false
apple_scriptable: null
asset_tag: null
beta_app: false
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
bundle_display_name: null
bundle_id: com.okta.mobile
bundle_name: null
bundle_region: null
bundle_size: 78786560
bundle_type: null
category: null
compiler: null
copyright: null
developer_name: null
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_based_vpp: true
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
download_canceled: false
download_failed: false
download_paused: false
download_waiting: false
dynamic_size: 3371008
environment_variables: null
executable: null
external_version_identifier: 864454422
has_update_available: false
info: null
installing: false
last_changed_at: null
last_collected_at: '2024-03-29T07:22:51.853635+00:00'
minimum_system_version: null
model_id: null
name: Okta Verify
obtained_from: null
path: null
serial_number: GG7FF8QSQ1GH
short_version: 9.13.0
signature: null
team_id: null
updated_at: '2024-03-29T07:22:51.931740+00:00'
validated: true
version: 2024.301.1750
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 165
examples:
success:
value:
cursor: >-
NzgyZjQwNTQtYjk3MS00YmVjLTg1MGItN2JmMTNjZTgwNmZlfDIyMzc1M2VkLTE3NjgtNGU1Zi05ZGRjLTUxNDhiYmQyZGY1NQ==
data:
- ad_hoc_code_signed: false
app_clip: false
app_store_vendable: false
apple_scriptable: null
asset_tag: null
beta_app: false
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
bundle_display_name: null
bundle_id: com.okta.mobile
bundle_name: null
bundle_region: null
bundle_size: 78786560
bundle_type: null
category: null
compiler: null
copyright: null
developer_name: null
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_based_vpp: true
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
download_canceled: false
download_failed: false
download_paused: false
download_waiting: false
dynamic_size: 3371008
environment_variables: null
executable: null
external_version_identifier: 864454422
has_update_available: false
info: null
installing: false
last_changed_at: null
last_collected_at: '2024-03-29T07:22:51.853635+00:00'
minimum_system_version: null
model_id: null
name: Okta Verify
obtained_from: null
path: null
serial_number: GG7FF8QSQ1GH
short_version: 9.13.0
signature: null
team_id: null
updated_at: '2024-03-29T07:22:51.931740+00:00'
validated: true
version: 2024.301.1750
limit: 25
offset: null
total: 165
/api/v1/prism/application_firewall:
get:
tags:
- Prism
summary: Application firewall
description: Get Application Firewall details for macOS.
operationId: applicationFirewall
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:33:29 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '42'
X-Kong-Upstream-Latency:
schema:
type: string
example: '137'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9987'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
allow_signed_applications:
type: boolean
example: true
asset_tag:
type: string
nullable: true
example: send "this"
block_all_incoming:
type: boolean
example: false
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at:
nullable: true
example: null
last_collected_at:
type: string
example: '2023-11-08T16:19:03.109352+00:00'
logging:
type: boolean
example: true
logging_option:
type: string
example: throttled
model_id:
nullable: true
example: null
serial_number:
type: string
example: C02FL5YXQ6LC
status:
type: boolean
example: false
stealth_mode:
type: boolean
example: false
unloading:
type: boolean
example: false
updated_at:
type: string
example: '2023-11-08T16:19:03.109352+00:00'
version:
type: string
example: '1.6'
example:
- allow_signed_applications: true
asset_tag: send "this"
block_all_incoming: false
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at: null
last_collected_at: '2023-11-08T16:19:03.109352+00:00'
logging: true
logging_option: throttled
model_id: null
serial_number: C02FL5YXQ6LC
status: false
stealth_mode: false
unloading: false
updated_at: '2023-11-08T16:19:03.109352+00:00'
version: '1.6'
- allow_signed_applications: true
asset_tag: null
block_all_incoming: false
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
last_changed_at: null
last_collected_at: '2023-12-24T22:01:33.059930+00:00'
logging: true
logging_option: throttled
model_id: null
serial_number: Z6V0YW4M1C
status: false
stealth_mode: false
unloading: false
updated_at: '2023-12-24T22:01:33.059930+00:00'
version: '1.7'
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 2
examples:
success:
value:
cursor: null
data:
- allow_signed_applications: true
asset_tag: send "this"
block_all_incoming: false
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at: null
last_collected_at: '2023-11-08T16:19:03.109352+00:00'
logging: true
logging_option: throttled
model_id: null
serial_number: C02FL5YXQ6LC
status: false
stealth_mode: false
unloading: false
updated_at: '2023-11-08T16:19:03.109352+00:00'
version: '1.6'
- allow_signed_applications: true
asset_tag: null
block_all_incoming: false
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
last_changed_at: null
last_collected_at: '2023-12-24T22:01:33.059930+00:00'
logging: true
logging_option: throttled
model_id: null
serial_number: Z6V0YW4M1C
status: false
stealth_mode: false
unloading: false
updated_at: '2023-12-24T22:01:33.059930+00:00'
version: '1.7'
limit: 25
offset: null
total: 2
/api/v1/prism/certificates:
get:
tags:
- Prism
summary: Certificates
description: Get certificate details.
operationId: certificates
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Accept-Ranges:
schema:
type: string
example: bytes
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Thu, 08 Feb 2024 21:12:29 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Vary:
schema:
type: string
example: Accept-Encoding
Via:
schema:
type: string
example: kong/3.2.2, 1.1 varnish, 1.1 varnish
X-Cache:
schema:
type: string
example: MISS, MISS
X-Cache-Hits:
schema:
type: string
example: 0, 0
X-Kong-Proxy-Latency:
schema:
type: string
example: '51'
X-Kong-Upstream-Latency:
schema:
type: string
example: '241'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9991'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
X-Served-By:
schema:
type: string
example: cache-bfi-krnt7300088-BFI, cache-pdk-katl1840069-PDK
X-Timer:
schema:
type: string
example: S1707426749.011701,VS0,VE366
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
asset_tag:
type: string
example: send "this"
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
common_name:
type: string
example: com.apple.kerberos.kdc
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
identity_certificate:
type: boolean
example: true
last_changed_at:
nullable: true
example: null
model_id:
nullable: true
example: null
serial_number:
type: string
example: C02FL5YXQ6LC
updated_at:
type: string
example: '2023-11-07T18:31:34.123336+00:00'
example:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
common_name: com.apple.kerberos.kdc
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
identity_certificate: true
last_changed_at: null
model_id: null
serial_number: C02FL5YXQ6LC
updated_at: '2023-11-07T18:31:34.123336+00:00'
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 1
examples:
success:
value:
cursor: null
data:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
common_name: com.apple.kerberos.kdc
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
identity_certificate: true
last_changed_at: null
model_id: null
serial_number: C02FL5YXQ6LC
updated_at: '2023-11-07T18:31:34.123336+00:00'
limit: 25
offset: null
total: 1
/api/v1/prism/desktop_and_screensaver:
get:
tags:
- Prism
summary: Desktop and Screensaver
description: Get Desktop and Screensaver details for macOS.
operationId: desktopAndScreensaver
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:33:12 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '148'
X-Kong-Upstream-Latency:
schema:
type: string
example: '135'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9988'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
asset_tag:
type: string
nullable: true
example: send "this"
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
bottom_left_hot_corner_modifier:
type: string
example: No Modifiers
bottom_left_hot_corner_option:
type: string
example: 'Off'
bottom_right_hot_corner_modifier:
type: string
example: No Modifiers
bottom_right_hot_corner_option:
type: string
example: Quick Note
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at:
type: string
nullable: true
example: null
last_collected_at:
type: string
example: '2023-11-08T16:19:02.587787+00:00'
model_id:
nullable: true
example: null
screensaver_interval:
type: number
nullable: true
example: 1200
screensaver_path:
type: string
nullable: true
example: >-
/System/Library/Frameworks/ScreenSaver.framework/PlugIns/Ventura.appex
serial_number:
type: string
example: C02FL5YXQ6LC
show_with_clock:
type: boolean
example: false
top_left_hot_corner_modifier:
type: string
example: No Modifiers
top_left_hot_corner_option:
type: string
example: 'Off'
top_right_hot_corner_modifier:
type: string
example: No Modifiers
top_right_hot_corner_option:
type: string
example: 'Off'
updated_at:
type: string
example: '2023-11-08T16:19:02.587787+00:00'
user_account:
type: string
example: matt
uses_random_screensaver:
type: boolean
example: false
example:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
bottom_left_hot_corner_modifier: No Modifiers
bottom_left_hot_corner_option: 'Off'
bottom_right_hot_corner_modifier: No Modifiers
bottom_right_hot_corner_option: Quick Note
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at: null
last_collected_at: '2023-11-08T16:19:02.587787+00:00'
model_id: null
screensaver_interval: 1200
screensaver_path: >-
/System/Library/Frameworks/ScreenSaver.framework/PlugIns/Ventura.appex
serial_number: C02FL5YXQ6LC
show_with_clock: false
top_left_hot_corner_modifier: No Modifiers
top_left_hot_corner_option: 'Off'
top_right_hot_corner_modifier: No Modifiers
top_right_hot_corner_option: 'Off'
updated_at: '2023-11-08T16:19:02.587787+00:00'
user_account: matt
uses_random_screensaver: false
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
bottom_left_hot_corner_modifier: No Modifiers
bottom_left_hot_corner_option: 'Off'
bottom_right_hot_corner_modifier: No Modifiers
bottom_right_hot_corner_option: Quick Note
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at: '2023-09-20T15:49:24.229196+00:00'
last_collected_at: '2023-11-08T16:19:02.587871+00:00'
model_id: null
screensaver_interval: 300
screensaver_path: /Users/testuser/Library/Screen Savers/Brooklyn.saver
serial_number: C02FL5YXQ6LC
show_with_clock: false
top_left_hot_corner_modifier: No Modifiers
top_left_hot_corner_option: 'Off'
top_right_hot_corner_modifier: No Modifiers
top_right_hot_corner_option: 'Off'
updated_at: '2023-11-08T16:19:02.587871+00:00'
user_account: testuser
uses_random_screensaver: false
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
bottom_left_hot_corner_modifier: No Modifiers
bottom_left_hot_corner_option: 'Off'
bottom_right_hot_corner_modifier: No Modifiers
bottom_right_hot_corner_option: Quick Note
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
last_changed_at: null
last_collected_at: '2023-12-24T22:01:33.647310+00:00'
model_id: null
screensaver_interval: null
screensaver_path: null
serial_number: Z6V0YW4M1C
show_with_clock: false
top_left_hot_corner_modifier: No Modifiers
top_left_hot_corner_option: 'Off'
top_right_hot_corner_modifier: No Modifiers
top_right_hot_corner_option: 'Off'
updated_at: '2023-12-24T22:01:33.647310+00:00'
user_account: anka
uses_random_screensaver: false
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 3
examples:
success:
value:
cursor: null
data:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
bottom_left_hot_corner_modifier: No Modifiers
bottom_left_hot_corner_option: 'Off'
bottom_right_hot_corner_modifier: No Modifiers
bottom_right_hot_corner_option: Quick Note
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at: null
last_collected_at: '2023-11-08T16:19:02.587787+00:00'
model_id: null
screensaver_interval: 1200
screensaver_path: >-
/System/Library/Frameworks/ScreenSaver.framework/PlugIns/Ventura.appex
serial_number: C02FL5YXQ6LC
show_with_clock: false
top_left_hot_corner_modifier: No Modifiers
top_left_hot_corner_option: 'Off'
top_right_hot_corner_modifier: No Modifiers
top_right_hot_corner_option: 'Off'
updated_at: '2023-11-08T16:19:02.587787+00:00'
user_account: matt
uses_random_screensaver: false
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
bottom_left_hot_corner_modifier: No Modifiers
bottom_left_hot_corner_option: 'Off'
bottom_right_hot_corner_modifier: No Modifiers
bottom_right_hot_corner_option: Quick Note
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_changed_at: '2023-09-20T15:49:24.229196+00:00'
last_collected_at: '2023-11-08T16:19:02.587871+00:00'
model_id: null
screensaver_interval: 300
screensaver_path: /Users/testuser/Library/Screen Savers/Brooklyn.saver
serial_number: C02FL5YXQ6LC
show_with_clock: false
top_left_hot_corner_modifier: No Modifiers
top_left_hot_corner_option: 'Off'
top_right_hot_corner_modifier: No Modifiers
top_right_hot_corner_option: 'Off'
updated_at: '2023-11-08T16:19:02.587871+00:00'
user_account: testuser
uses_random_screensaver: false
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
bottom_left_hot_corner_modifier: No Modifiers
bottom_left_hot_corner_option: 'Off'
bottom_right_hot_corner_modifier: No Modifiers
bottom_right_hot_corner_option: Quick Note
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
last_changed_at: null
last_collected_at: '2023-12-24T22:01:33.647310+00:00'
model_id: null
screensaver_interval: null
screensaver_path: null
serial_number: Z6V0YW4M1C
show_with_clock: false
top_left_hot_corner_modifier: No Modifiers
top_left_hot_corner_option: 'Off'
top_right_hot_corner_modifier: No Modifiers
top_right_hot_corner_option: 'Off'
updated_at: '2023-12-24T22:01:33.647310+00:00'
user_account: anka
uses_random_screensaver: false
limit: 25
offset: null
total: 3
/api/v1/prism/device_information:
get:
tags:
- Prism
summary: Device information
description: Get attributes about devices.
operationId: deviceInformation
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: 14afabf2-7599-47af-a942-bf7f0b8fedf8
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: >-
{"device__name":{"in":["testusers's MacBook
Air"]},"updated_at":{"gte":"2023-09-03T04:00:00.000Z","lte":"2023-09-04T04:00:00.000Z"}}
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: serial_number
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return
requestBody:
content:
application/json:
examples:
Device information:
value: ''
responses:
'200':
description: >-
success / Get devices by assigned email / Get devices by assigned
user name / Get devices in a blueprint sorted by serial number
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Tue, 19 Sep 2023 22:02:40 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '136'
X-Kong-Upstream-Latency:
schema:
type: string
example: '151'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9999'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
agent_installed:
type: boolean
nullable: true
example: false
agent_version:
nullable: true
example: null
apple_silicon:
type: boolean
nullable: true
example: null
asset_tag:
nullable: true
example: null
blueprint_id:
type: string
example: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name:
type: string
example: _ipados_testing
cellular_technology:
type: string
nullable: true
example: None
data_roaming:
type: boolean
nullable: true
example: false
device__family:
type: string
example: iPad
device__name:
type: string
example: captam3rica's ipad
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_capacity:
type: number
example: 128
device_id:
type: string
example: 0389e9cb-a512-46b9-a743-a8d41551ad15
display_os_version:
type: string
example: '17.4'
first_enrollment_date:
type: string
example: '2024-03-21T11:50:00.995043+00:00'
host_name:
type: string
nullable: true
example: null
hotspot:
nullable: true
example: null
last_collected_at:
type: string
example: '2024-04-02T07:20:56.341015+00:00'
last_enrollment_date:
type: string
example: '2024-03-21T11:50:00.995043+00:00'
local_hostname:
type: string
nullable: true
example: null
mdm_enabled:
type: boolean
example: true
model:
type: string
example: iPad
model_identifier:
nullable: true
example: null
model_name:
type: string
example: iPad (8th generation) (Wi-Fi)
os_build:
type: string
example: '21E219'
os_name:
nullable: true
example: null
os_version:
type: string
example: '17.4'
serial_number:
type: string
example: GG7FF8QSQ1GH
shared_ipad:
type: boolean
nullable: true
example: false
supplemental_build_version:
type: string
example: '21E219'
supplemental_os_version_extra:
nullable: true
example: null
updated_at:
type: string
example: '2024-04-02T07:20:56.341011+00:00'
example:
- agent_installed: false
agent_version: null
apple_silicon: null
asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
cellular_technology: None
data_roaming: false
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_capacity: 128
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
display_os_version: '17.4'
first_enrollment_date: '2024-03-21T11:50:00.995043+00:00'
host_name: null
hotspot: null
last_collected_at: '2024-04-02T07:20:56.341015+00:00'
last_enrollment_date: '2024-03-21T11:50:00.995043+00:00'
local_hostname: null
mdm_enabled: true
model: iPad
model_identifier: null
model_name: iPad (8th generation) (Wi-Fi)
os_build: '21E219'
os_name: null
os_version: '17.4'
serial_number: GG7FF8QSQ1GH
shared_ipad: false
supplemental_build_version: '21E219'
supplemental_os_version_extra: null
updated_at: '2024-04-02T07:20:56.341011+00:00'
- agent_installed: null
agent_version: null
apple_silicon: true
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_capacity: 47
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
display_os_version: '13.3'
first_enrollment_date: '2023-06-29T20:55:18.752765+00:00'
host_name: as-dummy-vm-006
hotspot: null
last_collected_at: '2024-03-12T18:34:17.854656+00:00'
last_enrollment_date: '2023-06-29T20:55:18.752765+00:00'
local_hostname: Ankas-Virtual-Machine
mdm_enabled: true
model: Virtual Machine
model_identifier: null
model_name: Virtual Machine
os_build: '22E252'
os_name: null
os_version: '13.3'
serial_number: ZGFRNNQGQD
shared_ipad: null
supplemental_build_version: '22E252'
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:17.854655+00:00'
- agent_installed: null
agent_version: null
apple_silicon: true
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: testuser’s MacBook Air
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_capacity: 245
device_id: 1bd3ba52-2e39-4099-8a8d-0e55ec4a4fcd
display_os_version: '13.4'
first_enrollment_date: '2023-06-23T15:20:09.112767+00:00'
host_name: testusers-Air
hotspot: null
last_collected_at: '2023-06-26T20:01:49.607197+00:00'
last_enrollment_date: '2023-06-23T15:20:09.112767+00:00'
local_hostname: testusers-MacBook-Air
mdm_enabled: true
model: MacBook Air
model_identifier: null
model_name: MacBook Air (M1, 2020)
os_build: 22F66
os_name: null
os_version: '13.4'
serial_number: FVHHFKF7Q6L4
shared_ipad: null
supplemental_build_version: 22F66
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:18.403776+00:00'
limit:
type: number
example: 25
offset:
type: number
nullable: true
example: null
total:
type: number
example: 10
examples:
Get devices by assigned email:
value:
data:
- apple_silicon: true
blueprint_id: 14afabf2-7599-47af-a942-bf7f0b8fedf8
blueprint_name: _testing_blueprint
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_id: '1715'
device__user_name: Thor Odinson
device_capacity: 47
device_id: 977942ac-8303-4ec9-b7bf-439f4e9f18dd
host_name: as_13_4_dummy_vm_009
local_hostname: Ankas-Virtual-Machine
model: Virtual Machine
model_id: VirtualMac2,1
model_name: Virtual Machine
serial_number: ZGNQQHVT0N
updated_at: '2023-08-04T21:03:27.117701+00:00'
limit: 25
offset: 0
total: 1
Get devices by assigned user name:
value:
cursor: null
data:
- agent_installed: null
agent_version: null
apple_silicon: true
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Thor Odinson
device_capacity: 47
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
display_os_version: '13.3'
first_enrollment_date: '2023-06-29T20:55:18.752765+00:00'
host_name: as-dummy-vm-006
hotspot: null
last_collected_at: '2024-03-12T18:34:17.854656+00:00'
last_enrollment_date: '2023-06-29T20:55:18.752765+00:00'
local_hostname: Ankas-Virtual-Machine
mdm_enabled: true
model: Virtual Machine
model_identifier: null
model_name: Virtual Machine
os_build: '22E252'
os_name: null
os_version: '13.3'
serial_number: ZGFRNNQGQD
shared_ipad: null
supplemental_build_version: '22E252'
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:17.854655+00:00'
limit: 25
offset: null
total: 1
Get devices in a blueprint sorted by serial number:
value:
cursor: null
data:
- agent_installed: true
agent_version: 4.2.9 (4570)
apple_silicon: true
asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_capacity: 245
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
display_os_version: '13.6'
first_enrollment_date: '2023-09-20T14:44:45.258155+00:00'
host_name: testdevicenameli
hotspot: null
last_collected_at: '2023-11-07T20:20:55.355041+00:00'
last_enrollment_date: '2023-09-20T14:44:45.258155+00:00'
local_hostname: test-from-api
mdm_enabled: true
model: MacBook Air
model_identifier: null
model_name: MacBook Air (M1, 2020)
os_build: 22G120
os_name: null
os_version: '13.6'
serial_number: C02FL5YXQ6LC
shared_ipad: null
supplemental_build_version: 22G120
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:18.404262+00:00'
- agent_installed: true
agent_version: 4.3.3 (4811)
apple_silicon: true
asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_capacity: 47
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
display_os_version: 14.1.1
first_enrollment_date: '2023-11-30T16:44:13.890383+00:00'
host_name: 14_1_1_23B81_as_adcs_testing
hotspot: null
last_collected_at: '2023-12-24T04:50:44.744795+00:00'
last_enrollment_date: '2023-11-30T16:44:13.890383+00:00'
local_hostname: ankas-Virtual-Machine
mdm_enabled: true
model: Virtual Machine
model_identifier: null
model_name: Mac
os_build: 23B81
os_name: null
os_version: 14.1.1
serial_number: Z6V0YW4M1C
shared_ipad: null
supplemental_build_version: 23B81
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:18.404399+00:00'
limit: 25
offset: 0
total: 2
success:
value:
cursor: null
data:
- agent_installed: false
agent_version: null
apple_silicon: null
asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
cellular_technology: None
data_roaming: false
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_capacity: 128
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
display_os_version: '17.4'
first_enrollment_date: '2024-03-21T11:50:00.995043+00:00'
host_name: null
hotspot: null
last_collected_at: '2024-04-02T07:20:56.341015+00:00'
last_enrollment_date: '2024-03-21T11:50:00.995043+00:00'
local_hostname: null
mdm_enabled: true
model: iPad
model_identifier: null
model_name: iPad (8th generation) (Wi-Fi)
os_build: '21E219'
os_name: null
os_version: '17.4'
serial_number: GG7FF8QSQ1GH
shared_ipad: false
supplemental_build_version: '21E219'
supplemental_os_version_extra: null
updated_at: '2024-04-02T07:20:56.341011+00:00'
- agent_installed: null
agent_version: null
apple_silicon: true
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_capacity: 47
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
display_os_version: '13.3'
first_enrollment_date: '2023-06-29T20:55:18.752765+00:00'
host_name: as-dummy-vm-006
hotspot: null
last_collected_at: '2024-03-12T18:34:17.854656+00:00'
last_enrollment_date: '2023-06-29T20:55:18.752765+00:00'
local_hostname: Ankas-Virtual-Machine
mdm_enabled: true
model: Virtual Machine
model_identifier: null
model_name: Virtual Machine
os_build: '22E252'
os_name: null
os_version: '13.3'
serial_number: ZGFRNNQGQD
shared_ipad: null
supplemental_build_version: '22E252'
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:17.854655+00:00'
- agent_installed: null
agent_version: null
apple_silicon: true
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
cellular_technology: null
data_roaming: null
device__family: Mac
device__name: testuser’s MacBook Air
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_capacity: 245
device_id: 1bd3ba52-2e39-4099-8a8d-0e55ec4a4fcd
display_os_version: '13.4'
first_enrollment_date: '2023-06-23T15:20:09.112767+00:00'
host_name: testusers-Air
hotspot: null
last_collected_at: '2023-06-26T20:01:49.607197+00:00'
last_enrollment_date: '2023-06-23T15:20:09.112767+00:00'
local_hostname: testusers-MacBook-Air
mdm_enabled: true
model: MacBook Air
model_identifier: null
model_name: MacBook Air (M1, 2020)
os_build: 22F66
os_name: null
os_version: '13.4'
serial_number: FVHHFKF7Q6L4
shared_ipad: null
supplemental_build_version: 22F66
supplemental_os_version_extra: null
updated_at: '2024-03-12T18:34:18.403776+00:00'
limit: 25
offset: null
total: 10
/api/v1/prism/filevault:
get:
tags:
- Prism
summary: FileVault
description: Get FileVault information for macOS.
operationId: filevault
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Thu, 14 Sep 2023 14:47:31 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '125'
X-Kong-Upstream-Latency:
schema:
type: string
example: '205'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9998'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
asset_tag:
nullable: true
example: null
blueprint_id:
type: string
example: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name:
type: string
example: Default Blueprint
device__family:
type: string
example: Mac
device__name:
type: string
example: as-dummy-vm-006
device__user_email:
type: string
example: [email protected]
device__user_id:
type: string
example: '31250'
device__user_name:
type: string
example: Miss Minutes
device_id:
type: string
example: 05319095-401f-42f4-8a3f-adda27d9830a
key_escrowed:
type: boolean
example: false
key_type:
nullable: true
example: null
regeneration_needed:
nullable: true
example: null
scheduled_key_rotation:
nullable: true
example: null
serial_number:
type: string
example: ZGFRNNQGQD
status:
type: boolean
example: false
updated_at:
type: string
example: '2023-06-29T20:55:57.168486+00:00'
example:
- asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
key_escrowed: false
key_type: null
regeneration_needed: null
scheduled_key_rotation: null
serial_number: ZGFRNNQGQD
status: false
updated_at: '2023-06-29T20:55:57.168486+00:00'
limit:
type: number
example: 25
offset:
type: number
example: 0
total:
type: number
example: 1
examples:
success:
value:
cursor: null
data:
- asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
key_escrowed: false
key_type: null
regeneration_needed: null
scheduled_key_rotation: null
serial_number: ZGFRNNQGQD
status: false
updated_at: '2023-06-29T20:55:57.168486+00:00'
limit: 25
offset: 0
total: 1
/api/v1/prism/gatekeeper_and_xprotect:
get:
tags:
- Prism
summary: Gatekeeper and XProtect
description: Get Gatekeeper and XProtect attributes for macOS.
operationId: gatekeeperAndXprotect
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac
description: >-
Results are limited to Mac only as Gatekeeper and XProtect are not
applicable for other platfroms.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:25:24 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '115'
X-Kong-Upstream-Latency:
schema:
type: string
example: '273'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9999'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
asset_tag:
type: string
nullable: true
example: send "this"
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
gatekeeper_opaque_version:
type: string
example: '94'
gatekeeper_status:
type: boolean
example: true
gatekeeper_version:
type: string
example: '8.0'
malware_removal_tool_version:
type: string
example: '1.93'
serial_number:
type: string
example: C02FL5YXQ6LC
trusted_developers:
type: boolean
example: true
updated_at:
type: string
example: '2023-11-08T16:19:02.570175+00:00'
xprotect_version:
type: string
example: '2174'
example:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
gatekeeper_opaque_version: '94'
gatekeeper_status: true
gatekeeper_version: '8.0'
malware_removal_tool_version: '1.93'
serial_number: C02FL5YXQ6LC
trusted_developers: true
updated_at: '2023-11-08T16:19:02.570175+00:00'
xprotect_version: '2174'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
gatekeeper_opaque_version: '94'
gatekeeper_status: true
gatekeeper_version: '8.0'
malware_removal_tool_version: '1.93'
serial_number: Z6V0YW4M1C
trusted_developers: true
updated_at: '2023-12-24T22:01:33.927135+00:00'
xprotect_version: '2177'
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 2
examples:
success:
value:
cursor: null
data:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
gatekeeper_opaque_version: '94'
gatekeeper_status: true
gatekeeper_version: '8.0'
malware_removal_tool_version: '1.93'
serial_number: C02FL5YXQ6LC
trusted_developers: true
updated_at: '2023-11-08T16:19:02.570175+00:00'
xprotect_version: '2174'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
gatekeeper_opaque_version: '94'
gatekeeper_status: true
gatekeeper_version: '8.0'
malware_removal_tool_version: '1.93'
serial_number: Z6V0YW4M1C
trusted_developers: true
updated_at: '2023-12-24T22:01:33.927135+00:00'
xprotect_version: '2177'
limit: 25
offset: null
total: 2
/api/v1/prism/installed_profiles:
get:
tags:
- Prism
summary: Installed profiles
description: Get Installed Profiles attributes for macOS, iOS, iPadOS, and tvOS.
operationId: installedProfiles
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:31:56 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '89'
X-Kong-Upstream-Latency:
schema:
type: string
example: '95'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9989'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
asset_tag:
type: string
nullable: true
example: null
blueprint_id:
type: string
example: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name:
type: string
example: _ipados_testing
device__family:
type: string
example: iPad
device__name:
type: string
example: captam3rica's ipad
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted:
type: boolean
example: false
last_changed_at:
type: string
nullable: true
example: null
last_collected_at:
type: string
example: '2024-04-02T07:20:49.741689+00:00'
managed:
type: boolean
example: true
model_id:
nullable: true
example: null
organization:
type: string
nullable: true
example: Kandji, Inc.
payload_identifier:
type: string
example: com.kandji.profile.mdmprofile
payload_uuid:
type: string
example: aad4c5b3-8c70-4d81-872b-c64932163a14
profile_data:
type: array
items:
type: object
properties:
description:
type: string
example: Configures Mobile Device Management
display_name:
type: string
example: Automated Device Enrollment
identifier:
type: string
example: com.kandji.profile.mdmprofile.scep
organization:
type: string
example: Kandji, Inc.
type:
type: string
example: com.apple.security.scep
uuid:
type: string
example: 0cf44d89-4823-4dae-812d-174de292745c
version:
type: number
example: 1
example:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 0cf44d89-4823-4dae-812d-174de292745c
version: 1
- description: Configures Mobile Device Management
display_name: Automated Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 6d9c1784-4efe-437f-be33-1e82a2c73b81
version: 1
profile_description:
type: string
nullable: true
example: MDM Profile for wilson-test
profile_display_name:
type: string
example: MDM Profile
removable:
type: boolean
example: false
removal_passcode:
type: boolean
example: false
serial_number:
type: string
example: GG7FF8QSQ1GH
signed:
type: boolean
example: true
updated_at:
type: string
example: '2024-04-02T07:20:49.741688+00:00'
example:
- asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted: false
last_changed_at: null
last_collected_at: '2024-04-02T07:20:49.741689+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: aad4c5b3-8c70-4d81-872b-c64932163a14
profile_data:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 0cf44d89-4823-4dae-812d-174de292745c
version: 1
- description: Configures Mobile Device Management
display_name: Automated Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 6d9c1784-4efe-437f-be33-1e82a2c73b81
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: false
removal_passcode: false
serial_number: GG7FF8QSQ1GH
signed: true
updated_at: '2024-04-02T07:20:49.741688+00:00'
- asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted: false
last_changed_at: null
last_collected_at: '2024-04-02T07:20:49.741631+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.odt.sso
payload_uuid: 3dc26ef4-ef35-59a0-aa4c-e2841c968ff0
profile_data:
- identifier: com.kandji.profile.odt.sso.ios-sso
type: com.apple.extensiblesso
uuid: 30b48eb6-802f-4d9a-bcf3-a81f84b03d4a
version: 1
profile_description: null
profile_display_name: SSO for Okta Device Trust
removable: true
removal_passcode: false
serial_number: GG7FF8QSQ1GH
signed: true
updated_at: '2024-04-02T07:20:49.741630+00:00'
- asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted: false
last_changed_at: null
last_collected_at: '2024-04-02T07:20:49.741736+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac
payload_uuid: c0af8f59-8d96-49e3-a66b-80639bc43eac
profile_data:
- display_name: accuhive_wifi
identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac.8ed7b3aa-3bf3-5662-ab34-374302ec7e89
organization: Kandji, Inc.
type: com.apple.wifi.managed
uuid: 50f44e6d-9154-4536-b8dd-46045d11ba7d
version: 1
profile_description: null
profile_display_name: accuhive_wifi
removable: false
removal_passcode: false
serial_number: GG7FF8QSQ1GH
signed: true
updated_at: '2024-04-02T07:20:49.741735+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:04.783812+00:00'
managed: true
model_id: null
organization: null
payload_identifier: >-
com.kandji.profile.custom.ad306d50-3c8a-4411-b9ff-e79c30e48091
payload_uuid: ad306d50-3c8a-4411-b9ff-e79c30e48091
profile_data:
- display_name: Bitdefender - Background items
identifier: >-
io.kandji.bitdefender.service-management.56FEA3E2-F1AE-4097-A065-BA8437825BCF
organization: Kandji
type: com.apple.servicemanagement
uuid: 56FEA3E2-F1AE-4097-A065-BA8437825BCF
version: 1
profile_description: Configures settings for managed background items.
profile_display_name: bitdefender_service_management_settings
removable: false
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:04.783812+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:09.427091+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.custom.ef86969f-956b-40e2-b70b-6c1b77f6daae
payload_uuid: ef86969f-956b-40e2-b70b-6c1b77f6daae
profile_data:
- description: ''
display_name: Privacy Preferences Policy Control
identifier: DBD2AA99-C3DF-420F-98A8-3332651328AE
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: DBD2AA99-C3DF-420F-98A8-3332651328AE
version: 1
- description: Notification settings
display_name: Notifications
identifier: >-
io.kandji.bitdefender.D0DF2C14-D9FE-48E2-A1E5-FD94225C988D
organization: ''
type: com.apple.notificationsettings
uuid: DAF3AE76-A56B-4B5C-8694-28D2FA954BC3
version: 1
- display_name: Web Content Filter Payload
identifier: >-
io.kandji.bitdefender.171C736A-CA59-4EBB-B411-3035422499BF
organization: Kandji, Inc.
type: com.apple.webcontent-filter
uuid: 171C736A-CA59-4EBB-B411-3035422499BF
version: 1
- display_name: Certificate Root
identifier: >-
com.apple.security.root.9AAC02E9-F7A6-46D8-AE99-D937EE23048A
type: com.apple.security.root
uuid: 9AAC02E9-F7A6-46D8-AE99-D937EE23048A
version: 1
- description: ''
display_name: System Extensions
identifier: 8B5B11F3-A0D9-4622-8831-AC32814651CD
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 8B5B11F3-A0D9-4622-8831-AC32814651CD
version: 1
profile_description: >-
Bitdefender System Extensions, PPPC, Notifications,
Bitdefender CA SSL certificate, and Network content
filter
profile_display_name: bitdefender_settings
removable: false
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:09.427091+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:32.645819+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: ff09b9b6-8d61-4be8-8bff-e5631907ca91
profile_data:
- description: Configures Mobile Device Management
display_name: Manual Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 92923a97-c70b-48d9-9507-453081b8d555
version: 1
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 763ed8cf-2989-4bb8-8b48-5f841cd8538e
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: true
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:32.645819+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:17.301050+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.pppc
payload_uuid: 6ca365cc-c9d9-4fff-ba4c-85f010b33d26
profile_data:
- description: >-
Payload for allowing Kandji Agent System Extension
to fully function
display_name: Kandji System Extension Policy
identifier: >-
com.kandji.profile.systemextension.fdaf6524-6294-4db6-aad5-f2c3c3fb16c0
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 32b6528e-e7f4-4c8f-84a1-be96f8b7a9e6
version: 1
- description: >-
Privacy controls for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.00a91858-f56b-44b8-b01f-0e3e916d59ff
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: e8824565-dfb9-430d-9382-7d1f1f3fff41
version: 1
- identifier: io.kandji.agentinfo
uuid: 064a1f7f-d5fb-401c-8a45-c4fafd092f1f
version: 1
- description: >-
Service Management payload for allowing Kandji
Agent background processes to fully function
display_name: Kandji Agent Service Management
identifier: >-
com.kandji.profile.servicemanagement.8ba849b3-b5f5-4306-8275-4d10ee7213c5
organization: Kandji, Inc.
type: com.apple.servicemanagement
uuid: 505ae868-e881-4044-8fe1-c67333dfc339
version: 1
- description: >-
Notifications payload for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.notifications.f0ae4a17-9f18-4248-b53e-81819c1e8bb2
organization: Kandji, Inc.
type: com.apple.notificationsettings
uuid: bde2c164-e0f5-4507-83b6-0050355d6112
version: 1
- description: >-
Privacy controls for allowing Kandji Agent System
Extension to fully function
display_name: Kandji Privacy Preferences Policy Control
identifier: >-
com.kandji.profile.privacy.74320671-1fbe-43e8-9188-2c87c8c7a4b6
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: fdd6b002-b2b1-47a7-86de-7b73fcb573e1
version: 1
- identifier: >-
io.kandji.extensions.Ext-Init.5e699a49-3e9f-4350-8f86-6a722c95b298
type: io.kandji.extensions
uuid: 5e699a49-3e9f-4350-8f86-6a722c95b298
version: 1
profile_description: null
profile_display_name: Kandji Agent Settings
removable: false
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:17.301050+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485133+00:00'
last_collected_at: '2023-11-07T18:31:35.454185+00:00'
managed: true
model_id: null
organization: 'Kandji, Inc. '
payload_identifier: >-
com.kandji.profile.custom.149886e0-8a03-4644-b3fa-a4cc153af386
payload_uuid: 149886e0-8a03-4644-b3fa-a4cc153af386
profile_data:
- identifier: >-
com.okta.mobile.E3836E8E-475E-4A1A-8A1E-13BAC6AD2DF7
type: com.okta.mobile
uuid: E3836E8E-475E-4A1A-8A1E-13BAC6AD2DF7
version: 1
- identifier: >-
com.okta.mobile.auth-service-extension.1901A130-0E7F-450D-9707-43C7FA8E874A
type: com.okta.mobile.auth-service-extension
uuid: 1901A130-0E7F-450D-9707-43C7FA8E874A
version: 1
profile_description: null
profile_display_name: okta_verify_edr_plugin
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454185+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485165+00:00'
last_collected_at: '2023-11-07T18:31:35.454260+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: f318a8c5-33c6-4b46-b98f-d5c96f522291
profile_data:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 1abe0855-4f53-4ad6-b632-5dcf91d8f86e
version: 1
- description: Configures Mobile Device Management
display_name: Automated Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 1b02f351-2d99-4f84-a900-46196560acc0
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454260+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: null
last_collected_at: '2023-11-07T18:31:35.454111+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.odt.scep
payload_uuid: 7bc8db74-ac77-5a86-86cf-e140e2d0d2c4
profile_data:
- identifier: com.kandji.profile.odt.scep.macos-scep
type: com.apple.security.scep
uuid: f24c934b-032f-4aa9-b61b-23304b85769a
version: 1
profile_description: null
profile_display_name: SCEP for Okta Device Trust
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454111+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485210+00:00'
last_collected_at: '2023-11-07T18:31:35.454345+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.odt.sso
payload_uuid: 8a29b97f-2dc0-50d1-9753-1533daf5865c
profile_data:
- identifier: com.kandji.profile.odt.sso.macos-sso
type: com.apple.extensiblesso
uuid: 7f4c2f09-1649-4ade-9222-25a7c2e9b63a
version: 1
- identifier: com.kandji.profile.odt.sso.macos-login-items
type: com.apple.loginitems.managed
uuid: b585ac70-7f62-484c-bbad-fbb558b7bf53
version: 1
- identifier: >-
com.kandji.profile.odt.sso.macos-managed-app.com.okta.mobile
type: com.okta.mobile
uuid: 1fdff755-8fb9-43e3-b18f-78783f918fdf
version: 1
- identifier: >-
com.kandji.profile.odt.sso.macos-managed-app.com.okta.mobile.auth-service-extension
type: com.okta.mobile.auth-service-extension
uuid: c0f90cf7-4d53-4d19-919e-e7223f354a96
version: 1
profile_description: null
profile_display_name: SSO for Okta Device Trust
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454345+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485027+00:00'
last_collected_at: '2023-11-07T18:31:35.454026+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.pppc
payload_uuid: d4d18e85-2dfc-49b2-a459-48efebb17d3a
profile_data:
- description: >-
Privacy controls for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.1656a2ff-850d-4558-b549-9ed7a232e9aa
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: 5e675326-2ab7-40f7-b3b1-479631545e02
version: 1
- identifier: io.kandji.agentinfo
uuid: 853a9c47-a10b-45d8-84ca-e1319eb38ac8
version: 1
- identifier: >-
io.kandji.extensions.Ext-Init.5e699a49-3e9f-4350-8f86-6a722c95b298
type: io.kandji.extensions
uuid: 5e699a49-3e9f-4350-8f86-6a722c95b298
version: 1
- description: >-
Service Management payload for allowing Kandji
Agent background processes to fully function
display_name: Kandji Agent Service Management
identifier: >-
com.kandji.profile.servicemanagement.f416b1d1-94dd-4df9-9d09-cbd0b687be42
organization: Kandji, Inc.
type: com.apple.servicemanagement
uuid: 23b971f9-c61c-4d38-a14c-b7b8dd086a23
version: 1
- description: >-
Notifications payload for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.notifications.4d92c54b-bd20-41a3-91b9-6cf97fadb3f3
organization: Kandji, Inc.
type: com.apple.notificationsettings
uuid: 6008ee2f-c8be-41ba-a962-260aa33febde
version: 1
- description: >-
Payload for allowing Kandji Agent System Extension
to fully function
display_name: Kandji System Extension Policy
identifier: >-
com.kandji.profile.systemextension.e69374a4-c879-4edc-a4db-9e2aec799d19
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 2be0e054-4b8a-4a8f-a238-8fbb5964c927
version: 1
- description: >-
Privacy controls for allowing Kandji Agent System
Extension to fully function
display_name: Kandji Privacy Preferences Policy Control
identifier: >-
com.kandji.profile.privacy.82691b01-a4d5-4f05-a748-1aa5ee3c65e6
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: 9a3c50d2-76a3-45a2-ac16-fbadbf534ebb
version: 1
profile_description: null
profile_display_name: Kandji Agent Settings
removable: false
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454026+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: null
last_collected_at: '2023-11-07T18:31:35.454408+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e
payload_uuid: 3ad11b1e-42fb-4405-b826-c9cdf6061e7e
profile_data:
- display_name: pppc_finder
identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e.862e2704-c4da-4505-83e7-08fdf2b53ccb
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: c01c6848-d692-5be1-9a8e-76f0b0648d4c
version: 1
profile_description: null
profile_display_name: pppc_finder
removable: false
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454408+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-09-21T22:03:54.765472+00:00'
last_collected_at: '2023-11-07T18:31:35.454470+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac
payload_uuid: c0af8f59-8d96-49e3-a66b-80639bc43eac
profile_data:
- display_name: accuhive_wifi
identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac.b9284908-1eaa-4363-8ec7-c5bea24bcee1
organization: Kandji, Inc.
type: com.apple.wifi.managed
uuid: 8ed7b3aa-3bf3-5662-ab34-374302ec7e89
version: 1
profile_description: null
profile_display_name: accuhive_wifi
removable: false
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454470+00:00'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
encrypted: false
last_changed_at: '2023-12-24T04:50:42.562366+00:00'
last_collected_at: '2023-12-24T04:50:42.531572+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: 1b5fb609-5bca-4e65-95d8-ce4490a50eed
profile_data:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: a86cf18e-a8ed-4478-b070-351f3f4c6f7c
version: 1
- description: Configures Mobile Device Management
display_name: Manual Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: ea8be299-30d8-4854-ac5e-1dcd89f4551f
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: true
removal_passcode: false
serial_number: Z6V0YW4M1C
signed: true
updated_at: '2023-12-24T04:50:42.531572+00:00'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
encrypted: false
last_changed_at: '2023-12-24T04:50:42.562420+00:00'
last_collected_at: '2023-12-24T04:50:42.531842+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.pppc
payload_uuid: f958d7d8-5b9d-41ac-8f94-7a54c2ab419f
profile_data:
- description: >-
Privacy controls for allowing Kandji Agent System
Extension to fully function
display_name: Kandji Privacy Preferences Policy Control
identifier: >-
com.kandji.profile.privacy.8569082a-b7f4-4b17-b190-197986ffb60f
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: fd6bef60-2c0a-431c-9b2f-aafbfd41bff8
version: 1
- description: >-
Payload for allowing Kandji Agent System Extension
to fully function
display_name: Kandji System Extension Policy
identifier: >-
com.kandji.profile.systemextension.b8219ab8-4681-4f6a-a7b8-7607724717c2
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 5dcd84cb-f182-4285-99d0-bcca72068383
version: 1
- identifier: >-
io.kandji.extensions.Ext-Init.5e699a49-3e9f-4350-8f86-6a722c95b298
type: io.kandji.extensions
uuid: 5e699a49-3e9f-4350-8f86-6a722c95b298
version: 1
- identifier: io.kandji.agentinfo
uuid: ec1238ea-ef81-4362-ab64-33968a1f96ae
version: 1
- description: >-
Service Management payload for allowing Kandji
Agent background processes to fully function
display_name: Kandji Agent Service Management
identifier: >-
com.kandji.profile.servicemanagement.3ebdc470-c9ec-4ae9-8148-91f977c4ab3d
organization: Kandji, Inc.
type: com.apple.servicemanagement
uuid: a9f53a12-0ab9-4876-bab0-b01f35b016d0
version: 1
- description: >-
Notifications payload for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.notifications.84cdf4c1-1588-4b2b-b919-f0131cfda81d
organization: Kandji, Inc.
type: com.apple.notificationsettings
uuid: f7cfda88-2aed-4e05-8f04-3c740deb009a
version: 1
- description: >-
Privacy controls for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.33c775a5-de40-4701-b2c3-645c83a21d12
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: a540cff7-54aa-41c8-9537-5b8daad3413a
version: 1
profile_description: null
profile_display_name: Kandji Agent Settings
removable: false
removal_passcode: false
serial_number: Z6V0YW4M1C
signed: true
updated_at: '2023-12-24T04:50:42.531842+00:00'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
encrypted: false
last_changed_at: null
last_collected_at: '2023-12-24T04:50:42.531638+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e
payload_uuid: 3ad11b1e-42fb-4405-b826-c9cdf6061e7e
profile_data:
- display_name: pppc_finder
identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e.39b51ba8-95ca-4b1d-9307-d2192a318bbc
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: c01c6848-d692-5be1-9a8e-76f0b0648d4c
version: 1
profile_description: null
profile_display_name: pppc_finder
removable: false
removal_passcode: false
serial_number: Z6V0YW4M1C
signed: true
updated_at: '2023-12-24T04:50:42.531638+00:00'
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 17
examples:
success:
value:
cursor: null
data:
- asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted: false
last_changed_at: null
last_collected_at: '2024-04-02T07:20:49.741689+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: aad4c5b3-8c70-4d81-872b-c64932163a14
profile_data:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 0cf44d89-4823-4dae-812d-174de292745c
version: 1
- description: Configures Mobile Device Management
display_name: Automated Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 6d9c1784-4efe-437f-be33-1e82a2c73b81
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: false
removal_passcode: false
serial_number: GG7FF8QSQ1GH
signed: true
updated_at: '2024-04-02T07:20:49.741688+00:00'
- asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted: false
last_changed_at: null
last_collected_at: '2024-04-02T07:20:49.741631+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.odt.sso
payload_uuid: 3dc26ef4-ef35-59a0-aa4c-e2841c968ff0
profile_data:
- identifier: com.kandji.profile.odt.sso.ios-sso
type: com.apple.extensiblesso
uuid: 30b48eb6-802f-4d9a-bcf3-a81f84b03d4a
version: 1
profile_description: null
profile_display_name: SSO for Okta Device Trust
removable: true
removal_passcode: false
serial_number: GG7FF8QSQ1GH
signed: true
updated_at: '2024-04-02T07:20:49.741630+00:00'
- asset_tag: null
blueprint_id: ac4aba12-d2e5-430a-b7aa-42d25f9e6ead
blueprint_name: _ipados_testing
device__family: iPad
device__name: captam3rica's ipad
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 0389e9cb-a512-46b9-a743-a8d41551ad15
encrypted: false
last_changed_at: null
last_collected_at: '2024-04-02T07:20:49.741736+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac
payload_uuid: c0af8f59-8d96-49e3-a66b-80639bc43eac
profile_data:
- display_name: accuhive_wifi
identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac.8ed7b3aa-3bf3-5662-ab34-374302ec7e89
organization: Kandji, Inc.
type: com.apple.wifi.managed
uuid: 50f44e6d-9154-4536-b8dd-46045d11ba7d
version: 1
profile_description: null
profile_display_name: accuhive_wifi
removable: false
removal_passcode: false
serial_number: GG7FF8QSQ1GH
signed: true
updated_at: '2024-04-02T07:20:49.741735+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:04.783812+00:00'
managed: true
model_id: null
organization: null
payload_identifier: >-
com.kandji.profile.custom.ad306d50-3c8a-4411-b9ff-e79c30e48091
payload_uuid: ad306d50-3c8a-4411-b9ff-e79c30e48091
profile_data:
- display_name: Bitdefender - Background items
identifier: >-
io.kandji.bitdefender.service-management.56FEA3E2-F1AE-4097-A065-BA8437825BCF
organization: Kandji
type: com.apple.servicemanagement
uuid: 56FEA3E2-F1AE-4097-A065-BA8437825BCF
version: 1
profile_description: Configures settings for managed background items.
profile_display_name: bitdefender_service_management_settings
removable: false
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:04.783812+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:09.427091+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.custom.ef86969f-956b-40e2-b70b-6c1b77f6daae
payload_uuid: ef86969f-956b-40e2-b70b-6c1b77f6daae
profile_data:
- description: ''
display_name: Privacy Preferences Policy Control
identifier: DBD2AA99-C3DF-420F-98A8-3332651328AE
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: DBD2AA99-C3DF-420F-98A8-3332651328AE
version: 1
- description: Notification settings
display_name: Notifications
identifier: >-
io.kandji.bitdefender.D0DF2C14-D9FE-48E2-A1E5-FD94225C988D
organization: ''
type: com.apple.notificationsettings
uuid: DAF3AE76-A56B-4B5C-8694-28D2FA954BC3
version: 1
- display_name: Web Content Filter Payload
identifier: >-
io.kandji.bitdefender.171C736A-CA59-4EBB-B411-3035422499BF
organization: Kandji, Inc.
type: com.apple.webcontent-filter
uuid: 171C736A-CA59-4EBB-B411-3035422499BF
version: 1
- display_name: Certificate Root
identifier: >-
com.apple.security.root.9AAC02E9-F7A6-46D8-AE99-D937EE23048A
type: com.apple.security.root
uuid: 9AAC02E9-F7A6-46D8-AE99-D937EE23048A
version: 1
- description: ''
display_name: System Extensions
identifier: 8B5B11F3-A0D9-4622-8831-AC32814651CD
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 8B5B11F3-A0D9-4622-8831-AC32814651CD
version: 1
profile_description: >-
Bitdefender System Extensions, PPPC, Notifications,
Bitdefender CA SSL certificate, and Network content
filter
profile_display_name: bitdefender_settings
removable: false
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:09.427091+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:32.645819+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: ff09b9b6-8d61-4be8-8bff-e5631907ca91
profile_data:
- description: Configures Mobile Device Management
display_name: Manual Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 92923a97-c70b-48d9-9507-453081b8d555
version: 1
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 763ed8cf-2989-4bb8-8b48-5f841cd8538e
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: true
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:32.645819+00:00'
- asset_tag: '111111'
blueprint_id: 1a091645-e6a2-4824-bcb9-2606e123fa8f
blueprint_name: kiosk -
device__family: Mac
device__name: as_13_4_dummy_vm_009
device__user_email: [email protected]
device__user_id: '31245'
device__user_name: Johann Shmidt
device_id: 2008b74b-753c-45a1-916b-49ca99e83ac1
encrypted: false
last_changed_at: null
last_collected_at: '2023-08-29T17:36:17.301050+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.pppc
payload_uuid: 6ca365cc-c9d9-4fff-ba4c-85f010b33d26
profile_data:
- description: >-
Payload for allowing Kandji Agent System Extension
to fully function
display_name: Kandji System Extension Policy
identifier: >-
com.kandji.profile.systemextension.fdaf6524-6294-4db6-aad5-f2c3c3fb16c0
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 32b6528e-e7f4-4c8f-84a1-be96f8b7a9e6
version: 1
- description: >-
Privacy controls for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.00a91858-f56b-44b8-b01f-0e3e916d59ff
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: e8824565-dfb9-430d-9382-7d1f1f3fff41
version: 1
- identifier: io.kandji.agentinfo
uuid: 064a1f7f-d5fb-401c-8a45-c4fafd092f1f
version: 1
- description: >-
Service Management payload for allowing Kandji
Agent background processes to fully function
display_name: Kandji Agent Service Management
identifier: >-
com.kandji.profile.servicemanagement.8ba849b3-b5f5-4306-8275-4d10ee7213c5
organization: Kandji, Inc.
type: com.apple.servicemanagement
uuid: 505ae868-e881-4044-8fe1-c67333dfc339
version: 1
- description: >-
Notifications payload for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.notifications.f0ae4a17-9f18-4248-b53e-81819c1e8bb2
organization: Kandji, Inc.
type: com.apple.notificationsettings
uuid: bde2c164-e0f5-4507-83b6-0050355d6112
version: 1
- description: >-
Privacy controls for allowing Kandji Agent System
Extension to fully function
display_name: Kandji Privacy Preferences Policy Control
identifier: >-
com.kandji.profile.privacy.74320671-1fbe-43e8-9188-2c87c8c7a4b6
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: fdd6b002-b2b1-47a7-86de-7b73fcb573e1
version: 1
- identifier: >-
io.kandji.extensions.Ext-Init.5e699a49-3e9f-4350-8f86-6a722c95b298
type: io.kandji.extensions
uuid: 5e699a49-3e9f-4350-8f86-6a722c95b298
version: 1
profile_description: null
profile_display_name: Kandji Agent Settings
removable: false
removal_passcode: false
serial_number: ZGNQQHVT0N
signed: true
updated_at: '2023-08-29T17:36:17.301050+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485133+00:00'
last_collected_at: '2023-11-07T18:31:35.454185+00:00'
managed: true
model_id: null
organization: 'Kandji, Inc. '
payload_identifier: >-
com.kandji.profile.custom.149886e0-8a03-4644-b3fa-a4cc153af386
payload_uuid: 149886e0-8a03-4644-b3fa-a4cc153af386
profile_data:
- identifier: >-
com.okta.mobile.E3836E8E-475E-4A1A-8A1E-13BAC6AD2DF7
type: com.okta.mobile
uuid: E3836E8E-475E-4A1A-8A1E-13BAC6AD2DF7
version: 1
- identifier: >-
com.okta.mobile.auth-service-extension.1901A130-0E7F-450D-9707-43C7FA8E874A
type: com.okta.mobile.auth-service-extension
uuid: 1901A130-0E7F-450D-9707-43C7FA8E874A
version: 1
profile_description: null
profile_display_name: okta_verify_edr_plugin
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454185+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485165+00:00'
last_collected_at: '2023-11-07T18:31:35.454260+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: f318a8c5-33c6-4b46-b98f-d5c96f522291
profile_data:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: 1abe0855-4f53-4ad6-b632-5dcf91d8f86e
version: 1
- description: Configures Mobile Device Management
display_name: Automated Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: 1b02f351-2d99-4f84-a900-46196560acc0
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454260+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: null
last_collected_at: '2023-11-07T18:31:35.454111+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.odt.scep
payload_uuid: 7bc8db74-ac77-5a86-86cf-e140e2d0d2c4
profile_data:
- identifier: com.kandji.profile.odt.scep.macos-scep
type: com.apple.security.scep
uuid: f24c934b-032f-4aa9-b61b-23304b85769a
version: 1
profile_description: null
profile_display_name: SCEP for Okta Device Trust
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454111+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485210+00:00'
last_collected_at: '2023-11-07T18:31:35.454345+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.odt.sso
payload_uuid: 8a29b97f-2dc0-50d1-9753-1533daf5865c
profile_data:
- identifier: com.kandji.profile.odt.sso.macos-sso
type: com.apple.extensiblesso
uuid: 7f4c2f09-1649-4ade-9222-25a7c2e9b63a
version: 1
- identifier: com.kandji.profile.odt.sso.macos-login-items
type: com.apple.loginitems.managed
uuid: b585ac70-7f62-484c-bbad-fbb558b7bf53
version: 1
- identifier: >-
com.kandji.profile.odt.sso.macos-managed-app.com.okta.mobile
type: com.okta.mobile
uuid: 1fdff755-8fb9-43e3-b18f-78783f918fdf
version: 1
- identifier: >-
com.kandji.profile.odt.sso.macos-managed-app.com.okta.mobile.auth-service-extension
type: com.okta.mobile.auth-service-extension
uuid: c0f90cf7-4d53-4d19-919e-e7223f354a96
version: 1
profile_description: null
profile_display_name: SSO for Okta Device Trust
removable: true
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454345+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-11-07T18:31:35.485027+00:00'
last_collected_at: '2023-11-07T18:31:35.454026+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.pppc
payload_uuid: d4d18e85-2dfc-49b2-a459-48efebb17d3a
profile_data:
- description: >-
Privacy controls for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.1656a2ff-850d-4558-b549-9ed7a232e9aa
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: 5e675326-2ab7-40f7-b3b1-479631545e02
version: 1
- identifier: io.kandji.agentinfo
uuid: 853a9c47-a10b-45d8-84ca-e1319eb38ac8
version: 1
- identifier: >-
io.kandji.extensions.Ext-Init.5e699a49-3e9f-4350-8f86-6a722c95b298
type: io.kandji.extensions
uuid: 5e699a49-3e9f-4350-8f86-6a722c95b298
version: 1
- description: >-
Service Management payload for allowing Kandji
Agent background processes to fully function
display_name: Kandji Agent Service Management
identifier: >-
com.kandji.profile.servicemanagement.f416b1d1-94dd-4df9-9d09-cbd0b687be42
organization: Kandji, Inc.
type: com.apple.servicemanagement
uuid: 23b971f9-c61c-4d38-a14c-b7b8dd086a23
version: 1
- description: >-
Notifications payload for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.notifications.4d92c54b-bd20-41a3-91b9-6cf97fadb3f3
organization: Kandji, Inc.
type: com.apple.notificationsettings
uuid: 6008ee2f-c8be-41ba-a962-260aa33febde
version: 1
- description: >-
Payload for allowing Kandji Agent System Extension
to fully function
display_name: Kandji System Extension Policy
identifier: >-
com.kandji.profile.systemextension.e69374a4-c879-4edc-a4db-9e2aec799d19
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 2be0e054-4b8a-4a8f-a238-8fbb5964c927
version: 1
- description: >-
Privacy controls for allowing Kandji Agent System
Extension to fully function
display_name: Kandji Privacy Preferences Policy Control
identifier: >-
com.kandji.profile.privacy.82691b01-a4d5-4f05-a748-1aa5ee3c65e6
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: 9a3c50d2-76a3-45a2-ac16-fbadbf534ebb
version: 1
profile_description: null
profile_display_name: Kandji Agent Settings
removable: false
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454026+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: null
last_collected_at: '2023-11-07T18:31:35.454408+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e
payload_uuid: 3ad11b1e-42fb-4405-b826-c9cdf6061e7e
profile_data:
- display_name: pppc_finder
identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e.862e2704-c4da-4505-83e7-08fdf2b53ccb
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: c01c6848-d692-5be1-9a8e-76f0b0648d4c
version: 1
profile_description: null
profile_display_name: pppc_finder
removable: false
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454408+00:00'
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
encrypted: false
last_changed_at: '2023-09-21T22:03:54.765472+00:00'
last_collected_at: '2023-11-07T18:31:35.454470+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac
payload_uuid: c0af8f59-8d96-49e3-a66b-80639bc43eac
profile_data:
- display_name: accuhive_wifi
identifier: >-
com.kandji.profile.wifi.c0af8f59-8d96-49e3-a66b-80639bc43eac.b9284908-1eaa-4363-8ec7-c5bea24bcee1
organization: Kandji, Inc.
type: com.apple.wifi.managed
uuid: 8ed7b3aa-3bf3-5662-ab34-374302ec7e89
version: 1
profile_description: null
profile_display_name: accuhive_wifi
removable: false
removal_passcode: false
serial_number: C02FL5YXQ6LC
signed: true
updated_at: '2023-11-07T18:31:35.454470+00:00'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
encrypted: false
last_changed_at: '2023-12-24T04:50:42.562366+00:00'
last_collected_at: '2023-12-24T04:50:42.531572+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.mdmprofile
payload_uuid: 1b5fb609-5bca-4e65-95d8-ce4490a50eed
profile_data:
- identifier: com.kandji.profile.mdmprofile.scep
type: com.apple.security.scep
uuid: a86cf18e-a8ed-4478-b070-351f3f4c6f7c
version: 1
- description: Configures Mobile Device Management
display_name: Manual Device Enrollment
identifier: com.kandji.profile.mdmprofile.mdm
organization: Kandji, Inc.
type: com.apple.mdm
uuid: ea8be299-30d8-4854-ac5e-1dcd89f4551f
version: 1
profile_description: MDM Profile for wilson-test
profile_display_name: MDM Profile
removable: true
removal_passcode: false
serial_number: Z6V0YW4M1C
signed: true
updated_at: '2023-12-24T04:50:42.531572+00:00'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
encrypted: false
last_changed_at: '2023-12-24T04:50:42.562420+00:00'
last_collected_at: '2023-12-24T04:50:42.531842+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: com.kandji.profile.pppc
payload_uuid: f958d7d8-5b9d-41ac-8f94-7a54c2ab419f
profile_data:
- description: >-
Privacy controls for allowing Kandji Agent System
Extension to fully function
display_name: Kandji Privacy Preferences Policy Control
identifier: >-
com.kandji.profile.privacy.8569082a-b7f4-4b17-b190-197986ffb60f
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: fd6bef60-2c0a-431c-9b2f-aafbfd41bff8
version: 1
- description: >-
Payload for allowing Kandji Agent System Extension
to fully function
display_name: Kandji System Extension Policy
identifier: >-
com.kandji.profile.systemextension.b8219ab8-4681-4f6a-a7b8-7607724717c2
organization: Kandji, Inc.
type: com.apple.system-extension-policy
uuid: 5dcd84cb-f182-4285-99d0-bcca72068383
version: 1
- identifier: >-
io.kandji.extensions.Ext-Init.5e699a49-3e9f-4350-8f86-6a722c95b298
type: io.kandji.extensions
uuid: 5e699a49-3e9f-4350-8f86-6a722c95b298
version: 1
- identifier: io.kandji.agentinfo
uuid: ec1238ea-ef81-4362-ab64-33968a1f96ae
version: 1
- description: >-
Service Management payload for allowing Kandji
Agent background processes to fully function
display_name: Kandji Agent Service Management
identifier: >-
com.kandji.profile.servicemanagement.3ebdc470-c9ec-4ae9-8148-91f977c4ab3d
organization: Kandji, Inc.
type: com.apple.servicemanagement
uuid: a9f53a12-0ab9-4876-bab0-b01f35b016d0
version: 1
- description: >-
Notifications payload for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.notifications.84cdf4c1-1588-4b2b-b919-f0131cfda81d
organization: Kandji, Inc.
type: com.apple.notificationsettings
uuid: f7cfda88-2aed-4e05-8f04-3c740deb009a
version: 1
- description: >-
Privacy controls for allowing Kandji to fully
function
identifier: >-
com.kandji.profile.pppc.33c775a5-de40-4701-b2c3-645c83a21d12
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: a540cff7-54aa-41c8-9537-5b8daad3413a
version: 1
profile_description: null
profile_display_name: Kandji Agent Settings
removable: false
removal_passcode: false
serial_number: Z6V0YW4M1C
signed: true
updated_at: '2023-12-24T04:50:42.531842+00:00'
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
encrypted: false
last_changed_at: null
last_collected_at: '2023-12-24T04:50:42.531638+00:00'
managed: true
model_id: null
organization: Kandji, Inc.
payload_identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e
payload_uuid: 3ad11b1e-42fb-4405-b826-c9cdf6061e7e
profile_data:
- display_name: pppc_finder
identifier: >-
com.kandji.profile.privacy.3ad11b1e-42fb-4405-b826-c9cdf6061e7e.39b51ba8-95ca-4b1d-9307-d2192a318bbc
organization: Kandji, Inc.
type: com.apple.TCC.configuration-profile-policy
uuid: c01c6848-d692-5be1-9a8e-76f0b0648d4c
version: 1
profile_description: null
profile_display_name: pppc_finder
removable: false
removal_passcode: false
serial_number: Z6V0YW4M1C
signed: true
updated_at: '2023-12-24T04:50:42.531638+00:00'
limit: 25
offset: null
total: 17
/api/v1/prism/kernel_extensions:
get:
tags:
- Prism
summary: Kernel Extensions
description: Get Kernel Extension attributes for macOS.
operationId: kernelExtensions
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
SON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success - no kernel extensions
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:29:39 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '94'
X-Kong-Upstream-Latency:
schema:
type: string
example: '126'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9992'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items: { }
example: [ ]
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 0
examples:
success - no kernel extensions:
value:
cursor: null
data: [ ]
limit: 25
offset: null
total: 0
/api/v1/prism/launch_agents_and_daemons:
get:
tags:
- Prism
summary: Launch Agents and Daemons
description: Get Launch Agents and Daemons installed on macOS.
operationId: launchAgentsAndDaemons
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:27:18 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '57'
X-Kong-Upstream-Latency:
schema:
type: string
example: '113'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9994'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
asset_tag:
type: string
nullable: true
example: send "this"
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled:
nullable: true
example: null
domain:
type: object
properties:
daemon:
type: object
properties: { }
system_agent:
type: object
properties:
disabled_users:
type: array
items: { }
example: [ ]
loaded_users:
type: array
items:
type: object
properties:
uid:
type: number
example: 501
username:
type: string
example: testuser
example:
- uid: 501
username: testuser
group_name:
nullable: true
example: null
is_disabled:
type: boolean
example: false
is_loaded:
type: boolean
example: true
keep_alive:
type: boolean
example: true
label:
type: string
example: io.kandji.Extension-Manager
path:
type: string
example: >-
/Library/LaunchAgents/io.kandji.Extension-Manager.plist
pid:
type: number
nullable: true
example: null
process_type:
type: string
nullable: true
example: null
program:
type: string
nullable: true
example: >-
/Applications/Utilities/Kandji Extension
Manager.app/Contents/MacOS/Kandji Extension Manager
program_arguments:
type: string
nullable: true
example: null
queue_directories:
nullable: true
example: null
root_directory:
nullable: true
example: null
run_at_load:
type: boolean
nullable: true
example: true
serial_number:
type: string
example: C02FL5YXQ6LC
standard_error_path:
nullable: true
example: null
standard_out_path:
nullable: true
example: null
start_interval:
nullable: true
example: null
start_on_mount:
nullable: true
example: null
user_name:
nullable: true
example: null
watch_paths:
nullable: true
example: null
working_directory:
nullable: true
example: null
example:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: testuser
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Extension-Manager
path: >-
/Library/LaunchAgents/io.kandji.Extension-Manager.plist
pid: null
process_type: null
program: >-
/Applications/Utilities/Kandji Extension
Manager.app/Contents/MacOS/Kandji Extension Manager
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: testuser
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Kandji
path: /Library/LaunchAgents/io.kandji.Kandji.plist
pid: null
process_type: null
program: >-
/Library/Application Support/Kandji/Kandji Menu/Kandji
Menu.app/Contents/MacOS/Kandji Menu
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-agent
path: /Library/LaunchDaemons/io.kandji.kandji-agent.plist
pid: 371
process_type: BACKGROUND
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-parameter-agent
queue_directories: null
root_directory: null
run_at_load: null
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.kandji-daemon
path: /Library/LaunchDaemons/io.kandji.kandji-daemon.plist
pid: 295
process_type: BACKGROUND
program: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-daemon
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-library-manager
path: >-
/Library/LaunchDaemons/io.kandji.kandji-library-manager.plist
pid: 754
process_type: BACKGROUND
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-library-manager
queue_directories: null
root_directory: null
run_at_load: null
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: anka
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Extension-Manager
path: >-
/Library/LaunchAgents/io.kandji.Extension-Manager.plist
pid: null
process_type: null
program: >-
/Applications/Utilities/Kandji Extension
Manager.app/Contents/MacOS/Kandji Extension Manager
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: anka
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Kandji
path: /Library/LaunchAgents/io.kandji.Kandji.plist
pid: null
process_type: null
program: >-
/Library/Application Support/Kandji/Kandji Menu/Kandji
Menu.app/Contents/MacOS/Kandji Menu
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-agent
path: /Library/LaunchDaemons/io.kandji.kandji-agent.plist
pid: 1517
process_type: BACKGROUND
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-parameter-agent
queue_directories: null
root_directory: null
run_at_load: null
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.kandji-daemon
path: /Library/LaunchDaemons/io.kandji.kandji-daemon.plist
pid: 1500
process_type: BACKGROUND
program: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-daemon
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-library-manager
path: >-
/Library/LaunchDaemons/io.kandji.kandji-library-manager.plist
pid: 1582
process_type: null
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-library-manager
queue_directories: null
root_directory: null
run_at_load: null
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 10
examples:
success:
value:
cursor: null
data:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: testuser
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Extension-Manager
path: >-
/Library/LaunchAgents/io.kandji.Extension-Manager.plist
pid: null
process_type: null
program: >-
/Applications/Utilities/Kandji Extension
Manager.app/Contents/MacOS/Kandji Extension Manager
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: testuser
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Kandji
path: /Library/LaunchAgents/io.kandji.Kandji.plist
pid: null
process_type: null
program: >-
/Library/Application Support/Kandji/Kandji Menu/Kandji
Menu.app/Contents/MacOS/Kandji Menu
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-agent
path: /Library/LaunchDaemons/io.kandji.kandji-agent.plist
pid: 371
process_type: BACKGROUND
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-parameter-agent
queue_directories: null
root_directory: null
run_at_load: null
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.kandji-daemon
path: /Library/LaunchDaemons/io.kandji.kandji-daemon.plist
pid: 295
process_type: BACKGROUND
program: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-daemon
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-library-manager
path: >-
/Library/LaunchDaemons/io.kandji.kandji-library-manager.plist
pid: 754
process_type: BACKGROUND
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-library-manager
queue_directories: null
root_directory: null
run_at_load: null
serial_number: C02FL5YXQ6LC
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: anka
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Extension-Manager
path: >-
/Library/LaunchAgents/io.kandji.Extension-Manager.plist
pid: null
process_type: null
program: >-
/Applications/Utilities/Kandji Extension
Manager.app/Contents/MacOS/Kandji Extension Manager
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
system_agent:
disabled_users: [ ]
loaded_users:
- uid: 501
username: anka
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.Kandji
path: /Library/LaunchAgents/io.kandji.Kandji.plist
pid: null
process_type: null
program: >-
/Library/Application Support/Kandji/Kandji Menu/Kandji
Menu.app/Contents/MacOS/Kandji Menu
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-agent
path: /Library/LaunchDaemons/io.kandji.kandji-agent.plist
pid: 1517
process_type: BACKGROUND
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-parameter-agent
queue_directories: null
root_directory: null
run_at_load: null
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: true
label: io.kandji.kandji-daemon
path: /Library/LaunchDaemons/io.kandji.kandji-daemon.plist
pid: 1500
process_type: BACKGROUND
program: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-daemon
program_arguments: null
queue_directories: null
root_directory: null
run_at_load: true
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
- asset_tag: null
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: 14_1_1_23B81_as_adcs_testing
device__user_email: [email protected]
device__user_id: '31239'
device__user_name: avenger admin
device_id: d6ac2d8c-3852-4dc1-afe7-d5a32306ee39
disabled: null
domain:
daemon: { }
group_name: null
is_disabled: false
is_loaded: true
keep_alive: false
label: io.kandji.kandji-library-manager
path: >-
/Library/LaunchDaemons/io.kandji.kandji-library-manager.plist
pid: 1582
process_type: null
program: null
program_arguments: >-
/Library/Kandji/Kandji
Agent.app/Contents/MacOS/kandji-library-manager
queue_directories: null
root_directory: null
run_at_load: null
serial_number: Z6V0YW4M1C
standard_error_path: null
standard_out_path: null
start_interval: null
start_on_mount: null
user_name: null
watch_paths: null
working_directory: null
limit: 25
offset: null
total: 10
/api/v1/prism/local_users:
get:
tags:
- Prism
summary: Local users
description: Get Local Users detials for macOS.
operationId: localUsers
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:30:49 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '110'
X-Kong-Upstream-Latency:
schema:
type: string
example: '171'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9990'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
type: string
example: NzgyZjQwNTQtYjk3MS00YmVjLTg1MGItN2JmMTNjZTgwNmZlfDc4
data:
type: array
items:
type: object
properties:
asset_tag:
type: string
example: send "this"
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
directory:
type: string
example: /Local/Default
failed_login_time:
nullable: true
example: null
failed_logins:
nullable: true
example: null
filevault_user:
type: boolean
example: false
full_name:
type: string
example: System Services
generated_uid:
type: string
example: FFFFEEEE-DDDD-CCCC-BBBB-AAAA00000001
hidden_user:
type: boolean
example: false
home_directory:
type: string
example: /var/root
home_folder_secure:
type: boolean
example: false
last_changed_at:
nullable: true
example: null
last_collected_at:
type: string
example: '2023-11-07T23:04:00.760995+00:00'
logged_in:
type: boolean
example: false
logged_in_time:
nullable: true
example: null
mobile_account:
type: boolean
example: false
model_id:
nullable: true
example: null
password_last_set:
nullable: true
example: null
secure_token:
nullable: true
example: null
serial_number:
type: string
example: C02FL5YXQ6LC
shell:
type: string
example: /usr/bin/false
type:
type: string
example: Standard
uid:
type: number
example: 1
updated_at:
type: string
example: '2023-11-07T23:04:00.760995+00:00'
user_created_at:
nullable: true
example: null
username:
type: string
example: daemon
volume_owner:
type: boolean
example: false
example:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
directory: /Local/Default
failed_login_time: null
failed_logins: null
filevault_user: false
full_name: System Services
generated_uid: FFFFEEEE-DDDD-CCCC-BBBB-AAAA00000001
hidden_user: false
home_directory: /var/root
home_folder_secure: false
last_changed_at: null
last_collected_at: '2023-11-07T23:04:00.760995+00:00'
logged_in: false
logged_in_time: null
mobile_account: false
model_id: null
password_last_set: null
secure_token: null
serial_number: C02FL5YXQ6LC
shell: /usr/bin/false
type: Standard
uid: 1
updated_at: '2023-11-07T23:04:00.760995+00:00'
user_created_at: null
username: daemon
volume_owner: false
limit:
type: number
example: 25
offset:
type: number
example: 0
total:
type: number
example: 117
examples:
success:
value:
cursor: NzgyZjQwNTQtYjk3MS00YmVjLTg1MGItN2JmMTNjZTgwNmZlfDc4
data:
- asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
directory: /Local/Default
failed_login_time: null
failed_logins: null
filevault_user: false
full_name: System Services
generated_uid: FFFFEEEE-DDDD-CCCC-BBBB-AAAA00000001
hidden_user: false
home_directory: /var/root
home_folder_secure: false
last_changed_at: null
last_collected_at: '2023-11-07T23:04:00.760995+00:00'
logged_in: false
logged_in_time: null
mobile_account: false
model_id: null
password_last_set: null
secure_token: null
serial_number: C02FL5YXQ6LC
shell: /usr/bin/false
type: Standard
uid: 1
updated_at: '2023-11-07T23:04:00.760995+00:00'
user_created_at: null
username: daemon
volume_owner: false
limit: 25
offset: 0
total: 117
/api/v1/prism/startup_settings:
get:
tags:
- Prism
summary: Startup settings
description: Get Startup settings for macOS.
operationId: startupSettings
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return
responses:
'200':
description: Startup settings
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:26:42 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '55'
X-Kong-Upstream-Latency:
schema:
type: string
example: '89'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9995'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
any_signed_os:
nullable: true
example: null
asset_tag:
nullable: true
example: null
blueprint_id:
type: string
example: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name:
type: string
example: Default Blueprint
bootstrap_token_auth:
type: boolean
example: false
bootstrap_token_escrowed:
type: boolean
example: true
device__family:
type: string
example: Mac
device__name:
type: string
example: as-dummy-vm-006
device__user_email:
type: string
example: [email protected]
device__user_id:
type: string
example: '31250'
device__user_name:
type: string
example: Miss Minutes
device_id:
type: string
example: 05319095-401f-42f4-8a3f-adda27d9830a
external_boot_level:
type: string
example: allowed
kext_requires_bst:
type: boolean
example: true
last_changed_at:
nullable: true
example: null
last_collected_at:
type: string
example: '2023-06-29T20:55:56.355941+00:00'
mdm_manages_kext:
nullable: true
example: null
model_id:
nullable: true
example: null
secure_boot_level:
type: string
example: 'off'
serial_number:
type: string
example: ZGFRNNQGQD
sip:
type: boolean
example: false
software_update_requires_bst:
type: boolean
example: true
ssv:
type: boolean
example: true
updated_at:
type: string
example: '2023-06-29T20:55:56.355941+00:00'
user_manages_kext:
nullable: true
example: null
example:
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: false
bootstrap_token_escrowed: true
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-29T20:55:56.355941+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: 'off'
serial_number: ZGFRNNQGQD
sip: false
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-29T20:55:56.355941+00:00'
user_manages_kext: null
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: true
bootstrap_token_escrowed: true
device__family: Mac
device__name: testuser’s MacBook Air
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 1bd3ba52-2e39-4099-8a8d-0e55ec4a4fcd
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-26T20:01:29.310804+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: full
serial_number: FVHHFKF7Q6L4
sip: true
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-26T20:01:29.310804+00:00'
user_manages_kext: null
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 9
examples:
Startup settings:
value:
cursor: null
data:
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: false
bootstrap_token_escrowed: true
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-29T20:55:56.355941+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: 'off'
serial_number: ZGFRNNQGQD
sip: false
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-29T20:55:56.355941+00:00'
user_manages_kext: null
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: true
bootstrap_token_escrowed: true
device__family: Mac
device__name: testuser’s MacBook Air
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 1bd3ba52-2e39-4099-8a8d-0e55ec4a4fcd
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-26T20:01:29.310804+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: full
serial_number: FVHHFKF7Q6L4
sip: true
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-26T20:01:29.310804+00:00'
user_manages_kext: null
limit: 25
offset: null
total: 9
/api/v1/prism/system_extensions:
get:
tags:
- Prism
summary: System Extensions
description: Get System Extension attributes for macOS.
operationId: systemExtensions
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: System Extensions
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:29:04 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '80'
X-Kong-Upstream-Latency:
schema:
type: string
example: '192'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9993'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
any_signed_os:
nullable: true
example: null
asset_tag:
nullable: true
example: null
blueprint_id:
type: string
example: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name:
type: string
example: Default Blueprint
bootstrap_token_auth:
type: boolean
example: false
bootstrap_token_escrowed:
type: boolean
example: true
device__family:
type: string
example: Mac
device__name:
type: string
example: as-dummy-vm-006
device__user_email:
type: string
example: [email protected]
device__user_id:
type: string
example: '31250'
device__user_name:
type: string
example: Miss Minutes
device_id:
type: string
example: 05319095-401f-42f4-8a3f-adda27d9830a
external_boot_level:
type: string
example: allowed
kext_requires_bst:
type: boolean
example: true
last_changed_at:
nullable: true
example: null
last_collected_at:
type: string
example: '2023-06-29T20:55:56.355941+00:00'
mdm_manages_kext:
nullable: true
example: null
model_id:
nullable: true
example: null
secure_boot_level:
type: string
example: 'off'
serial_number:
type: string
example: ZGFRNNQGQD
sip:
type: boolean
example: false
software_update_requires_bst:
type: boolean
example: true
ssv:
type: boolean
example: true
updated_at:
type: string
example: '2023-06-29T20:55:56.355941+00:00'
user_manages_kext:
nullable: true
example: null
example:
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: false
bootstrap_token_escrowed: true
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-29T20:55:56.355941+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: 'off'
serial_number: ZGFRNNQGQD
sip: false
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-29T20:55:56.355941+00:00'
user_manages_kext: null
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: true
bootstrap_token_escrowed: true
device__family: Mac
device__name: testuser’s MacBook Air
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 1bd3ba52-2e39-4099-8a8d-0e55ec4a4fcd
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-26T20:01:29.310804+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: full
serial_number: FVHHFKF7Q6L4
sip: true
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-26T20:01:29.310804+00:00'
user_manages_kext: null
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 9
examples:
System Extensions:
value:
cursor: null
data:
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: false
bootstrap_token_escrowed: true
device__family: Mac
device__name: as-dummy-vm-006
device__user_email: [email protected]
device__user_id: '31250'
device__user_name: Miss Minutes
device_id: 05319095-401f-42f4-8a3f-adda27d9830a
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-29T20:55:56.355941+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: 'off'
serial_number: ZGFRNNQGQD
sip: false
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-29T20:55:56.355941+00:00'
user_manages_kext: null
- any_signed_os: null
asset_tag: null
blueprint_id: accceac3-d3ee-4277-943e-9f5b52bc9d05
blueprint_name: Default Blueprint
bootstrap_token_auth: true
bootstrap_token_escrowed: true
device__family: Mac
device__name: testuser’s MacBook Air
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 1bd3ba52-2e39-4099-8a8d-0e55ec4a4fcd
external_boot_level: allowed
kext_requires_bst: true
last_changed_at: null
last_collected_at: '2023-06-26T20:01:29.310804+00:00'
mdm_manages_kext: null
model_id: null
secure_boot_level: full
serial_number: FVHHFKF7Q6L4
sip: true
software_update_requires_bst: true
ssv: true
updated_at: '2023-06-26T20:01:29.310804+00:00'
user_manages_kext: null
limit: 25
offset: null
total: 9
/api/v1/prism/transparency_database:
get:
tags:
- Prism
summary: Transparency database
description: Get Transparency Database (TCC) attributes for macOS.
operationId: transparencyDatabase
parameters:
- name: blueprint_ids
in: query
schema:
type: string
example: blueprint_id, blueprint_id,blueprint_id
description: Filter results by one or more blueprint IDs separated by commas.
- name: device_families
in: query
schema:
type: string
example: Mac,iPhone,iPad,tvOS
description: Filter results by one or more device families separate by commas.
- name: filter
in: query
schema:
type: string
example: ''
description: >-
JSON schema object containing one or more key value pairs.
Note: For detailed information on fiters, see the Filters section at
the begining of the Visibility API endpoints in this doc.
- name: sort_by
in: query
schema:
type: string
example: ''
description: >-
Sort results by the name of a given response body key in either
ascending (default behavior) or descending(`-`) order.
- name: limit
in: query
schema:
type: string
example: ''
description: >-
A hard upper `limit` is set at 300 device records returned per
request. If more device records are expected, pagination should be
used using the `limit` and `offset` parameters. Additionally,
parameter queries can be added to a request to limit the results.
- name: offset
in: query
schema:
type: string
example: ''
description: Specify the starting record to return.
responses:
'200':
description: Transparency database
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 18 Sep 2023 17:29:47 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '82'
X-Kong-Upstream-Latency:
schema:
type: string
example: '121'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9991'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
cursor:
nullable: true
example: null
data:
type: array
items:
type: object
properties:
application:
type: string
example: com.apple.screensharing.agent
asset_tag:
type: string
example: send "this"
blueprint_id:
type: string
example: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name:
type: string
example: _testing_something
client_type:
type: string
example: Bundle Identifier
device__family:
type: string
example: Mac
device__name:
type: string
example: test_from_api
device__user_email:
type: string
example: ''
device__user_id:
type: string
example: ''
device__user_name:
type: string
example: ''
device_id:
type: string
example: 782f4054-b971-4bec-850b-7bf13ce806fe
last_modified:
type: string
example: '2023-09-22T09:32:24.000053+00:00'
local_user:
nullable: true
example: null
serial_number:
type: string
example: C02FL5YXQ6LC
service:
type: string
example: PostEvent
status:
type: string
example: Allowed
status_reason:
type: string
example: System Set
updated_at:
type: string
example: '2023-11-08T16:19:01.798865+00:00'
example:
- application: com.apple.screensharing.agent
asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
client_type: Bundle Identifier
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_modified: '2023-09-22T09:32:24.000053+00:00'
local_user: null
serial_number: C02FL5YXQ6LC
service: PostEvent
status: Allowed
status_reason: System Set
updated_at: '2023-11-08T16:19:01.798865+00:00'
- application: com.apple.screensharing.agent
asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
client_type: Bundle Identifier
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_modified: '2023-09-22T09:32:24.000053+00:00'
local_user: null
serial_number: C02FL5YXQ6LC
service: ScreenCapture
status: Allowed
status_reason: System Set
updated_at: '2023-11-08T16:19:01.040860+00:00'
limit:
type: number
example: 25
offset:
nullable: true
example: null
total:
type: number
example: 8
examples:
Transparency database:
value:
cursor: null
data:
- application: com.apple.screensharing.agent
asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
client_type: Bundle Identifier
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_modified: '2023-09-22T09:32:24.000053+00:00'
local_user: null
serial_number: C02FL5YXQ6LC
service: PostEvent
status: Allowed
status_reason: System Set
updated_at: '2023-11-08T16:19:01.798865+00:00'
- application: com.apple.screensharing.agent
asset_tag: send "this"
blueprint_id: 9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc
blueprint_name: _testing_something
client_type: Bundle Identifier
device__family: Mac
device__name: test_from_api
device__user_email: ''
device__user_id: ''
device__user_name: ''
device_id: 782f4054-b971-4bec-850b-7bf13ce806fe
last_modified: '2023-09-22T09:32:24.000053+00:00'
local_user: null
serial_number: C02FL5YXQ6LC
service: ScreenCapture
status: Allowed
status_reason: System Set
updated_at: '2023-11-08T16:19:01.040860+00:00'
limit: 25
offset: null
total: 8
/api/v1/prism/export:
post:
tags:
- Prism
summary: Request category export
description: >-
Request export of a category. The `id` key is used when checking the
export status using the _Request category export_ endpoint.
**Request Body Parameters: application/json**
| Key | Type | Possible value(s) | Description |
| --- | --- | --- | --- |
| `blueprint_ids` | `array` | `["string", "string", "string"]` | List of
one or more comma separate blueprint IDs. |
| `category` | `string` | `apps` ,
`activation_lock` ,
`desktop_and_screensaver` ,
`device_information` ,
`gatekeeper_and_xprotect` ,
`installed_profiles` ,
`kernel_extensions` ,
`local_users` ,
`launch_agents_and_daemons` ,
`system_extensions` ,
`startup_settings` ,
`transparency_database` | Only one
category per export reqest. |
| `device_families` | `array` | `["Mac", "iPhone", "iPad", "tvOS"]` |
List of one or more comma separted string values for device families. |
| `filter` | `object` | `{"apple_silicon": {"eq": true}, "device__name":
{"like": ["this", "or_this"]}}` | JSON schema object containing one or
more key value pairs.
**Note**: For detailed information on
fiters, see the Filters section at the begining of the Visibility API
endpoints in this doc. |
| `sort_by` | `string` | | Sort results by the name of a given response
body key in either ascending (default behavior) or descending(\`-\`)
order. |
operationId: requestCategoryExport
requestBody:
content:
application/json:
schema:
type: object
properties:
blueprint_ids:
type: array
items: { }
example: [ ]
category:
type: string
example: application_firewal
device_families:
type: array
items: { }
example: [ ]
filter:
type: object
properties: { }
sort_by:
type: string
example: ''
examples:
Request category export:
value:
blueprint_ids: [ ]
category: application_firewal
device_families: [ ]
filter: { }
sort_by: ''
responses:
'200':
description: >-
success / Mac device info sorted by device name / Device info for
all iPads
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Fri, 15 Sep 2023 17:26:33 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '48'
X-Kong-Upstream-Latency:
schema:
type: string
example: '36'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9987'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
args:
type: object
properties:
blueprint_ids:
type: array
items: { }
example: [ ]
columns:
type: array
items: { }
example: [ ]
device_families:
type: array
items: { }
example: [ ]
filter:
type: object
properties: { }
sort_by:
type: string
example: ''
category:
type: string
example: apps
created_at:
type: string
example: '2023-09-14T20:57:59.298293+00:00'
error_msg:
nullable: true
example: null
id:
type: string
example: 64cb5d3d-b180-4847-8b8a-34b14d8bc8d9
path:
nullable: true
example: null
signed_url:
nullable: true
example: null
status:
type: string
example: pending
updated_at:
type: string
example: '2023-09-14T20:57:59.298293+00:00'
examples:
Device info for all iPads:
value:
args:
blueprint_ids: [ ]
columns: [ ]
device_families:
- iPad
filter: { }
sort_by: ''
category: device_information
created_at: '2023-09-15T17:26:33.578350+00:00'
error_msg: null
id: 7573767f-161e-4fc4-8b5a-7bad6e9599e8
path: null
signed_url: null
status: pending
updated_at: '2023-09-15T17:26:33.578350+00:00'
Mac device info sorted by device name:
value:
args:
blueprint_ids: [ ]
columns: [ ]
device_families:
- Mac
filter: { }
sort_by: device__name
category: device_information
created_at: '2023-09-15T20:06:52.285122+00:00'
error_msg: null
id: 3d8ce17d-8477-488f-9b7a-18df03a33b61
path: null
signed_url: null
status: pending
updated_at: '2023-09-15T20:06:52.285122+00:00'
success:
value:
args:
blueprint_ids: [ ]
columns: [ ]
device_families: [ ]
filter: { }
sort_by: ''
category: apps
created_at: '2023-09-14T20:57:59.298293+00:00'
error_msg: null
id: 64cb5d3d-b180-4847-8b8a-34b14d8bc8d9
path: null
signed_url: null
status: pending
updated_at: '2023-09-14T20:57:59.298293+00:00'
'400':
description: Bad category request
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '50'
Date:
schema:
type: string
example: Fri, 15 Sep 2023 15:42:58 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '29'
X-Kong-Upstream-Latency:
schema:
type: string
example: '33'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9997'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
detail:
type: string
example: 'Invalid category: application_firewal'
examples:
Bad category request:
value:
detail: 'Invalid category: application_firewal'
/api/v1/prism/export/{export_id}:
get:
tags:
- Prism
summary: Get category export
description: >-
Get an export request's status. To download the export, use the
`signed_url`. This will download a CSV file containing the exported
category information.
### Request Parameters
export_id (path parameter): The unique identifier of the the export job.
operationId: getCategoryExport
responses:
'200':
description: Example export status check
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Thu, 14 Sep 2023 20:58:48 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '92'
X-Kong-Upstream-Latency:
schema:
type: string
example: '132'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9986'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
args:
type: object
properties:
blueprint_ids:
type: array
items: { }
example: [ ]
columns:
type: array
items: { }
example: [ ]
device_families:
type: array
items: { }
example: [ ]
filter:
type: object
properties: { }
sort_by:
type: string
example: ''
category:
type: string
example: apps
created_at:
type: string
example: '2023-09-14T20:57:59.298293+00:00'
error_msg:
nullable: true
example: null
id:
type: string
example: 64cb5d3d-b180-4847-8b8a-34b14d8bc8d9
path:
type: string
example: >-
visibility-export-dev/28344fcc-579a-4d42-bcf7-cdbf97585066/export-2023-09-14-apps-64cb5d3d-b180-4847-8b8a-34b14d8bc8d9.csv
signed_url:
type: string
example: >-
https://amazonaws.com/28344fcc-579a-4d42-bcf7-cdbf97585066/export-2023-09-14-apps-64cb5d3d-b180-4847-8b8a-34b14d8bc8d9.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIASFTUYWXKYCKI2RPA%2F20230914%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230914T205848Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEGUaCXVzLXdlc3QtMiJIMEYCIQD0Dnaf2gYxvGQXoouHEXGvIYwTOBzF5o5wFKFZwdNekAIhAIuzzarePTLat3Bb8Sof1ihyivS2dQHDWW5L7nUEhAHCKv8ECE4QAxoMMTQ5NDk1MDAyNTgxIgzdFKz6tJU%2BiEwY%2BBEq3ASeotuDFH3Ta%2F8hN34J%2BJjR3xGfmeh8N2c9mwJpWoOWrnVJ0he9aJL44C8tBnm%2FWfRbR3Co%2B9a5f2%2BlH83P83CoEij%2FIRX7XJ3qjpt2LYxZ4GOoME%2FSNP2cno3LMWGnOev5yctX2VkSFo8nVuB0r5a85SUxZq9ZkCiJ9DwYaArcKc5kmGjQ7dtZE3PM0oT4lyHiap5Qupn08ZYpPrAHZP%2BGooCn377hHwQfqAeWT%2BzT%2FLagR%2FGWWWNlaAEMGIkiso0rULgPAZ9tNxDbxTwBoitq0bTXed2wuMHtpiWiUEbs4MLkJh%2B6VbxO58hKFLOapuoKeOS%2FKZsc63Ohi2%2B7s%2BhIAe2cx%2BhzUi%2BQSIDn2RLAXGq0HOF5KWaXKVgGsRDXPGXoXCeiOljgcbPncnl0yEsaRkRitRjA7OJmcfeQc5vSpiGX0NkEOhnPHITtlg4ZEF7q1FG5gT92HLI0feuSwbP45e2o82Uod51lrQWpkaj5E3dCL1i0c5wdc4Um0HqTkXvBTy0wn%2BrMm%2FmbbFP0sA3i5c%2FM0tCHKQ9MKR2C5fI0zgCsT8MZc0c5AtFB76EuOk4xnSdWMlis4ISDF312vbxa6648QVknopJe9J1p8Huc%2FOaJxp0SmUw1a7X5yjlkyeDkol9WyObC8R%2BwA5%2BgxLQyhCE8odmr0LbD0D0xTKSshHYbH71uLWMbnn0HChkQGoqbDcohIxEkxePjF0VFYDizUKfEjgvom%2F6AvJeAe4yIJzgXxAa7DvkwCHE0nLxfioVc6FdinZ3jwvs2pnCYK8qjvU7kjObReYgubBUhMIjojagGOpkBY%2BVVHQWBiKn1ZlgcWyC3ufoMTo75qiz4P0mlvsc%2FLlPei0V5jZVga0KzA%2Bz5lz6JmKaDwww65fFRwVtoz1X7zD6L4HKWQ086EbvJGTjbQtuVfUrDtYHCfVkQfHOF%2Fo9gLXZ5ul7B35Uz7jmvLsf0VfsRxgqVSSI9glVkolZuvwAqwjkezmOBqGkTNxxtBKe8olNGd1Intj8l&X-Amz-Signature=4ad3bea9b06aacc6fe78657e86d80a24cadbc6866bb365d1b8fd8235ccc39020
status:
type: string
example: success
updated_at:
type: string
example: '2023-09-14T20:58:00.341603+00:00'
examples:
Example export status check:
value:
args:
blueprint_ids: [ ]
columns: [ ]
device_families: [ ]
filter: { }
sort_by: ''
category: apps
created_at: '2023-09-14T20:57:59.298293+00:00'
error_msg: null
id: 64cb5d3d-b180-4847-8b8a-34b14d8bc8d9
path: >-
visibility-export-dev/28344fcc-579a-4d42-bcf7-cdbf97585066/export-2023-09-14-apps-64cb5d3d-b180-4847-8b8a-34b14d8bc8d9.csv
signed_url: >-
https://amazonaws.com/28344fcc-579a-4d42-bcf7-cdbf97585066/export-2023-09-14-apps-64cb5d3d-b180-4847-8b8a-34b14d8bc8d9.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIASFTUYWXKYCKI2RPA%2F20230914%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230914T205848Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEGUaCXVzLXdlc3QtMiJIMEYCIQD0Dnaf2gYxvGQXoouHEXGvIYwTOBzF5o5wFKFZwdNekAIhAIuzzarePTLat3Bb8Sof1ihyivS2dQHDWW5L7nUEhAHCKv8ECE4QAxoMMTQ5NDk1MDAyNTgxIgzdFKz6tJU%2BiEwY%2BBEq3ASeotuDFH3Ta%2F8hN34J%2BJjR3xGfmeh8N2c9mwJpWoOWrnVJ0he9aJL44C8tBnm%2FWfRbR3Co%2B9a5f2%2BlH83P83CoEij%2FIRX7XJ3qjpt2LYxZ4GOoME%2FSNP2cno3LMWGnOev5yctX2VkSFo8nVuB0r5a85SUxZq9ZkCiJ9DwYaArcKc5kmGjQ7dtZE3PM0oT4lyHiap5Qupn08ZYpPrAHZP%2BGooCn377hHwQfqAeWT%2BzT%2FLagR%2FGWWWNlaAEMGIkiso0rULgPAZ9tNxDbxTwBoitq0bTXed2wuMHtpiWiUEbs4MLkJh%2B6VbxO58hKFLOapuoKeOS%2FKZsc63Ohi2%2B7s%2BhIAe2cx%2BhzUi%2BQSIDn2RLAXGq0HOF5KWaXKVgGsRDXPGXoXCeiOljgcbPncnl0yEsaRkRitRjA7OJmcfeQc5vSpiGX0NkEOhnPHITtlg4ZEF7q1FG5gT92HLI0feuSwbP45e2o82Uod51lrQWpkaj5E3dCL1i0c5wdc4Um0HqTkXvBTy0wn%2BrMm%2FmbbFP0sA3i5c%2FM0tCHKQ9MKR2C5fI0zgCsT8MZc0c5AtFB76EuOk4xnSdWMlis4ISDF312vbxa6648QVknopJe9J1p8Huc%2FOaJxp0SmUw1a7X5yjlkyeDkol9WyObC8R%2BwA5%2BgxLQyhCE8odmr0LbD0D0xTKSshHYbH71uLWMbnn0HChkQGoqbDcohIxEkxePjF0VFYDizUKfEjgvom%2F6AvJeAe4yIJzgXxAa7DvkwCHE0nLxfioVc6FdinZ3jwvs2pnCYK8qjvU7kjObReYgubBUhMIjojagGOpkBY%2BVVHQWBiKn1ZlgcWyC3ufoMTo75qiz4P0mlvsc%2FLlPei0V5jZVga0KzA%2Bz5lz6JmKaDwww65fFRwVtoz1X7zD6L4HKWQ086EbvJGTjbQtuVfUrDtYHCfVkQfHOF%2Fo9gLXZ5ul7B35Uz7jmvLsf0VfsRxgqVSSI9glVkolZuvwAqwjkezmOBqGkTNxxtBKe8olNGd1Intj8l&X-Amz-Signature=4ad3bea9b06aacc6fe78657e86d80a24cadbc6866bb365d1b8fd8235ccc39020
status: success
updated_at: '2023-09-14T20:58:00.341603+00:00'
parameters:
- name: export_id
in: path
required: true
schema:
type: string
/api/v1/prism/count:
get:
tags:
- Prism
summary: Count
description: >-
Get the total record count for the specified Prism category.
If a category contains spaces substitute the spaces for underscores
("_") when using the API query.
Example: `Device information` becomes `device_information`.
operationId: count
parameters:
- name: category
in: query
schema:
type: string
example: apps
description: >-
Return the count of records for the specified category.
If a category contains spaces substitute the spaces for underscores
("_") when using the API query.
Examples:
apps
device_information
kernel_extensions
system_extensions
responses:
'200':
description: success
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Thu, 14 Sep 2023 20:58:48 GMT
Ratelimit-Limit:
schema:
type: string
example: '50'
Ratelimit-Remaining:
schema:
type: string
example: '49'
Ratelimit-Reset:
schema:
type: string
example: '1'
Server:
schema:
type: string
example: uvicorn
Transfer-Encoding:
schema:
type: string
example: chunked
Via:
schema:
type: string
example: kong/3.2.2
X-Kong-Proxy-Latency:
schema:
type: string
example: '92'
X-Kong-Upstream-Latency:
schema:
type: string
example: '132'
X-Ratelimit-Limit-Hour:
schema:
type: string
example: '10000'
X-Ratelimit-Limit-Second:
schema:
type: string
example: '50'
X-Ratelimit-Remaining-Hour:
schema:
type: string
example: '9986'
X-Ratelimit-Remaining-Second:
schema:
type: string
example: '49'
content:
application/json:
schema:
type: object
properties:
approximate:
type: boolean
example: false
count:
type: number
example: 3
examples:
success:
value:
approximate: false
count: 3
/api/v1/tags:
get:
tags:
- Tags
summary: Get Tags
description: Return configured tags.
operationId: getTags
responses:
'200':
description: success
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 2
next:
nullable: true
example: null
previous:
nullable: true
example: null
results:
type: array
items:
type: object
properties:
id:
type: string
example: 71dd53f1-104e-41a2-82ca-43a375b7f63d
name:
type: string
example: accuhive_01
example:
- id: 71dd53f1-104e-41a2-82ca-43a375b7f63d
name: accuhive_01
- id: 4fe23c39-7a9a-435c-bab3-d2e9fd1974c6
name: accuhive_02
examples:
success:
value:
count: 2
next: null
previous: null
results:
- id: 71dd53f1-104e-41a2-82ca-43a375b7f63d
name: accuhive_01
- id: 4fe23c39-7a9a-435c-bab3-d2e9fd1974c6
name: accuhive_02
post:
tags:
- Tags
summary: Create Tag
description: Create a tag. Can only create one tag per request.
operationId: createTag
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: accuhive_01
examples:
Create Tag:
value:
name: accuhive_01
responses:
'201':
description: success
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 1467cc35-39e3-435d-8816-34c849c15bc3
name:
type: string
example: accuhive_01
examples:
success:
value:
id: 1467cc35-39e3-435d-8816-34c849c15bc3
name: accuhive_01
/api/v1/tags/{tag_id}:
delete:
tags:
- Tags
summary: Delete Tag
description: |-
Delete a tag.
### Request Parameters
`tag_id` (path parameter): The unique identifier of the tag.
operationId: deleteTag
responses:
'204':
description: success
content: { }
patch:
tags:
- Tags
summary: Update Tag
description: |-
Update tag name.
### Request Parameters
`tag_id` (path parameter): The unique identifier of the tag.
operationId: updateTag
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: accuhive_02
examples:
Update Tag:
value:
name: accuhive_02
responses:
'200':
description: success
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 4fe23c39-7a9a-435c-bab3-d2e9fd1974c6
name:
type: string
example: accuhive_02
examples:
success:
value:
id: 4fe23c39-7a9a-435c-bab3-d2e9fd1974c6
name: accuhive_02
parameters:
- name: tag_id
in: path
required: true
schema:
type: string
/api/v1/threat-details:
get:
tags:
- Threats
summary: Get Threat Details
description: Get threat details.
operationId: getThreatDetails
parameters:
- name: classification
in: query
schema:
type: string
example: malware
description: >-
Return all records matching a specified classification. The
following classification options are available: `malware` and `pup`.
Leave this parameter empty to return all classification types.
- name: date_range
in: query
schema:
type: string
example: '7'
description: >-
Return all records within a specified number of days. Any positive
number of days may be specified. Examples: `7`, `30`, `60`, `90`,
`180`, or `365`.
- name: device_id
in: query
schema:
type: string
example: 15fcec08-xxxx-xxxx-xxxx-7c2f950910eb
- name: status
in: query
schema:
type: string
example: quarantined
description: >-
Return all records matching a specified status. The following status
options are available: `quarantined`, `not_quarantined`, or
`released`. Leave this parameter empty to return all status types.
- name: sort_by
in: query
schema:
type: string
example: status
description: >-
Results can be sorted with the following options:
- threat_name
- classification
- device_name
- process_name
- process_owner
- detection_date
- status
Prepending a dash (-) to the parameter value will reverse the order
of the returned results.
`?sort_by=-device_name` will order the response by device_name in
descending order.
- name: term
in: query
schema:
type: string
example: Chrome
description: >-
Search term to filter threat results.
The response will include anything matching the following fields:
`device_name`, `file_hash`, and `file_path`.
So if you search for `bad file`, the results will include anywhere
`bad file` exists in the three fields above.
- name: limit
in: query
schema:
type: string
example: '1000'
description: >-
A hard upper `limit` is set at 1000 records returned per request. If
more records are expected, pagination should be used using the
`limit` and `offset` parameters.
Additionally, parameter queries can be added to a request to limit
the results.
- name: offset
in: query
schema:
type: string
example: '1'
description: Specify the starting record to return
responses:
'200':
description: Get all details
content:
application/json:
schema:
type: object
properties:
count:
type: number
example: 24
malware_count:
type: number
example: 24
next:
nullable: true
example: null
previous:
nullable: true
example: null
pup_count:
type: number
example: 0
results:
type: array
items:
type: object
properties:
blueprint_id:
type: string
nullable: true
example: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name:
type: string
nullable: true
example: Threat
bundle_path:
type: string
example: ''
classification:
type: string
example: MALWARE
date_of_quarantine:
type: string
example: '2023-04-21T17:23:15.071621'
date_of_release:
type: string
example: ''
detection_date:
type: string
example: '2023-04-21T17:23:13.883134'
device_id:
type: string
example: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name:
type: string
example: accuhive MacBook Air
device_serial_number:
type: string
nullable: true
example: FVFGHGK7Q6L7
file_hash:
type: string
example: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path:
type: string
example: /Users/Shared/malware/malware_5
library_item_id:
type: string
nullable: true
example: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name:
type: string
nullable: true
example: Avert
malware_posture:
type: string
nullable: true
example: protect
process_name:
type: string
example: chmod
process_owner:
type: string
example: root
pup_posture:
type: string
nullable: true
example: protect
release_note:
type: string
example: ''
released_by:
type: string
example: ''
status:
type: string
example: QUARANTINED
threat_name:
type: string
example: malware_5
example:
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.071621'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.883134'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path: /Users/Shared/malware/malware_5
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_5
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.087263'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.949864'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: /private/var/tmp/malware_7
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_7
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.045619'
date_of_release: ''
detection_date: '2023-04-21T17:23:14.007637'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: /Users/Shared/malware/malware_9
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_9
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.652327'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.978747'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: /usr/local/malware/malware_8
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_8
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.078983'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.761933'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: /private/var/tmp/malware_2
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_2
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.722257'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.726685'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: /usr/local/malware/malware_1
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_1
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.799373'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.801138'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: /Library/Application Support/malware/malware_3
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_3
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.917928'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.843484'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
39ccf91f05ec1d65eea4aa73fc92e964da5fb4b519cb480136f993f195441de6
file_path: /usr/local/malware/malware_4
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_4
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.930625'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.915963'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: >-
/Library/User
Template/Non_localized/Documents/malware/malware_6
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_6
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.259792'
date_of_release: ''
detection_date: '2023-04-21T17:23:14.034193'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: /opt/malware/malware_10
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_10
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.377471'
date_of_release: ''
detection_date: '2023-04-21T17:23:14.061874'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
39ccf91f05ec1d65eea4aa73fc92e964da5fb4b519cb480136f993f195441de6
file_path: /private/var/tmp/malware_11
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_11
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T18:22:02.214529'
date_of_release: ''
detection_date: '2023-04-21T18:15:35.602935'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
file_path: >-
/Users/accuhive/Downloads/MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: sharingd
process_owner: accuhive
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: >-
MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T18:22:02.540836'
date_of_release: ''
detection_date: '2023-04-21T18:16:17.235154'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
file_path: >-
/Users/accuhive/Downloads/MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
2
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: sharingd
process_owner: accuhive
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: >-
MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
2
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T18:22:03.793995'
date_of_release: ''
detection_date: '2023-04-21T18:22:02.957250'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
file_path: >-
/Users/accuhive/Downloads/MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
3
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: sharingd
process_owner: accuhive
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: >-
MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
3
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.656343'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.658650'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/Resources/MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
library_item_id: null
library_item_name: null
malware_posture: null
process_name: AUHelperService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.658314'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/Resources/MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.655754'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/Resources/MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.894607'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/Resources/MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.657322'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
43e79ed204e46336e858e4504e70b9d4e0e95dd194fcb080d65daf7addfb0322
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/MacOS/BBEdit - Infected Mult
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: BBEdit - Infected Mult
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.893274'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
43e79ed204e46336e858e4504e70b9d4e0e95dd194fcb080d65daf7addfb0322
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/MacOS/BBEdit - Infected Mult
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: BBEdit - Infected Mult
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.893861'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/Resources/MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.895131'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/Resources/MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.894094'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
examples:
Get all details:
value:
count: 24
malware_count: 24
next: null
previous: null
pup_count: 0
results:
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.071621'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.883134'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path: /Users/Shared/malware/malware_5
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_5
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.087263'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.949864'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: /private/var/tmp/malware_7
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_7
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.045619'
date_of_release: ''
detection_date: '2023-04-21T17:23:14.007637'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: /Users/Shared/malware/malware_9
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_9
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.652327'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.978747'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: /usr/local/malware/malware_8
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_8
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.078983'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.761933'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: /private/var/tmp/malware_2
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_2
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.722257'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.726685'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: /usr/local/malware/malware_1
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_1
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.799373'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.801138'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: /Library/Application Support/malware/malware_3
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_3
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.917928'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.843484'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
39ccf91f05ec1d65eea4aa73fc92e964da5fb4b519cb480136f993f195441de6
file_path: /usr/local/malware/malware_4
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_4
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:14.930625'
date_of_release: ''
detection_date: '2023-04-21T17:23:13.915963'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: >-
/Library/User
Template/Non_localized/Documents/malware/malware_6
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_6
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.259792'
date_of_release: ''
detection_date: '2023-04-21T17:23:14.034193'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: /opt/malware/malware_10
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_10
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T17:23:15.377471'
date_of_release: ''
detection_date: '2023-04-21T17:23:14.061874'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
39ccf91f05ec1d65eea4aa73fc92e964da5fb4b519cb480136f993f195441de6
file_path: /private/var/tmp/malware_11
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: chmod
process_owner: root
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: malware_11
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T18:22:02.214529'
date_of_release: ''
detection_date: '2023-04-21T18:15:35.602935'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
file_path: >-
/Users/accuhive/Downloads/MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: sharingd
process_owner: accuhive
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: >-
MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T18:22:02.540836'
date_of_release: ''
detection_date: '2023-04-21T18:16:17.235154'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
file_path: >-
/Users/accuhive/Downloads/MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
2
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: sharingd
process_owner: accuhive
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: >-
MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
2
- blueprint_id: 396cdae2-147e-4e61-8a27-2f6b6963da4f
blueprint_name: Threat
bundle_path: ''
classification: MALWARE
date_of_quarantine: '2023-04-21T18:22:03.793995'
date_of_release: ''
detection_date: '2023-04-21T18:22:02.957250'
device_id: df1badd0-1dc9-448b-9b2a-c614a844c69e
device_name: accuhive MacBook Air
device_serial_number: FVFGHGK7Q6L7
file_hash: >-
0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
file_path: >-
/Users/accuhive/Downloads/MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
3
library_item_id: d0afe50a-1102-4568-86ed-44863b757c85
library_item_name: Avert
malware_posture: protect
process_name: sharingd
process_owner: accuhive
pup_posture: protect
release_note: ''
released_by: ''
status: QUARANTINED
threat_name: >-
MAL_0bdc0e03172658659be64a956ca44ba5a0ac5f9cdb607c0ef40b0539d3032880
3
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.656343'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.658650'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/Resources/MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
library_item_id: null
library_item_name: null
malware_posture: null
process_name: AUHelperService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.658314'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/Resources/MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.655754'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/Resources/MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.894607'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/Resources/MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_9285f0109c432de9e67c60c1c5288b03fea6ac7a385681ad9f260ed77fb653aa
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.657322'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
43e79ed204e46336e858e4504e70b9d4e0e95dd194fcb080d65daf7addfb0322
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected Mult
2.app/Contents/MacOS/BBEdit - Infected Mult
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: BBEdit - Infected Mult
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.893274'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
43e79ed204e46336e858e4504e70b9d4e0e95dd194fcb080d65daf7addfb0322
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/MacOS/BBEdit - Infected Mult
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: BBEdit - Infected Mult
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.893861'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/Resources/MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_721ef7dc906eeb7f4d21b55384e86c074bcb453a8eaa8f3d17568e77b87a916d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.895131'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/Resources/MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_64300d82ae001fd539754e1e9bb9009660ac774bff766231a642bc7924ea584d
- blueprint_id: null
blueprint_name: null
bundle_path: ''
classification: MALWARE
date_of_quarantine: ''
date_of_release: ''
detection_date: '2023-04-06T15:02:55.894094'
device_id: c166d14c-4595-48ce-bf4c-b4644aedaba1
device_name: ''
device_serial_number: null
file_hash: >-
2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
file_path: >-
/Users/accuhive/.Trash/BBEdit - Infected
Mult.app/Contents/MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
library_item_id: null
library_item_name: null
malware_posture: null
process_name: ArchiveService
process_owner: accuhive
pup_posture: null
release_note: ''
released_by: ''
status: NOT_QUARANTINED
threat_name: >-
MAL_2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
security:
- bearerAuth: [ ]
tags:
- name: Automated Device Enrollment integrations
description: Use these endpoints to create and interact with ADE integrations.
- name: Blueprints
- name: Device Information
description: >-
This section contains endpoints related to collecting information about
devices.
- name: Notes
description: This section contains endpoints related to managing device notes.
- name: Device Actions
description: >-
This section contains endpoints related to committing actions against
devices.
- name: Lost Mode
description: >-
**Note**: Lost Mode is is only available for iOS and iPadOS. For more
information, please see this [Kandji support
artilcle](https://support.kandji.io/a/solutions/articles/72000573873).
- name: Device Secrets
description: >-
This section contains endpoints related to collecting device secrets such
as the FileVault Recovery Key.
If no secrets is avaialble for the device, the key value will return as
`null`.
- name: Library items
- name: Custom Apps
description: >-
This section contains endpoints related to managing Custom Apps in the
Library.
## Custom app Library item creation flow overview
1. Make a request to the `Upload Custom App` endpoint to retrieve the S3
upload details need for uploading the app to Amazon S3.
1. Store the `post_url` and contents of the `post_data` object for use in the `Upload to S3` endpoint.
2. Store the `file_key` value for use in the `Create Custom App` endpoint in step 3.
2. To upload the custom app file to S3, make a request to the `Upload to
S3` endpoint.
1. The `post_url` is used to create the S3 request URL - `https://{{post_url}}.s3.amazonaws.com/`
2. For the request body, use the contents of the `post_data` object from the previous step and supply the path to the custom app file in the `file` request parameter.
3. Finally, to create the custom app Library item, make a request to the
`Create Custom App` endpoint.
1. The `file_key` key from step 1 will be needed in the in the request body.
Note: a similar process is used when updating an existing custom app
library item, but for step 3 you will use the `Update Custom App`
endpoint.
- name: Custom Profiles
description: >-
This section contains endpoints related to managing Custom Profiles in the
Library.
- name: Custom Scripts
description: >-
This section contains endpoints related to managing Custom Scripts in the
Library.
- name: Self Service
description: Endpoints related to Self Service.
- name: Prism
description: >-
Prism endpoints can be used to request information about your device fleet
as well as export said information in CSV format.
#### Filters
Each of the Prism category endpoints have a `filter` query parameter. The
`filter` parameter can be used to narrow down the list of results to a
specific data set. All filters are constructed in JSON schema format.
Any of the keys returned in the `data` object of the response within a
given category can be used in a filter expression. Exceptions to this are
`blueprint__id`, `device__family`
**Filter operators**
| Operator | Applies to | Description | Example |
| --- | --- | --- | --- |
| "eq" | boolean values | | `{"apple_silicon": {"eq": true}}` |
| "in" | string values | exact match in string values. If multiple values
are provided in an array, the query will only return the matching results
| `{"device__user_name":{"in":["Thor Odinson"]}}` |
| "not_in" | string values | oposite of `"in"` | |
| "like" | string values | contains | |
| "not_like" | string values | does not contain | |
| "lt" | date values | Less than a given date | |
| "gt" | date values | Greater than a given date | |
| "lte" | date values | Less than or equal to a given date | |
| "gte" | date values | Greater than or equal to a given date | |
| "or" | date values | combined with `lte` and `gte` to exclude a window
of time between two given dates. |
`{"last_changed_at":{"or":{"gt":"2023-09-10T04:00:00.000Z","lt":"2023-09-09T04:00:00.000Z"}}}`
|
##### Filter examples
Return all device names that contiain the string `"dev"`.
``` json
filer={"device__name":{"like":["dev"]}}
```
Return all Apple Silcon Mac computers.
``` json
{"apple_silicon":{"eq":true}}
```
Return all devices assigned to a specific user email.
``` json
{"device__user_email":{"in":["[email protected]"]}}
```
Return all Apple Silicon devices assigned to a specific user.
``` json
{"device__user_name":{"in":["Thor Odinson"]},
"apple_silicon":{"eq":true}}
```
- name: Tags
description: >-
Create and manage tags within your Kandji tenant.
For more information on tags, checkout the support article
[here](https://support.kandji.io/support/solutions/articles/72000630421-tags-for-devices)
- name: Threats
description: >-
Kandji Endpoint Detection and Response (EDR) endpoints. These endpoints
are available for EDR customers.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy