Skip to main content

GET /api/v1/boarding/managementSettings

Use this method to return the UDS Portal credentials.

Note
This REST API requires Lenovo XClarity Orchestrator v2.0.0 or later.

Authentication​

Authentication with user name and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/boarding/managementSettings

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.

Response body​

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

AttributesTypeDescription
udsClientIdStringClient ID

If the client ID is not saved, this value is null.

udsClientSecretBooleanIndicates whether the secret exists. This can be one of the following values.
  • true. The client secret exists.
  • false. The client secret does not exist.
The following example is returned if the request is successful.
{
    udsClientId: "EDGE-ISG-BridgeAccount",
    udsClientSecret: "true"
}