PUT /api/v1/boarding/managementSettings
Use this method to retrieve and verify the UDS Portal credentials, and then save the credentials in the vault.
Note
This REST API requires Lenovo XClarity Orchestrator v2.0 or later.
Authentication
Authentication with username and password is required.
Resource URI
PUT https://{orchestrator_server_IP}/api/v1/boarding/managementSettings
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| udsClientId | Required | String | Client ID | ||
| udsClientSecret | Required | String | Client secret | ||
The following example retrieves and saves the UDS Portal credentials.
{
udsClientId: "EDGE-ISG-BridgeAccount",
udsClientSecret: "rbDeFXO5ll3SmEh4yR7OqhTz07W1m6M7"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The 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).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| {message_attributes} | varies | Status messages (see Status messages) | ||
Give documentation feedback