Scopes for Knox cloud services APIs
Last updated June 24th, 2024
OAuth 2.0 scopes are required to access the Knox cloud services APIs. These scopes are service-specific, and the level of access you require for your app determines which scopes to select. For more information about the scope requirements, you can refer to the API specifications of its associated Knox cloud service.
The following scopes are available:
Knox Asset Intelligence
| Scope name | Description | Applicable API endpoints | Applicable KWN events |
|---|---|---|---|
| kai | Manage all Knox Asset Intelligence functionality. | POST /kai/v1/devices/getDevices | KAI_APP_ANR_FC, KAI_BATTERY_STATUS, KAI_DEVICE_DIAGNOSTICSLOGS, KAI_WIFI_DISCONNECTIONS, KAI_BATTERY_LEVEL_TRIGGERED, KAI_APP_USAGE_TIME_BATTERY, KAI_APP_USAGE_NETWORK, KAI_APP_USAGE_SCREENTIME, KAI_BATTERY_CHARGING, KAI_BATTERY_LEVEL_SHIFT_START, KAI_BATTERY_LEVEL_SHIFT_END, KAI_WIFI_CONNECTIONS |
| POST /kai/v1/diagnosticsLogs | |||
| GET /kai/v1/diagnosticsLogs | |||
| GET /kai/v1/network/wifiDisconnections | |||
| GET /kai/v1/network/wifiConnections | |||
| PUT /kai/v1/settings | |||
| GET /kai/v1/settings | |||
| kai.settings | View and configure your Knox Asset Intelligence tenant information, including battery threshold levels and enrollment settings. | PUT /kai/v1/settings | |
| GET /kai/v1/settings | |||
| kai.devices | View Knox Asset Intelligence device information. | POST /kai/v1/devices/getDevices | |
| kai.diagnostics | Request and view Knox Asset Intelligence diagnostics logs. | POST /kai/v1/diagnosticsLogs | KAI_DEVICE_DIAGNOSTICSLOGS |
| GET /kai/v1/diagnosticsLogs | |||
| kai.devices | View Knox Asset Intelligence device information. | POST /kai/v1/devices/getDevices | |
| kai.network | Subscribe to Knox Asset Intelligence notifications about Wi-Fi connection and disconnection events. | POST /kai/v1/network/wifiDisconnections | KAI_WIFI_DISCONNECTIONS, KAI_WIFI_CONNECTIONS |
| POST /kai/v1/network/wifiConnections | |||
| kai.battery | Subscribe to Knox Asset Intelligence notifications about battery-related events. | KAI_BATTERY_STATUS, KAI_BATTERY_LEVEL_TRIGGERED, KAI_BATTERY_CHARGING, KAI_BATTERY_LEVEL_SHIFT_START, KAI_BATTERY_LEVEL_SHIFT_END | |
| kai.app | Subscribe to Knox Asset Intelligence notifications about app usage and abnormal app events. | KAI_APP_ANR_FC, KAI_APP_USAGE_TIME_BATTERY, KAI_APP_USAGE_NETWORK, KAI_APP_USAGE_SCREENTIME | |
For detailed API specification, see Knox Asset Intelligence API reference.
Knox MSP Portal
| Scope name | Description | Applicable API endpoints |
|---|---|---|
| msp.customers | Add and delink MSP customers, as well as view and edit their information. | POST /msp/v1/managedCustomers |
| POST /msp/v1/managedCustomers/link | POST /msp/v1/managedCustomers/delink | |
| GET /msp/v1/managedCustomers | ||
| GET /msp/v1/managedCustomers/{customerId} | PUT /msp/v1/managedCustomers/{customerId} |
For detailed API specification, see Knox MSP Portal API reference.
Knox OAuth 2.0 Authentication — Authorization server operations
| Scope name | Description | Applicable API endpoints |
|---|---|---|
| Use your email address to verify your identity. | POST /ams/v1/oauth2/token | |
| openid | Use your Samsung Knox user identifier. | POST /ams/v1/oauth2/token |
For detailed API specification, see Knox OAuth 2.0 Authentication API reference.
On this page
Is this page helpful?