PrismAPI

All URIs are relative to https://<sub_domain>.api.kandji.io

Method	HTTP request	Description
activationLock	GET /api/v1/prism/activation_lock	Activation lock
applicationFirewall	GET /api/v1/prism/application_firewall	Application firewall
applications	GET /api/v1/prism/apps	Applications
certificates	GET /api/v1/prism/certificates	Certificates
count	GET /api/v1/prism/count	Count
desktopAndScreensaver	GET /api/v1/prism/desktop_and_screensaver	Desktop and Screensaver
deviceInformation	GET /api/v1/prism/device_information	Device information
filevault	GET /api/v1/prism/filevault	FileVault
gatekeeperAndXprotect	GET /api/v1/prism/gatekeeper_and_xprotect	Gatekeeper and XProtect
getCategoryExport	GET /api/v1/prism/export/{export_id}	Get category export
installedProfiles	GET /api/v1/prism/installed_profiles	Installed profiles
kernelExtensions	GET /api/v1/prism/kernel_extensions	Kernel Extensions
launchAgentsAndDaemons	GET /api/v1/prism/launch_agents_and_daemons	Launch Agents and Daemons
localUsers	GET /api/v1/prism/local_users	Local users
requestCategoryExport	POST /api/v1/prism/export	Request category export
startupSettings	GET /api/v1/prism/startup_settings	Startup settings
systemExtensions	GET /api/v1/prism/system_extensions	System Extensions
transparencyDatabase	GET /api/v1/prism/transparency_database	Transparency database

activationLock

    open class func activationLock(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Activation lock

Get activation lock attributes for devices.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Activation lock
PrismAPI.activationLock(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

Void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationFirewall

    open class func applicationFirewall(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Application firewall

Get Application Firewall details for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Application firewall
PrismAPI.applicationFirewall(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applications

    open class func applications(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Applications

Get the applications installed on macOS, iOS, iPadOS, and tvOS devices.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "filter_example" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Applications
PrismAPI.applications(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

certificates

    open class func certificates(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Certificates

Get certificate details.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Certificates
PrismAPI.certificates(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

count

    open class func count(category: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Count

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let category = "category_example" // String | <p>Return the count of records for the specified category.  If a category contains spaces substitute the spaces for underscores (&quot;_&quot;) when using the API query.</p> <p>Examples: apps device_information kernel_extensions system_extensions</p>

// Count
PrismAPI.count(category: category) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
category	String	<p>Return the count of records for the specified category. If a category contains spaces substitute the spaces for underscores ("_") when using the API query.</p> <p>Examples: apps device_information kernel_extensions system_extensions</p>

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

desktopAndScreensaver

    open class func desktopAndScreensaver(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Desktop and Screensaver

Get Desktop and Screensaver details for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Desktop and Screensaver
PrismAPI.desktopAndScreensaver(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deviceInformation

    open class func deviceInformation(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, body: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Device information

Get attributes about devices.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "filter_example" // String | <p>JSON schema object containing one or more key value pairs.</p> <p>Note: For detailed information on fiters, see the Filters section at the begining of the Visibility API endpoints in this doc.</p> (optional)
let sortBy = "sortBy_example" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return (optional)
let body = "body_example" // String |  (optional)

// Device information
PrismAPI.deviceInformation(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	<p>JSON schema object containing one or more key value pairs.</p> <p>Note: For detailed information on fiters, see the Filters section at the begining of the Visibility API endpoints in this doc.</p>	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return	[optional]
body	String		[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filevault

    open class func filevault(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

FileVault

Get FileVault information for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return (optional)

// FileVault
PrismAPI.filevault(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

gatekeeperAndXprotect

    open class func gatekeeperAndXprotect(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Gatekeeper and XProtect

Get Gatekeeper and XProtect attributes for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Results are limited to Mac only as Gatekeeper and XProtect are not applicable for other platfroms. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return (optional)

// Gatekeeper and XProtect
PrismAPI.gatekeeperAndXprotect(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Results are limited to Mac only as Gatekeeper and XProtect are not applicable for other platfroms.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCategoryExport

    open class func getCategoryExport(exportId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Get category export

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let exportId = "exportId_example" // String | 

// Get category export
PrismAPI.getCategoryExport(exportId: exportId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
exportId	String

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

installedProfiles

    open class func installedProfiles(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Installed profiles

Get Installed Profiles attributes for macOS, iOS, iPadOS, and tvOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Installed profiles
PrismAPI.installedProfiles(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

kernelExtensions

    open class func kernelExtensions(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Kernel Extensions

Get Kernel Extension attributes for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Kernel Extensions
PrismAPI.kernelExtensions(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

launchAgentsAndDaemons

    open class func launchAgentsAndDaemons(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Launch Agents and Daemons

Get Launch Agents and Daemons installed on macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Launch Agents and Daemons
PrismAPI.launchAgentsAndDaemons(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

localUsers

    open class func localUsers(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Local users

Get Local Users detials for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Local users
PrismAPI.localUsers(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

requestCategoryExport

    open class func requestCategoryExport(body: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Request category export

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let body = "body_example" // String |  (optional)

// Request category export
PrismAPI.requestCategoryExport(body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
body	String		[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startupSettings

    open class func startupSettings(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Startup settings

Get Startup settings for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return (optional)

// Startup settings
PrismAPI.startupSettings(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

systemExtensions

    open class func systemExtensions(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

System Extensions

Get System Extension attributes for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// System Extensions
PrismAPI.systemExtensions(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

transparencyDatabase

    open class func transparencyDatabase(blueprintIds: String? = nil, deviceFamilies: String? = nil, filter: String? = nil, sortBy: String? = nil, limit: String? = nil, offset: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Transparency database

Get Transparency Database (TCC) attributes for macOS.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let blueprintIds = "blueprintIds_example" // String | Filter results by one or more blueprint IDs separated by commas. (optional)
let deviceFamilies = "deviceFamilies_example" // String | Filter results by one or more device families separate by commas. (optional)
let filter = "" // String | 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. (optional)
let sortBy = "" // String | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
let limit = "" // String | A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results. (optional)
let offset = "" // String | Specify the starting record to return. (optional)

// Transparency database
PrismAPI.transparencyDatabase(blueprintIds: blueprintIds, deviceFamilies: deviceFamilies, filter: filter, sortBy: sortBy, limit: limit, offset: offset) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
blueprintIds	String	Filter results by one or more blueprint IDs separated by commas.	[optional]
deviceFamilies	String	Filter results by one or more device families separate by commas.	[optional]
filter	String	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.	[optional]
sortBy	String	Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order.	[optional]
limit	String	A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.	[optional]
offset	String	Specify the starting record to return.	[optional]

Return type

AnyCodable

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PrismAPI.md

Latest commit

History

PrismAPI.md

File metadata and controls

PrismAPI

activationLock

Example

Parameters

Return type

Authorization

HTTP request headers

applicationFirewall

Example

Parameters

Return type

Authorization

HTTP request headers

applications

Example

Parameters

Return type

Authorization

HTTP request headers

certificates

Example

Parameters

Return type

Authorization

HTTP request headers

count

Example

Parameters

Return type

Authorization

HTTP request headers

desktopAndScreensaver

Example

Parameters

Return type

Authorization

HTTP request headers

deviceInformation

Example

Parameters

Return type

Authorization

HTTP request headers

filevault

Example

Parameters

Return type

Authorization

HTTP request headers

gatekeeperAndXprotect

Example

Parameters

Return type

Authorization

HTTP request headers

getCategoryExport

Request Parameters

Example

Parameters

Return type

Authorization

HTTP request headers

installedProfiles

Example

Parameters

Return type

Authorization

HTTP request headers

kernelExtensions

Example

Parameters

Return type

Authorization

HTTP request headers