Generating API Credentials

This article provides a step-by-step guide on how to generate and manage API credentials for Lenovo Device Orchestration (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.

API credentials should be used only by experienced IT administrators who have a clear understanding of the available API endpoints and their functionality. Before using these credentials in the LDO environment, review all relevant documentation to ensure you understand how the endpoints operate. Incorrect use may result in unintended impact on your environment.

Support for issues related to custom API usage, scripts, and troubleshooting API-generated outcomes is limited. LDO Support can assist with credential generation, authentication, and documented platform issues. However, customers are responsible for designing, implementing, testing, and maintaining their API integrations.

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:

Go to Organization & Settings > Organization Settings > organization Account.
Select API Credentials to open the Credentials panel. If there are no API credentials, you must generate them.
Click Generate.
A client ID and secret key are generated. You can copy them to the clipboard.

Store these credentials in a secure place and regenerate them periodically per your organization’s security policies

Modifying API Credentials

To change existing API credentials click Regenerate.
In the Regenerate Secret window, click Regenerate.
A new client ID and secret key will be issued.
The client ID and secret key do not expire until you regenerate a fresh pair.
After generating your credentials, use the appropriate URL based on the region where your organization's devices are located.

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.

Generate API bearer token using External API.

The URL - Base URL + /api/v1/auth/<organization_name>/token

The Base URL depends on your region whether NA or EU.

Body should be x-ww-form-urlencoded and should contain:

grant_type: client_credentials
client_secret: secret (from api credentials page)
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.

Download the Swagger Specification zip file which provides details about each API.
Extract the files in the folder.
Double-click to open the index.html. You see the LDO Device Insights (LDI is legacy) APIs home page in Swagger.
Generate a Bearer token.