Generating API Credentials

Generating API Credentials

This article provides a step-by-step guide on how to generate and manage API credentials for Lenovo Device Operations (LDO) portal. It covers the process of creating Client ID and Secret Key, obtaining a Bearer Token for authentication, and accessing different API endpoints. Additionally, it explains how to use Swagger documentation to explore and test available API methods.

You must have an Organization Administration account in LDO portal to generate API credentials.

Generate API Credentials

Before you use LDO APIs, you must generate API credentials in your LDO account. Follow these steps:
  1. Click Device Insights from the top navigation drop-down menu. 



  2. Navigate to Configuration / Device Insights Settings.



  3. Click API Credentials to open the Credentials panel.
    If there are no API credentials, you must generate them.
  4. Click Generate.
    A Client ID and Secret key are generated. You can copy them to the clipboard.
    1. Store these credentials in a secure place and regenerate them periodically per your organization’s security policies.
    2. If you want to change the existing API credentials, you must generate a new one.
  5. Click Regenerate.



  6. In the Regenerate Secret window, click Regenerate.



  7. A new Client ID and Secret key will be issued.

  1. The Client ID and Secret key do not expire until you regenerate a fresh pair.

  2. After generating your credentials, use the appropriate URL based on the region where your organization's devices are located.
    1. NAEA: https://auth.naea1.uds.lenovo.com 
    2. EU: https://auth.euwe1.uds.lenovo.com


After you generate a new pair of Client ID and Secret key, the older pair gets invalid.

Obtain a Bearer Token 

The bearer token is a type of an access token that uses Auth 2.0 with a 30-minute expiration period. To obtain a new access token, your application must send this bearer token along with your Client ID to the authentication server. This verification process ensures that only the authorized application (the one for which the bearer token was originally issued) can request new access tokens.
  1. Generate API bearer token using External API.
  1. The URL -  Base URL + /api/v1/auth/<organization_name>/token
  1. The Base URL depends on your region whether NA or EU.
  1. Body should be x-ww-form-urlencoded and should contain:
      1. grant_type: client_credentials
      2. client_secret: secret (from api credentials page)
      3. client_id: id (from api credentials page)
Generate a new bearer token when it expires after 30 minutes.




Explore API Operations with Swagger

Swagger specification archive contains a folder with an index.html file and some other JavaScript files.
  1. Download the Swagger Specification zip file from the Support site which provides details about each API.
  2. Extract the files in the folder. 


  3. Double-click to open the index.html. You see the LDO Device Insights (LDI is legacy) APIs home page in Swagger.


  4. Generate a Bearer token.

Try APIs

  1. Select an API method in Swagger.


  2. Use the bearer token in the call. 
  3. Click Try it out. 

Examples of API Methods

Authentication - API token session


Lenovo SDK snapshot




HTTP Response


Negative API Sample:  Groovy ACME Test


HTTP Request

HTTP Response


    • Related Articles

    • Generating Support Tickets

      Support Tickets LDO is a powerful tool packed with features to support enterprise device management. One feature that stands out for users with Lenovo devices is LDO Device Insights Support Ticketing. With this functionality, users can easily create ...

    • Deploying Lenovo Device Orchestration Agent in Intune

      This article provides instructions for creating an Intune application to deploy the Lenovo Device Orchestration Agent. Download the LDO Agent and set the expiry date of the agent. In the LDO console, go to Device Management > Devices. Click on the ...

    • Setting Up LDO ServiceNow Integration

      Prerequisites Before configuring the integration between LDO and ServiceNow, ensure the following prerequisites are met to establish proper synchronization: Terminology Alignment In LDO, a physical device (such as a laptop, desktop, or server) is ...

    • Using ThinkCentre Customization

      ThinkCentre Customization is designed exclusively for ThinkCentre devices running Windows and requires a Basic license. It offers powerful features that allow Admins to remotely access devices and perform specific operations that require BIOS ...

    • Using Accessories Inventory

      The Accessories Inventory page summarizes key details about all docking stations that are currently or were previously connected to the organization's devices. It includes basic docking station telemetry, such as Product Family, Device Name, Serial ...