Chilkat Online Tools

Ruby / Salesforce Platform APIs / Update Credential

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "externalCredential": "test",
#   "authenticationProtocol": "Custom",
#   "principalName": "test",
#   "principalType": "NamedPrincipal",
#   "credentials": {
#     "testCredential": {
#       "value": "000000",
#       "encrypted": true
#     }
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("externalCredential","test")
json.UpdateString("authenticationProtocol","Custom")
json.UpdateString("principalName","test")
json.UpdateString("principalType","NamedPrincipal")
json.UpdateString("credentials.testCredential.value","000000")
json.UpdateBool("credentials.testCredential.encrypted",true)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/services/data/v{{version}}/named-credentials/credential",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "externalCredential": "test",
    "authenticationProtocol": "Custom",
    "principalName": "test",
    "principalType": "NamedPrincipal",
    "credentials": {
        "testCredential": {
            "value": "000000",
            "encrypted": true
        }
    }
}'
https://domain.com/services/data/v{{version}}/named-credentials/credential

Postman Collection Item JSON

{
  "name": "Update Credential",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"externalCredential\": \"test\",\n    \"authenticationProtocol\": \"Custom\",\n    \"principalName\": \"test\",\n    \"principalType\": \"NamedPrincipal\",\n    \"credentials\": {\n        \"testCredential\": {\n            \"value\": \"000000\",\n            \"encrypted\": true\n        }\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "credential"
      ]
    },
    "description": "Update a credential."
  },
  "response": [
  ]
}