https://github.com/mscottblake/kandji-go-sdk
A Go client for the Kandji API
https://github.com/mscottblake/kandji-go-sdk
Last synced: 2 months ago
JSON representation
A Go client for the Kandji API
- Host: GitHub
- URL: https://github.com/mscottblake/kandji-go-sdk
- Owner: MScottBlake
- License: mit
- Created: 2024-11-12T01:53:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-19T07:40:58.000Z (over 1 year ago)
- Last Synced: 2025-02-19T08:29:34.040Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 940 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for kandji
Welcome to the Iru Endpoint Management API Documentation
Note: Kandji is now Iru, but many URLs and notes within this documentation will continue to reference Kandji for some time.
You can find your API URL in Settings > Access. The API URL will follow the below formats.
-
US -
https://SubDomain.api.kandji.io -
EU -
https://SubDomain.api.eu.kandji.io
For information on how to obtain an API token, please refer to the following support article.
Rate Limit
The Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.
Request Methods
HTTP request methods supported by the API.
Response codes
Not all response codes apply to every endpoint.
Data structure
The API returns all structured responses in JSON schema format.
Examples
Code examples using the API can be found in the Iru Endpoint Management support GitHub.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.18.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://github.com/MScottBlake/kandji-openapi](https://github.com/MScottBlake/kandji-openapi)
## Installation
Install the following dependencies:
```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```go
import kandji "github.com/MScottBlake/kandji-go-sdk"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `kandji.ContextServerIndex` of type `int`.
```go
ctx := context.WithValue(context.Background(), kandji.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `kandji.ContextServerVariables` of type `map[string]string`.
```go
ctx := context.WithValue(context.Background(), kandji.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
### URLs Configuration per Operation
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `kandji.ContextOperationServerIndices` and `kandji.ContextOperationServerVariables` context maps.
```go
ctx := context.WithValue(context.Background(), kandji.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), kandji.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```
## Documentation for API Endpoints
All URIs are relative to *https://<sub_domain>.api.kandji.io*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuditLogAPI* | [**ListAuditEvents**](docs/AuditLogAPI.md#listauditevents) | **Get** /api/v1/audit/events | List audit events
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**CreateAdeIntegration**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#createadeintegration) | **Post** /api/v1/integrations/apple/ade/ | Create ADE integration
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**DeleteAdeIntegration**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#deleteadeintegration) | **Delete** /api/v1/integrations/apple/ade/{ade_token_id} | Delete ADE integration
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**DownloadAdePublicKey**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#downloadadepublickey) | **Get** /api/v1/integrations/apple/ade/public_key/ | Download ADE public key
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**GetAdeDevice**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#getadedevice) | **Get** /api/v1/integrations/apple/ade/devices/{device_id} | Get ADE device
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**GetAdeIntegration**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#getadeintegration) | **Get** /api/v1/integrations/apple/ade/{ade_token_id} | Get ADE integration
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**ListAdeDevices**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#listadedevices) | **Get** /api/v1/integrations/apple/ade/devices | List ADE devices
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**ListAdeIntegrations**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#listadeintegrations) | **Get** /api/v1/integrations/apple/ade | List ADE integrations
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**ListDevicesAssociatedToAdeToken**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#listdevicesassociatedtoadetoken) | **Get** /api/v1/integrations/apple/ade/{ade_token_id}/devices | List devices associated to ADE token
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**RenewAdeIntegration**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#renewadeintegration) | **Post** /api/v1/integrations/apple/ade/{ade_token_id}/renew | Renew ADE integration
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**UpdateAdeDevice**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#updateadedevice) | **Patch** /api/v1/integrations/apple/ade/devices/{device_id} | Update ADE device
*AutomatedDeviceEnrollmentIntegrationsAPI* | [**UpdateAdeIntegration**](docs/AutomatedDeviceEnrollmentIntegrationsAPI.md#updateadeintegration) | **Patch** /api/v1/integrations/apple/ade/{ade_token_id} | Update ADE integration
*BlueprintsAPI* | [**CreateBlueprint**](docs/BlueprintsAPI.md#createblueprint) | **Post** /api/v1/blueprints | Create Blueprint
*BlueprintsAPI* | [**DeleteBlueprint**](docs/BlueprintsAPI.md#deleteblueprint) | **Delete** /api/v1/blueprints/{blueprint_id} | Delete Blueprint
*BlueprintsAPI* | [**GetBlueprint**](docs/BlueprintsAPI.md#getblueprint) | **Get** /api/v1/blueprints/{blueprint_id} | Get Blueprint
*BlueprintsAPI* | [**GetBlueprintTemplates**](docs/BlueprintsAPI.md#getblueprinttemplates) | **Get** /api/v1/blueprints/templates/ | Get Blueprint Templates
*BlueprintsAPI* | [**GetManualEnrollmentProfile**](docs/BlueprintsAPI.md#getmanualenrollmentprofile) | **Get** /api/v1/blueprints/{blueprint_id}/ota-enrollment-profile | Get Manual Enrollment Profile
*BlueprintsAPI* | [**ListBlueprints**](docs/BlueprintsAPI.md#listblueprints) | **Get** /api/v1/blueprints | List Blueprints
*BlueprintsAPI* | [**ListLibraryItems**](docs/BlueprintsAPI.md#listlibraryitems) | **Get** /api/v1/blueprints/{blueprint_id}/list-library-items | List Library Items
*BlueprintsAPI* | [**RemoveLibraryItem**](docs/BlueprintsAPI.md#removelibraryitem) | **Post** /api/v1/blueprints/{blueprint_id}/assign-library-item | Remove Library Item
*BlueprintsAPI* | [**UpdateBlueprint**](docs/BlueprintsAPI.md#updateblueprint) | **Patch** /api/v1/blueprints/{blueprint_id} | Update Blueprint
*DeviceActionsAPI* | [**ClearPasscode**](docs/DeviceActionsAPI.md#clearpasscode) | **Post** /api/v1/devices/{device_id}/action/clearpasscode | Clear Passcode
*DeviceActionsAPI* | [**DeleteDevice**](docs/DeviceActionsAPI.md#deletedevice) | **Delete** /api/v1/devices/{device_id} | Delete Device
*DeviceActionsAPI* | [**DeleteUser**](docs/DeviceActionsAPI.md#deleteuser) | **Post** /api/v1/devices/{device_id}/action/deleteuser | Delete User
*DeviceActionsAPI* | [**EraseDevice**](docs/DeviceActionsAPI.md#erasedevice) | **Post** /api/v1/devices/{device_id}/action/erase | Erase Device
*DeviceActionsAPI* | [**GetDeviceCommands**](docs/DeviceActionsAPI.md#getdevicecommands) | **Get** /api/v1/devices/{device_id}/commands | Get Device Commands
*DeviceActionsAPI* | [**LockDevice**](docs/DeviceActionsAPI.md#lockdevice) | **Post** /api/v1/devices/{device_id}/action/lock | Lock Device
*DeviceActionsAPI* | [**PerformDailyCheckin**](docs/DeviceActionsAPI.md#performdailycheckin) | **Post** /api/v1/devices/{device_id}/action/dailycheckin | Perform Daily Check-in
*DeviceActionsAPI* | [**ReinstallAgent**](docs/DeviceActionsAPI.md#reinstallagent) | **Post** /api/v1/devices/{device_id}/action/reinstallagent | Reinstall Agent
*DeviceActionsAPI* | [**RemoteDesktop**](docs/DeviceActionsAPI.md#remotedesktop) | **Post** /api/v1/devices/{device_id}/action/remotedesktop | Remote Desktop
*DeviceActionsAPI* | [**RenewMdmProfile**](docs/DeviceActionsAPI.md#renewmdmprofile) | **Post** /api/v1/devices/{device_id}/action/renewmdmprofile | Renew MDM Profile
*DeviceActionsAPI* | [**RestartDevice**](docs/DeviceActionsAPI.md#restartdevice) | **Post** /api/v1/devices/{device_id}/action/restart | Restart Device
*DeviceActionsAPI* | [**SendBlankpush**](docs/DeviceActionsAPI.md#sendblankpush) | **Post** /api/v1/devices/{device_id}/action/blankpush | Send Blankpush
*DeviceActionsAPI* | [**SetName**](docs/DeviceActionsAPI.md#setname) | **Post** /api/v1/devices/{device_id}/action/setname | Set Name
*DeviceActionsAPI* | [**Shutdown**](docs/DeviceActionsAPI.md#shutdown) | **Post** /api/v1/devices/{device_id}/action/shutdown | Shutdown
*DeviceActionsAPI* | [**UnlockAccount**](docs/DeviceActionsAPI.md#unlockaccount) | **Post** /api/v1/devices/{device_id}/action/unlockaccount | Unlock Account
*DeviceActionsAPI* | [**UpdateInventory**](docs/DeviceActionsAPI.md#updateinventory) | **Post** /api/v1/devices/{device_id}/action/updateinventory | Update Inventory
*DeviceInformationAPI* | [**CancelLostMode**](docs/DeviceInformationAPI.md#cancellostmode) | **Delete** /api/v1/devices/{device_id}/details/lostmode | Cancel Lost Mode
*DeviceInformationAPI* | [**GetDevice**](docs/DeviceInformationAPI.md#getdevice) | **Get** /api/v1/devices/{device_id} | Get Device
*DeviceInformationAPI* | [**GetDeviceActivity**](docs/DeviceInformationAPI.md#getdeviceactivity) | **Get** /api/v1/devices/{device_id}/activity | Get Device Activity
*DeviceInformationAPI* | [**GetDeviceApps**](docs/DeviceInformationAPI.md#getdeviceapps) | **Get** /api/v1/devices/{device_id}/apps | Get Device Apps
*DeviceInformationAPI* | [**GetDeviceDetails**](docs/DeviceInformationAPI.md#getdevicedetails) | **Get** /api/v1/devices/{device_id}/details | Get Device Details
*DeviceInformationAPI* | [**GetDeviceLibraryItems**](docs/DeviceInformationAPI.md#getdevicelibraryitems) | **Get** /api/v1/devices/{device_id}/library-items | Get Device Library Items
*DeviceInformationAPI* | [**GetDeviceLostModeDetails**](docs/DeviceInformationAPI.md#getdevicelostmodedetails) | **Get** /api/v1/devices/{device_id}/details/lostmode | Get Device Lost Mode details
*DeviceInformationAPI* | [**GetDeviceParameters**](docs/DeviceInformationAPI.md#getdeviceparameters) | **Get** /api/v1/devices/{device_id}/parameters | Get Device Parameters
*DeviceInformationAPI* | [**GetDeviceStatus**](docs/DeviceInformationAPI.md#getdevicestatus) | **Get** /api/v1/devices/{device_id}/status | Get Device Status
*DeviceInformationAPI* | [**ListDevices**](docs/DeviceInformationAPI.md#listdevices) | **Get** /api/v1/devices | List Devices
*DeviceInformationAPI* | [**UpdateDevice**](docs/DeviceInformationAPI.md#updatedevice) | **Patch** /api/v1/devices/{device_id} | Update Device
*DeviceSecretsAPI* | [**GetActivationLockBypassCode**](docs/DeviceSecretsAPI.md#getactivationlockbypasscode) | **Get** /api/v1/devices/{device_id}/secrets/bypasscode | Get Activation Lock Bypass Code
*DeviceSecretsAPI* | [**GetFilevaultRecoveryKey**](docs/DeviceSecretsAPI.md#getfilevaultrecoverykey) | **Get** /api/v1/devices/{device_id}/secrets/filevaultkey | Get FileVault Recovery Key
*DeviceSecretsAPI* | [**GetRecoveryLockPassword**](docs/DeviceSecretsAPI.md#getrecoverylockpassword) | **Get** /api/v1/devices/{device_id}/secrets/recoverypassword | Get Recovery Lock Password
*DeviceSecretsAPI* | [**GetUnlockPin**](docs/DeviceSecretsAPI.md#getunlockpin) | **Get** /api/v1/devices/{device_id}/secrets/unlockpin | Get Unlock Pin
*LibraryItemsAPI* | [**GetLibraryItemActivity**](docs/LibraryItemsAPI.md#getlibraryitemactivity) | **Get** /api/v1/library/library-items/{library_item_id}/activity | Get Library Item Activity
*LibraryItemsAPI* | [**GetLibraryItemStatuses**](docs/LibraryItemsAPI.md#getlibraryitemstatuses) | **Get** /api/v1/library/library-items/{library_item_id}/status | Get Library Item Statuses
*PrismAPI* | [**ActivationLock**](docs/PrismAPI.md#activationlock) | **Get** /api/v1/prism/activation_lock | Activation lock
*PrismAPI* | [**ApplicationFirewall**](docs/PrismAPI.md#applicationfirewall) | **Get** /api/v1/prism/application_firewall | Application firewall
*PrismAPI* | [**Applications**](docs/PrismAPI.md#applications) | **Get** /api/v1/prism/apps | Applications
*PrismAPI* | [**Cellular**](docs/PrismAPI.md#cellular) | **Get** /api/v1/prism/cellular | Cellular
*PrismAPI* | [**Certificates**](docs/PrismAPI.md#certificates) | **Get** /api/v1/prism/certificates | Certificates
*PrismAPI* | [**Count**](docs/PrismAPI.md#count) | **Get** /api/v1/prism/count | Count
*PrismAPI* | [**DesktopAndScreensaver**](docs/PrismAPI.md#desktopandscreensaver) | **Get** /api/v1/prism/desktop_and_screensaver | Desktop and Screensaver
*PrismAPI* | [**DeviceInformation**](docs/PrismAPI.md#deviceinformation) | **Get** /api/v1/prism/device_information | Device information
*PrismAPI* | [**Filevault**](docs/PrismAPI.md#filevault) | **Get** /api/v1/prism/filevault | FileVault
*PrismAPI* | [**GatekeeperAndXprotect**](docs/PrismAPI.md#gatekeeperandxprotect) | **Get** /api/v1/prism/gatekeeper_and_xprotect | Gatekeeper and XProtect
*PrismAPI* | [**GetCategoryExport**](docs/PrismAPI.md#getcategoryexport) | **Get** /api/v1/prism/export/{export_id} | Get category export
*PrismAPI* | [**InstalledProfiles**](docs/PrismAPI.md#installedprofiles) | **Get** /api/v1/prism/installed_profiles | Installed profiles
*PrismAPI* | [**KernelExtensions**](docs/PrismAPI.md#kernelextensions) | **Get** /api/v1/prism/kernel_extensions | Kernel Extensions
*PrismAPI* | [**LaunchAgentsAndDaemons**](docs/PrismAPI.md#launchagentsanddaemons) | **Get** /api/v1/prism/launch_agents_and_daemons | Launch Agents and Daemons
*PrismAPI* | [**LocalUsers**](docs/PrismAPI.md#localusers) | **Get** /api/v1/prism/local_users | Local users
*PrismAPI* | [**RequestCategoryExport**](docs/PrismAPI.md#requestcategoryexport) | **Post** /api/v1/prism/export | Request category export
*PrismAPI* | [**StartupSettings**](docs/PrismAPI.md#startupsettings) | **Get** /api/v1/prism/startup_settings | Startup settings
*PrismAPI* | [**SystemExtensions**](docs/PrismAPI.md#systemextensions) | **Get** /api/v1/prism/system_extensions | System Extensions
*PrismAPI* | [**TransparencyDatabase**](docs/PrismAPI.md#transparencydatabase) | **Get** /api/v1/prism/transparency_database | Transparency database
*SettingsAPI* | [**Licensing**](docs/SettingsAPI.md#licensing) | **Get** /api/v1/settings/licensing | Licensing
*TagsAPI* | [**CreateTag**](docs/TagsAPI.md#createtag) | **Post** /api/v1/tags | Create Tag
*TagsAPI* | [**DeleteTag**](docs/TagsAPI.md#deletetag) | **Delete** /api/v1/tags/{tag_id} | Delete Tag
*TagsAPI* | [**GetTags**](docs/TagsAPI.md#gettags) | **Get** /api/v1/tags | Get Tags
*TagsAPI* | [**UpdateTag**](docs/TagsAPI.md#updatetag) | **Patch** /api/v1/tags/{tag_id} | Update Tag
*ThreatsAPI* | [**GetBehavioralDetections**](docs/ThreatsAPI.md#getbehavioraldetections) | **Get** /api/v1/behavioral-detections | Get Behavioral Detections
*ThreatsAPI* | [**GetThreatDetails**](docs/ThreatsAPI.md#getthreatdetails) | **Get** /api/v1/threat-details | Get Threat Details
*UsersAPI* | [**DeleteUser**](docs/UsersAPI.md#deleteuser) | **Delete** /api/v1/users/{user_id} | Delete User
*UsersAPI* | [**GetUser**](docs/UsersAPI.md#getuser) | **Get** /api/v1/users/{user_id} | Get User
*UsersAPI* | [**ListUsers**](docs/UsersAPI.md#listusers) | **Get** /api/v1/users | List Users
*VulnerabilitiesAPI* | [**GetVulnerabilityDescription**](docs/VulnerabilitiesAPI.md#getvulnerabilitydescription) | **Get** /api/v1/vulnerability-management/vulnerabilities/{cve_id} | Get Vulnerability Description
*VulnerabilitiesAPI* | [**ListAffectedDevices**](docs/VulnerabilitiesAPI.md#listaffecteddevices) | **Get** /api/v1/vulnerability-management/vulnerabilities/{cve_id}/devices | List Affected Devices
*VulnerabilitiesAPI* | [**ListAffectedSoftware**](docs/VulnerabilitiesAPI.md#listaffectedsoftware) | **Get** /api/v1/vulnerability-management/vulnerabilities/{cve_id}/software | List Affected Software
*VulnerabilitiesAPI* | [**ListDetections**](docs/VulnerabilitiesAPI.md#listdetections) | **Get** /api/v1/vulnerability-management/detections | List Detections
*VulnerabilitiesAPI* | [**ListVulnerabilities**](docs/VulnerabilitiesAPI.md#listvulnerabilities) | **Get** /api/v1/vulnerability-management/vulnerabilities | List Vulnerabilities
## Documentation For Models
- [AuditLogListAuditEvents200Response](docs/AuditLogListAuditEvents200Response.md)
- [AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200Response](docs/AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200Response.md)
- [AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200ResponseBlueprint](docs/AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200ResponseBlueprint.md)
- [AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200ResponseDefaults](docs/AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200ResponseDefaults.md)
- [AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200ResponseDeviceCounts](docs/AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200ResponseDeviceCounts.md)
- [AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response](docs/AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response.md)
- [AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200ResponseDepAccount](docs/AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200ResponseDepAccount.md)
- [AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200ResponseMdmDevice](docs/AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200ResponseMdmDevice.md)
- [AutomatedDeviceEnrollmentIntegrationsListAdeDevices400Response](docs/AutomatedDeviceEnrollmentIntegrationsListAdeDevices400Response.md)
- [AutomatedDeviceEnrollmentIntegrationsListDevicesAssociatedToAdeToken200Response](docs/AutomatedDeviceEnrollmentIntegrationsListDevicesAssociatedToAdeToken200Response.md)
- [BlueprintsCreateBlueprint201Response](docs/BlueprintsCreateBlueprint201Response.md)
- [BlueprintsCreateBlueprint201ResponseEnrollmentCode](docs/BlueprintsCreateBlueprint201ResponseEnrollmentCode.md)
- [BlueprintsGetBlueprint200Response](docs/BlueprintsGetBlueprint200Response.md)
- [BlueprintsListBlueprints200Response](docs/BlueprintsListBlueprints200Response.md)
- [BlueprintsUpdateBlueprint200Response](docs/BlueprintsUpdateBlueprint200Response.md)
- [DeviceActionsGetDeviceCommands200Response](docs/DeviceActionsGetDeviceCommands200Response.md)
- [DeviceActionsLockDevice200Response](docs/DeviceActionsLockDevice200Response.md)
- [DeviceInformationGetDevice200Response](docs/DeviceInformationGetDevice200Response.md)
- [DeviceInformationGetDevice200ResponseUser](docs/DeviceInformationGetDevice200ResponseUser.md)
- [DeviceInformationGetDeviceActivity200Response](docs/DeviceInformationGetDeviceActivity200Response.md)
- [DeviceInformationGetDeviceApps200Response](docs/DeviceInformationGetDeviceApps200Response.md)
- [DeviceInformationGetDeviceDetails200Response](docs/DeviceInformationGetDeviceDetails200Response.md)
- [DeviceInformationGetDeviceDetails200ResponseCellular](docs/DeviceInformationGetDeviceDetails200ResponseCellular.md)
- [DeviceInformationGetDeviceDetails200ResponseGeneral](docs/DeviceInformationGetDeviceDetails200ResponseGeneral.md)
- [DeviceInformationGetDeviceDetails200ResponseHardware](docs/DeviceInformationGetDeviceDetails200ResponseHardware.md)
- [DeviceInformationGetDeviceDetails200ResponseManagement](docs/DeviceInformationGetDeviceDetails200ResponseManagement.md)
- [DeviceInformationGetDeviceDetails200ResponseSecurity](docs/DeviceInformationGetDeviceDetails200ResponseSecurity.md)
- [DeviceInformationGetDeviceLibraryItems200Response](docs/DeviceInformationGetDeviceLibraryItems200Response.md)
- [DeviceInformationGetDeviceLostModeDetails200Response](docs/DeviceInformationGetDeviceLostModeDetails200Response.md)
- [DeviceInformationGetDeviceLostModeDetails200ResponseLostMode](docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostMode.md)
- [DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation](docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation.md)
- [DeviceInformationGetDeviceParameters200Response](docs/DeviceInformationGetDeviceParameters200Response.md)
- [DeviceInformationGetDeviceStatus200Response](docs/DeviceInformationGetDeviceStatus200Response.md)
- [DeviceInformationUpdateDevice200Response](docs/DeviceInformationUpdateDevice200Response.md)
- [DeviceSecretsGetActivationLockBypassCode200Response](docs/DeviceSecretsGetActivationLockBypassCode200Response.md)
- [DeviceSecretsGetFilevaultRecoveryKey200Response](docs/DeviceSecretsGetFilevaultRecoveryKey200Response.md)
- [DeviceSecretsGetRecoveryLockPassword200Response](docs/DeviceSecretsGetRecoveryLockPassword200Response.md)
- [DeviceSecretsGetUnlockPin200Response](docs/DeviceSecretsGetUnlockPin200Response.md)
- [PrismActivationLock200Response](docs/PrismActivationLock200Response.md)
- [PrismApplicationFirewall200Response](docs/PrismApplicationFirewall200Response.md)
- [PrismCount200Response](docs/PrismCount200Response.md)
- [PrismGetCategoryExport200Response](docs/PrismGetCategoryExport200Response.md)
- [PrismLocalUsers200Response](docs/PrismLocalUsers200Response.md)
- [PrismRequestCategoryExport200Response](docs/PrismRequestCategoryExport200Response.md)
- [PrismRequestCategoryExport200ResponseArgs](docs/PrismRequestCategoryExport200ResponseArgs.md)
- [PrismRequestCategoryExport400Response](docs/PrismRequestCategoryExport400Response.md)
- [SettingsLicensing200Response](docs/SettingsLicensing200Response.md)
- [SettingsLicensing200ResponseCounts](docs/SettingsLicensing200ResponseCounts.md)
- [SettingsLicensing200ResponseLimits](docs/SettingsLicensing200ResponseLimits.md)
- [SettingsLicensing200ResponseLimitsMaxDevicesPerPlatform](docs/SettingsLicensing200ResponseLimitsMaxDevicesPerPlatform.md)
- [TagsCreateTag201Response](docs/TagsCreateTag201Response.md)
- [ThreatsGetBehavioralDetections200Response](docs/ThreatsGetBehavioralDetections200Response.md)
- [ThreatsGetThreatDetails200Response](docs/ThreatsGetThreatDetails200Response.md)
- [UsersGetUser200Response](docs/UsersGetUser200Response.md)
- [UsersGetUser200ResponseIntegration](docs/UsersGetUser200ResponseIntegration.md)
- [VulnerabilitiesGetVulnerabilityDescription200Response](docs/VulnerabilitiesGetVulnerabilityDescription200Response.md)
- [VulnerabilitiesListAffectedDevices200Response](docs/VulnerabilitiesListAffectedDevices200Response.md)
- [VulnerabilitiesListDetections200Response](docs/VulnerabilitiesListDetections200Response.md)
- [VulnerabilitiesListVulnerabilities200Response](docs/VulnerabilitiesListVulnerabilities200Response.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### bearer
- **Type**: HTTP Bearer token authentication
Example
```go
auth := context.WithValue(context.Background(), kandji.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```
## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`
## Author
mitchelsblake@gmail.com