PUT /storedCredentials/{id}
Use this method to modify the properties for a specific stored credential.
Authentication
Authentication with username 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 | ||
The following example modifies a stored credential.
{
"description": "CME44",
"id": "603",
"password: "passwr0d",
"userName": "USERID"
}
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. |
| 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 | ||
|---|---|---|---|---|
| result | String | Results of the request. This can be one of the following values.
| ||
| 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 | ||
The following example is returned if the request is successful.
{
"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."
}]
}
Give documentation feedback