Home / Knox Configure /

Get started

Last updated May 20th, 2026

This guide provides step-by-step instructions to integrate Knox Configure capabilities into your web services.

Before you begin

Before you start the integration process, ensure you have the following:

  • A valid Samsung Knox account with Knox Configure enabled
  • Familiarity with REST APIs and authentication mechanisms
  • A development environment capable of making HTTP requests
  • Devices that support Knox Configure (Samsung devices with Knox support)

Step 1: Sign up for Knox Configure

  1. Register for a Samsung Knox account.
  2. Log in to your account and apply for the Knox Configure service from the overview page. For additional information, see the Knox Configure Admin Guide.

Step 2: Request API access

To request access to the Cloud Apps menu on the navigation pane of Knox Developer Portal, send an email to knoxapi@samsungknox.com with the subject line “Cloud Apps feature”. Include the following details in your email:

  • Company name
  • Country
  • Email address associated with your Samsung Knox account.
  • List of Knox cloud services APIs you want to use.
  • Description of your use cases.

If you need assistance, create a support ticket.

Apply for Knox cloud services API access by sending an email to knoxapi@samsungknox.com with your user and tenant information. If you need assistance, create a support ticket.

Step 3: Generate access token

After you get access to the Cloud Apps feature:

  1. Go to the Knox Developer Portal.

  2. Register a cloud app to get its client ID and client secret.

  3. Generate an access token using the client ID and client secret.

  1. Download your unique key pair and Client Identifier from the Knox Cloud APIs portal. For security purposes, you can restrict your Client Identifier to certain IP addresses. The Client Identifier can be re-generated through the console, but must be bound to the downloaded certificate, as described in the Knox Cloud APIs integration guide.

  2. Call the legacy authentication endpoint to generate your x-knox-apitoken.

For security reasons, the access token has an expiry of 30 minutes. Regenerate as specified in the Knox Cloud APIs integration guide.

Step 4: Test your access token

Ensure that your access token is correctly configured by making a test call to any of the Knox Configure API endpoints, such as Get devices. See the Knox Configure API v2 for more details.

curl --location 'https://api.samsungknox.com/kc/v2/devices/getDevices' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer {AUTH_TOKEN}' \
     --data '{
         "pageNum": 0,
         "pageSize": 1,
         "deviceIds": [],
         "profileIds": [],
         "sortBy": "updateTime",
         "sortOrder": "descending",
         "deviceState": []
     }'

Ensure that your access token is correctly configured by making a test call to any of the Knox Configure API endpoints, such as ‘Get devices’. See Knox Configure API for more details.

curl --location 'https://us-kcs-api.samsungknox.com/kcs/v1/kc/devices' \
     --header 'x-knox-apitoken: {AUTH_TOKEN}'

Step 5: Verify your integration

Make a test call to any endpoint in the Knox Configure API to ensure your integration was successful. For example, try retrieving information about devices using the v2 Get devices endpoint. A successful response will look like this:

{
  "code": "2000000",
  "message": "SUCCESS",
  "pageNum": 0,
  "pageSize": 1,
  "totalCount": 1,
  "totalPages": 1,
  "size": 1,
  "devices": [
    {
      "id": "device123",
      "imei": "123456789012345",
      "model": "SM-G991U",
      "profileId": "profile456",
      "status": "CONFIGURED",
      "lastUpdated": "2023-01-15T10:30:00Z"
    }
  ]
}

On this page

Is this page helpful?