GET /storedCredentials/{id}
Use this method to return information about a specific stored credential.
Authentication
Authentication with username 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 | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
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.
| ||
| 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 | ||
The following example is returned if the request is successful when an administrator specifies the includePassowrd=true query parameter.
{
"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": ""
}
}]
}
Give documentation feedback