XClarity Administrator - GET /storedCredentials/<id>

Use this GET method to retrieve information about 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

GET 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

None

Response codes

Code	Description
200	OK
400	Bad request
401	Unauthorized
403	Forbidden
404	Not found
409	Conflict
500	Internal server error

Response body

Attributes			Type	Description
response			Object	Information about each stored credential
	description		String	Description of the stored-credential
	id		String	ID of the stored-credential
	userName		String	Name of the stored-credential, if applicable
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.
messages			Array	Information about one or more messages
	explanation		String	Additional information to clarify the reason for the message
	id		String	Message identifier of a returned message
	recovery		Array	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
	text		String	Message text associated with the message identifier

Response example

{
   "response": {
      "description": "CME44",
      "id": "602",

      "userName": "USERID"
   },
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "explanation": "",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      }
   }]
}