Skip to content

PrismApi.md

Latest commit

 

History

History
1720 lines (1241 loc) · 93.5 KB

PrismApi.md

File metadata and controls

1720 lines (1241 loc) · 93.5 KB

kandji.PrismApi

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

Method HTTP request Description
activation_lock GET /api/v1/prism/activation_lock Activation lock
application_firewall GET /api/v1/prism/application_firewall Application firewall
applications GET /api/v1/prism/apps Applications
cellular GET /api/v1/prism/cellular Cellular
certificates GET /api/v1/prism/certificates Certificates
count GET /api/v1/prism/count Count
desktop_and_screensaver GET /api/v1/prism/desktop_and_screensaver Desktop and Screensaver
device_information GET /api/v1/prism/device_information Device information
filevault GET /api/v1/prism/filevault FileVault
gatekeeper_and_xprotect GET /api/v1/prism/gatekeeper_and_xprotect Gatekeeper and XProtect
get_category_export GET /api/v1/prism/export/{export_id} Get category export
installed_profiles GET /api/v1/prism/installed_profiles Installed profiles
kernel_extensions GET /api/v1/prism/kernel_extensions Kernel Extensions
launch_agents_and_daemons GET /api/v1/prism/launch_agents_and_daemons Launch Agents and Daemons
local_users GET /api/v1/prism/local_users Local users
request_category_export POST /api/v1/prism/export Request category export
startup_settings GET /api/v1/prism/startup_settings Startup settings
system_extensions GET /api/v1/prism/system_extensions System Extensions
transparency_database GET /api/v1/prism/transparency_database Transparency database

activation_lock

PrismActivationLock200Response activation_lock(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Activation lock

Get activation lock attributes for devices.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Activation lock
        api_response = api_instance.activation_lock(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->activation_lock:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->activation_lock: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Accept-Ranges -
* Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Vary -
* Via -
* X-Cache -
* X-Cache-Hits -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -
* X-Served-By -
* X-Timer -
* transfer-encoding -

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

application_firewall

PrismApplicationFirewall200Response application_firewall(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Application firewall

Get Application Firewall details for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_application_firewall200_response import PrismApplicationFirewall200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Application firewall
        api_response = api_instance.application_firewall(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->application_firewall:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->application_firewall: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismApplicationFirewall200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

applications

PrismActivationLock200Response applications(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Applications

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

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '{\"name\":{\"not_in\":[\"Okta Verify\"]},\"device__name\":{\"not_in\":[\"testuser’s MacBook Air\"]}}' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Applications
        api_response = api_instance.applications(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->applications: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Accept-Ranges -
* Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Vary -
* Via -
* X-Cache -
* X-Cache-Hits -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -
* X-Served-By -
* X-Timer -
* transfer-encoding -

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

cellular

PrismApplicationFirewall200Response cellular(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Cellular

Get Cellular attributes for devices.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_application_firewall200_response import PrismApplicationFirewall200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Cellular
        api_response = api_instance.cellular(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->cellular:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->cellular: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismApplicationFirewall200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Accept-Ranges -
* Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Vary -
* Via -
* X-Cache -
* X-Cache-Hits -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -
* X-Served-By -
* X-Timer -
* transfer-encoding -

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

certificates

PrismApplicationFirewall200Response certificates(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Certificates

Get certificate details.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_application_firewall200_response import PrismApplicationFirewall200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Certificates
        api_response = api_instance.certificates(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->certificates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->certificates: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismApplicationFirewall200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Accept-Ranges -
* Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Vary -
* Via -
* X-Cache -
* X-Cache-Hits -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -
* X-Served-By -
* X-Timer -
* transfer-encoding -

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

count

PrismCount200Response count(category)

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

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_count200_response import PrismCount200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    category = 'apps' # str | <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>

    try:
        # Count
        api_response = api_instance.count(category)
        print("The response of PrismApi->count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->count: %s\n" % e)

Parameters

Name Type Description Notes
category str <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>

Return type

PrismCount200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

desktop_and_screensaver

PrismActivationLock200Response desktop_and_screensaver(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Desktop and Screensaver

Get Desktop and Screensaver details for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Desktop and Screensaver
        api_response = api_instance.desktop_and_screensaver(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->desktop_and_screensaver:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->desktop_and_screensaver: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

device_information

PrismActivationLock200Response device_information(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset, body=body)

Device information

Get attributes about devices.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = '14afabf2-7599-47af-a942-bf7f0b8fedf8' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '{\"device__name\":{\"in\":[\"testusers\'s MacBook Air\"]},\"updated_at\":{\"gte\":\"2023-09-03T04:00:00.000Z\",\"lte\":\"2023-09-04T04:00:00.000Z\"}}' # str | <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)
    sort_by = 'serial_number' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return (optional)
    body = {} # str |  (optional)

    try:
        # Device information
        api_response = api_instance.device_information(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset, body=body)
        print("The response of PrismApi->device_information:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->device_information: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str <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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return [optional]
body str [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

filevault

PrismApplicationFirewall200Response filevault(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

FileVault

Get FileVault information for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_application_firewall200_response import PrismApplicationFirewall200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return (optional)

    try:
        # FileVault
        api_response = api_instance.filevault(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->filevault:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->filevault: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return [optional]

Return type

PrismApplicationFirewall200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

gatekeeper_and_xprotect

PrismApplicationFirewall200Response gatekeeper_and_xprotect(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Gatekeeper and XProtect

Get Gatekeeper and XProtect attributes for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_application_firewall200_response import PrismApplicationFirewall200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac' # str | Results are limited to Mac only as Gatekeeper and XProtect are not applicable for other platfroms. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return (optional)

    try:
        # Gatekeeper and XProtect
        api_response = api_instance.gatekeeper_and_xprotect(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->gatekeeper_and_xprotect:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->gatekeeper_and_xprotect: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Results are limited to Mac only as Gatekeeper and XProtect are not applicable for other platfroms. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return [optional]

Return type

PrismApplicationFirewall200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

get_category_export

PrismGetCategoryExport200Response get_category_export(export_id)

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

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_get_category_export200_response import PrismGetCategoryExport200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    export_id = 'export_id_example' # str | 

    try:
        # Get category export
        api_response = api_instance.get_category_export(export_id)
        print("The response of PrismApi->get_category_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->get_category_export: %s\n" % e)

Parameters

Name Type Description Notes
export_id str

Return type

PrismGetCategoryExport200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

installed_profiles

PrismActivationLock200Response installed_profiles(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Installed profiles

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

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Installed profiles
        api_response = api_instance.installed_profiles(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->installed_profiles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->installed_profiles: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

kernel_extensions

PrismActivationLock200Response kernel_extensions(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Kernel Extensions

Get Kernel Extension attributes for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Kernel Extensions
        api_response = api_instance.kernel_extensions(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->kernel_extensions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->kernel_extensions: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

launch_agents_and_daemons

PrismActivationLock200Response launch_agents_and_daemons(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Launch Agents and Daemons

Get Launch Agents and Daemons installed on macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Launch Agents and Daemons
        api_response = api_instance.launch_agents_and_daemons(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->launch_agents_and_daemons:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->launch_agents_and_daemons: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

local_users

PrismLocalUsers200Response local_users(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Local users

Get Local Users detials for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_local_users200_response import PrismLocalUsers200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Local users
        api_response = api_instance.local_users(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->local_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->local_users: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismLocalUsers200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

request_category_export

PrismRequestCategoryExport200Response request_category_export(body=body)

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

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_request_category_export200_response import PrismRequestCategoryExport200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    body = {"blueprint_ids":["string","string","string"],"category":"device_information","device_families":["Mac"],"filter":{},"sort_by":"device__nam"} # str |  (optional)

    try:
        # Request category export
        api_response = api_instance.request_category_export(body=body)
        print("The response of PrismApi->request_category_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->request_category_export: %s\n" % e)

Parameters

Name Type Description Notes
body str [optional]

Return type

PrismRequestCategoryExport200Response

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -
400 Bad Request * Access-Control-Allow-Origin -
* Connection -
* Content-Length -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

startup_settings

PrismActivationLock200Response startup_settings(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Startup settings

Get Startup settings for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return (optional)

    try:
        # Startup settings
        api_response = api_instance.startup_settings(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->startup_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->startup_settings: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

system_extensions

PrismActivationLock200Response system_extensions(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

System Extensions

Get System Extension attributes for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # System Extensions
        api_response = api_instance.system_extensions(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->system_extensions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->system_extensions: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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

transparency_database

PrismActivationLock200Response transparency_database(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)

Transparency database

Get Transparency Database (TCC) attributes for macOS.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.prism_activation_lock200_response import PrismActivationLock200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.PrismApi(api_client)
    blueprint_ids = 'blueprint_id, blueprint_id,blueprint_id' # str | Filter results by one or more blueprint IDs separated by commas. (optional)
    device_families = 'Mac,iPhone,iPad,tvOS' # str | Filter results by one or more device families separate by commas. (optional)
    filter = '' # str | 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)
    sort_by = '' # str | Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. (optional)
    limit = '' # str | 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 = '' # str | Specify the starting record to return. (optional)

    try:
        # Transparency database
        api_response = api_instance.transparency_database(blueprint_ids=blueprint_ids, device_families=device_families, filter=filter, sort_by=sort_by, limit=limit, offset=offset)
        print("The response of PrismApi->transparency_database:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrismApi->transparency_database: %s\n" % e)

Parameters

Name Type Description Notes
blueprint_ids str Filter results by one or more blueprint IDs separated by commas. [optional]
device_families str Filter results by one or more device families separate by commas. [optional]
filter str 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]
sort_by str Sort results by the name of a given response body key in either ascending (default behavior) or descending(<code>-</code>) order. [optional]
limit str 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 str Specify the starting record to return. [optional]

Return type

PrismActivationLock200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Access-Control-Allow-Origin -
* Connection -
* Content-Encoding -
* Content-Type -
* Date -
* Ratelimit-Limit -
* Ratelimit-Remaining -
* Ratelimit-Reset -
* Server -
* Transfer-Encoding -
* Via -
* X-Kong-Proxy-Latency -
* X-Kong-Upstream-Latency -
* X-Ratelimit-Limit-Hour -
* X-Ratelimit-Limit-Second -
* X-Ratelimit-Remaining-Hour -
* X-Ratelimit-Remaining-Second -

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