Scopes for Knox cloud services APIs
Last updated September 25th, 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, including devices, diagnostics logs, and network settings. | 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/devices/groups | |||
| GET /kai/v1/devices/groups | |||
| POST /kai/v1/diagnosticsLogs | |||
| GET /kai/v1/diagnosticsLogs | |||
| GET /kai/v1/network/wifiDisconnections | |||
| GET /kai/v1/network/wifiConnections | |||
| POST /kai/v1/miscellaneous/getKspStatus | |||
| 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 and group information. | POST /kai/v1/devices/getDevices | |
| POST /kai/v1/devices/groups | |||
| GET /kai/v1/devices/groups | |||
| kai.diagnostics | Request and view Knox Asset Intelligence diagnostics logs. | POST /kai/v1/diagnosticsLogs | KAI_DEVICE_DIAGNOSTICSLOGS |
| GET /kai/v1/diagnosticsLogs | |||
| 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 | |
| kai.miscellaneous | View the deployment status of your Knox Service Plugin policies. | POST /kai/v1/miscellaneous/getKspStatus | |
For detailed API specification, see Knox Asset Intelligence API reference.
Knox Mobile Enrollment
| Scope name | Description | Applicable API endpoints |
|---|---|---|
| kme | Manage all Knox Mobile Enrollment functionality, including profiles, devices, and resellers. | All endpoints in Knox Mobile Enrollment API. |
| kme.profiles | View, create, update, and delete Knox Mobile Enrollment profiles. | POST /kcs/v1/kme/profiles/create |
| POST /kcs/v1/kme/profiles/createAsync/ | ||
| PUT /kcs/v1/kme/profiles/{profileId} | GET /kcs/v1/kme/profiles/list | |
| GET /kcs/v1/kme/profiles/status | ||
| GET /kcs/v1/kme/profiles/{id}/get | DELETE /kcs/v1/kme/profiles/{id} | |
| kme.profiles:reads | View Knox Mobile Enrollment profiles. | GET /kcs/v1/kme/profiles/list |
| GET /kcs/v1/kme/profiles/status | GET /kcs/v1/kme/profiles/{id}/get | |
| kme.profiles:write | View, update, and delete Knox Mobile Enrollment profiles. | POST /kcs/v1/kme/profiles/create |
| POST /kcs/v1/kme/profiles/createAsync/ | PUT /kcs/v1/kme/profiles/{profileId} | |
| DELETE /kcs/v1/kme/profiles/{id} | ||
| kme.devices | Manage all functionality related to devices in Knox Mobile Enrollment, including profile management, deletion, and uploads. | PUT /kcs/v1/kme/devices/assignProfile |
| POST /kcs/v1/kme/devices/delete | GET /kcs/v1/kme/devices/list | |
| PUT /kcs/v1/kme/devices/unassignProfile | ||
| PUT /kcs/v2/kme/devices/unassignProfile | POST /kcs/v1/kme/devices/uploads/approvals | GET /kcs/v1/kme/devices/uploads/list |
| kme.devices:read | View Knox Mobile Enrollment device information. | GET /kcs/v1/kme/devices/list |
| GET /kcs/v1/kme/devices/uploads/list | ||
| kme.devices:write | Assign, unassign, and delete profiles, as well as approve device uploads. | PUT /kcs/v1/kme/devices/assignProfile |
| POST /kcs/v1/kme/devices/delete | PUT /kcs/v1/kme/devices/unassignProfile | |
| PUT /kcs/v2/kme/devices/unassignProfile | ||
| POST /kcs/v1/kme/devices/uploads/approvals | ||
| kme.reseller | Manage all functionality related to Knox Mobile Enrollment resellers, including approvals and profile aliases. | POST /kcs/v1/kme/reseller/approvals |
| POST /kcs/v1/kme/reseller/profilealias | PUT /kcs/v1/kme/reseller/profilealias/{profileAliasId} | |
| DELETE /kcs/v1/kme/reseller/profilealias/{profileAliasId} |
For detailed API specification, see Knox Mobile Enrollment 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?