Knox OAuth 2.0 Authentication
Last updated March 18th, 2025
Before you can access the Knox Asset Intelligence API, you must set up Knox OAuth 2.0 Authentication.
Set up Knox OAuth 2.0 AuthenticationAvailable scopes
Scopes are used to specify the level of access your application has to your customer’s Knox Asset Intelligence resources. When you register your app in Knox Developer Portal, ensure that you add the necessary scopes based on your application’s requirements to access relevant Knox Asset Intelligence features.
If multiple scopes are requested, the user must consent to all of them and may not select individual scopes. For a superior customer experience, please ensure that your application requests the least number of scope permissions.
Here is a list of scopes you can add for Knox Asset Intelligence:
| Scope | Permission |
|---|---|
kai |
Manage all Knox Asset Intelligence functionality, including devices, diagnostics logs, and network settings. |
kai.settings |
View and configure your Knox Asset Intelligence tenant information, including battery threshold levels and enrollment settings. |
kai.devices |
View Knox Asset Intelligence device and group information. |
kai.diagnostics |
Request and view Knox Asset Intelligence diagnostics logs. |
kai.network |
Subscribe to Knox Asset Intelligence notifications about Wi-Fi connection and disconnection events. |
kai.battery |
Subscribe to Knox Asset Intelligence notifications about battery-related events. |
kai.app |
Subscribe to Knox Asset Intelligence notifications about app usage and abnormal app events. |
kai.miscellaneous |
View the deployment status of your Knox Service Plugin policies. |
For more information on applicable Knox Asset Intelligence API endpoints and Knox Webhook Notification events, refer to Scopes for Knox cloud services APIs.
On this page
Is this page helpful?