- URL:https://<root>/cloud/providers/<providerID>/credential/update(POST only)
- Required Capability:Default administrator role
- Version Introduced:11.2
Description
The credential/update operation updates provider credential information. Its a security best practice to rotate credentials at regular intervals if the cloud provider utilizes key-based authentication models. To update credentials, the request needs to include the credential information for the provider, which is returned by the Providers resource.
Once submitted, the request will return a job ID. The HTML view returns a link that can be used to access the job page for the request. Otherwise, to access the job resource you can make a request of the following form:
https://organization.domain.com/context/admin/jobs/<jobID>
Request parameters
Parameter | Details |
---|---|
credential | The updated connection information. The current connection information can be retrieved from the Providers resource and modified with the updated credentials. Examples
|
f | The response format. The default format is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the credential/update operation:
POST /context/admin/clouds/providers/xxmrejycd2/credential/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
credential={"type": "STORAGE-ACCOUNT-KEY","secret": {"storageAccountName": "{crypt}R68p/cvTUo1LmRcgXJ5U07WKv936mnCe","storageAccountKey": "{crypt}+1FSvRmPvGDJXo1FY5ug9vcxrlAuZ+QN}}&f=pjson&token= m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw
JSON Response example
{
"cloudCredentialRotationJobId": j386a7e57-bf8b-4765-ab96-aa8b71bbf7d3",
"message": "A cloud credentials rotation job is in-progress"
}