- Basics
- About Knox
- Knox licenses
- Knox white paper
- Sign up for Samsung Knox
- Latest release notes
- General Knox FAQ
- General Knox KBAs
- Submit a support ticket
- User Acceptance Testing
- For IT admins
- Knox Admin Portal
- Knox Suite
- Knox Platform for Enterprise
- Introduction
- How-to videos
- Before you begin
- Get started with UEMs
- Introduction
- Blackberry UEM
- Citrix Endpoint Management
- FAMOC
- IBM MaaS360
- Microsoft Intune
- MobileIron Cloud
- MobileIron Core
- Samsung Knox Manage
- SOTI MobiControl
- VMware Workspace ONE UEM
- Knox Service Plugin
- Release notes
- Migrate to Android 11
- FAQs
- Troubleshoot
- KBAs
- Knox Mobile Enrollment
- Knox Configure
- Mobile
- Wearables
- Shared Device
- FAQ
- KBAs
- Knox Capture
- Welcome
- Overview
- How-to guides
- Manage licenses
- Scanning profiles
- Apps and activities
- Scan engine settings
- Keystroke output rules
- Export configuration and deploy through EMM
- Set the camera scan trigger
- Connect a hardware scanner
- Configure the output path
- Use the scanner overlay
- Check a configuration in test mode
- Use intent output
- Knox Capture AR
- Get started
- How-to videos
- Release notes
- FAQ
- KBAs
- Troubleshoot
- Knox Capture: Scandit Edition
- Introduction
- How it works
- IT admins: Get started
- Getting started with Knox Capture
- Step 1: Launch Knox Capture
- Step 2: Create a scanning profile
- Step 3: Select apps and activities
- Step 4: Configure the scanner
- Step 5: Set keystroke output rules
- Step 6: Test apps in your configuration
- Step 7: Share your configuration
- Step 8: Deploy Knox Capture in Managed mode
- End users: Get started
- Features
- Knox Asset Intelligence
- Knox Manage
- Introduction
- How-to videos
- Get started
- Video: Getting started with Knox Manage
- Integration with Managed Service Provider
- Access Knox Manage
- Configure basic environments
- Create user accounts
- Create groups
- Create organization
- Set up devices and profiles
- Create a new profile
- Assign profiles to groups and organizations
- Enroll devices
- Shared Android device quickstart
- Non-shared Android device enrollment quickstart
- Android Management API device enrollment quickstart
- Apple User Enrollment quickstart
- View device information
- Apply profiles to organizations
- Set up Knox Manage deployment with a Knox Suite license
- Manage Chromebooks
- Manage Android devices with the Android Management API
- Manage Shared iPads
- Configure
- Licenses
- Organization
- Users
- Sync user information
- Groups
- Devices
- Content
- Applications
- Profile
- Knox E-FOTA
- Certificates
- Advanced settings
- Monitor
- Kiosk devices
- Knox Remote Support
- Active Directory
- Microsoft Exchange
- Mobile Admin
- Appendix
- Release notes
- Features
- FAQ
- KBAs
- Knox E-FOTA
- Introduction
- How-to videos
- Get started
- Features
- EMM integration
- Appendix
- Release notes
- FAQ
- KBAs
- Troubleshoot
- Knox E-FOTA On-Premises
- Legacy Knox E-FOTA products
- Knox Guard
- Introduction
- How-to video
- Get started
- Using Knox Guard
- Dashboard
- Manage devices
- Device management
- Accept or reject devices
- Upload devices
- Delete devices
- Complete device management
- Send notifications
- Enable or disable SIM control
- Download devices as CSV
- View device log
- View device deletion log
- Start and stop blinking reminder
- Lock and unlock devices
- Update lock message
- Send relock timestamp
- Turn on/off relock reminder
- Manage policies
- Manage licenses
- Manage resellers
- Manage admins and roles
- Activity log
- Knox Deployment App
- Release notes
- FAQ
- KBAs
- Support
- Knox Guard REST API
- Samsung Care+ for Business
- For Knox Partners
- Knox Deployment Program
- Knox MSP Program
Manage API clients
Add and manage API clients via Knox Manage. Management of API clients includes copying, modifying, deleting, and activating or deactivating API client accounts.
Viewing API clients
Navigate to Advanced > EMM API > API Client to view all the client information on the API Client page.
To view detailed information of a specific API client, click the client ID of a specific API client on the list.
Adding API clients
To add an API client, complete the following steps:
- Navigate to Advanced > EMM API > API Client.
- On the API Client page, click Add.
-
In the Add API Client window, enter the following API client information:
- Client ID — Assign a unique client ID to use for a token request.
- Password — Enter a new password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
- Token Validity(sec) — Enter the access time for when the Open API is called.
- API Permission Level — Grant the client either Management or Read Only permissions. Read-only clients can only call the GET method of operations, and can't register any changes.
- Click Save.
Copying API clients
Copy an existing API client and create a new API client. When you reuse a client information, you cannot load the client ID and password of the existing API client.
To copy an API client, complete the following steps:
- Navigate to Advanced > EMM API > API Client.
- On the API Client page, click the check box for the API client you want to copy, and the click Copy.
-
In the Copy API Client window, enter the following API client information:
- Client ID — Assign a unique client ID to use for a token request. The API client ID cannot be modified.
- Password — Enter a new password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
- Token Validity(sec) — Displays the copied access time for when the Open API is called.
- API Permission Level — Grant the client either Management or Read Only permissions. Read-only clients can only call the GET method of operations, and can't register any changes.
- Click Save.
Modifying API clients
You can modify the information of an existing API client.
To modify an API client, complete the following steps:
- Navigate to Advanced > EMM API > API Client.
- On the API Client page, click the check box for the API client you want to modify the information of, and the click Modify.
- In the Modify API Client window, modify the following client information:
- Client ID — Displays the API client ID.
- Password — Modify the password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
- Token Validity(sec) — Modify access time for when the Open API is called.
- API Permission Level — Grant the client either Management or Read Only permissions. Read-only clients can only call the GET method of operations, and can't register any changes.
- Click Save.
Deleting API clients
You can delete API clients from the list.
To delete an API client, complete the following steps:
- Navigate to Advanced > EMM API > API Client.
- On the API Client page, click the check box for the API client you want to delete from the list, and the click Delete.
- In the Delete window, click OK.
Activating or deactivating API clients
To activate or deactivate API client, complete the following steps:
- Navigate to Advanced > EMM API > API Client.
- On the API Client page, click the check box for the API client you want to activate or deactivate, and the click Change Status.
- In the Change Status window, click OK.
The status of the API client changes to Active or Inactive depending on its previous status. Once activated, the Open API can be called using the API client. Once deactivated, the Open API cannot be called using the API client.