- *BASICS*
- The Knox Ecosystem
- Samsung Knox Portal
- Knox Cloud Services
- General Knox Support
- Knox Licenses
- *FOR IT ADMINS*
- Knox Suite
- Knox Platform for Enterprise
- Introduction
- White paper
- 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
- Introduction
- Get started
- Features
- Register resellers
- Add an admin
- Create profiles
- Google device owner support
- MDM compatibility matrices
- Device users
- Activity log
- Enroll and unenroll devices
- Configure devices
- Provide KME feedback
- Use the Knox Deployment App (KDA)
- Recover Google FRP locked devices using KME
- Role-based access control (RBAC)
- Release notes
- FAQs
- Troubleshoot
- KBAs
- On-Premise
- Knox Configure
- Mobile
- Wearables
- Shared Device
- Knox Capture
- Introduction
- How it works
- How-to videos
- 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
- Release notes
- FAQs
- Troubleshoot
- Knox Manage
- Introduction
- How-to videos
- Get started
- Configure
- Licenses
- Organization
- Users
- Sync user information
- Groups
- Devices
- Content
- Applications
- Profile
- Knox E-FOTA
- Certificates
- Advanced settings
- Monitor
- Kiosk devices
- Remote Support
- Active Directory
- Microsoft Exchange
- Mobile Admin
- Appendix
- Release notes
- FAQs
- KBAs
- Knox E-FOTA
- Introduction
- White paper
- Knox E-FOTA One
- Introduction
- How-to videos
- Get started
- Features
- EMM integration
- Appendix
- Release notes
- FAQs
- Troubleshoot
- KBAs
- Migrate from Knox E-FOTA Advanced to Knox E-FOTA One
- Knox E-FOTA Advanced
- Knox E-FOTA on MDM
- Samsung Care+ for Business
- *FOR RESELLERS*
- Knox Deployment Program
- *FOR MANAGED SERVICE PROVIDERS*
- 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:
1. Navigate to Advanced > EMM API > API Client.
2. On the “API Client” page, click Add.
3. 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.
4. 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:
1. Navigate to Advanced > EMM API > API Client.
2. On the “API Client” page, click the check box for the API client you want to copy, and the click Copy.
3. 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.
4. Click Save.
Modifying API clients
You can modify the information of an existing API client.
To modify an API client, complete the following steps:
1. Navigate to Advanced > EMM API > API Client.
2. On the “API Client” page, click the check box for the API client you want to modify the information of, and the click Modify.
3. 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.
4. Click Save.
Deleting API clients
You can delete API clients from the list.
To delete an API client, complete the following steps:
1. Navigate to Advanced > EMM API > API Client.
2. On the “API Client” page, click the check box for the API client you want to delete from the list, and the click Delete.
3. In the “Delete“ window, click OK.
Activating or deactivating API clients
To activate or deactivate API client, complete the following steps:
1. Navigate to Advanced > EMM API > API Client.
2. On the “API Client” page, click the check box for the API client you want to activate or deactivate, and the click Change Status.
3. 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.