Update a specific application credential
Where an application has multiple pairs of clientID/clientSecret credentials, use this method to update a specific pair of credentials by supplying its credential Id. You can update the clientID, clientSecret, or both. Note that when updating the clientID, the API checks that there is no other credentials resource with the same clientID. The input clientSecret value for this API must be a Base64 encoded SHA-256 hash of the original plain-text clientSecret. Also, note that many tools will automatically encode a SHA-256 value as a hex string so that it is human readable. This API requires that the SHA-256 value be encoded using Base64 instead. You can use the following Linux command to convert a hex encoded SHA-256 value to Base64 encoding: echo "HEX_ENCODED_SHA256_VALUE" | xxd -r -p | base64
Sample method invocation
curl -X PUT \
-u userid:pw \
-d '
{
"clientID": string,
"clientSecret": string,
"description": string
}
' \
https://<mgmt-cluster-ip>/v1/portal/orgs/{orgID}/apps/{appID}/credentials/{credentialId}
Parameters |
Path Parameters
orgID : Organization ID appID : Application ID credentialId : Application Credential ID |
Response content | MIME type: application/json
|
Status codes |
200 : The specific application credentials were updated. 400 : Invalid or missing request payload properties. 401 : Authentication failed. Valid username and password are required. 403 : Authenticated user is not a member of orgs/{orgID} 404 : Resource not found. 409 : There is already another application credentials resource with same clientID. 500 : An internal error has occurred. |
Available since | API Connect 5.0.0 |