PUT /storedCredentials/<id>

Use PUT to modify the properties for a specific stored credential.

Note: This API requires Lenovo XClarity Administrator v1.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/storedCredentials/<id>

where <id> is the ID of the stored credential. To obtain the stored credential ID, use GET /storedCredentials or POST /storedCredentials.

Query parameters

None

Request body

Attributes Required / Optional Type Description
description Optional String Description of the stored credential
Tip: Use this attribute to differentiate between accounts when users and stored credentials have the same name.
id Required String Name of the stored credential to be modified
password Required String Password for the stored credential
userName Required String Name of the stored credential

Request example

{
   "description": "CME44",
   "id": "603",
   "password: "passwr0d",
   "userName": "USERID"
}

Response codes

Code Description
200 OK. The stored-credential account was created successfully.
400 Bad request. An argument is missing or not valid. A descriptive error message will be returned in the body.
404 Not found. The user was not found. A descriptive error message will be returned in the body.
409 Conflict. One or more of the following conflicts has occurred:
  • An account with the specified user name exists already.

  • A violation of the security policy occurred.

500 Internal server error

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
   "result": "success",
   "messages": [{
      "explanation": "The request to modify the storage account ID USER2 was successful.",
      "id": "FQXHMSE0260I",
      "recovery": {
         "text": "Information only; no action is required.",
         "URL": ""
      },
      "text": "The request to modify the storage account ID USER2 completed successfully."
   }]
}