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.
# {
# "masterLabel": "SamplePrivateLabel",
# "type": "SecuredEndpoint",
# "calloutUrl": "https://api.example.com",
# "externalCredentials": [
# {
# "developerName": "SampleExternalCredential"
# }
# ],
# "customHeaders": [
# {
# "headerName": "SampleHeader",
# "headerValue": "SampleValue",
# "sequenceNumber": 1
# }
# ],
# "calloutOptions": {
# "allowMergeFieldsInBody": false,
# "allowMergeFieldsInHeader": true,
# "generateAuthorizationHeader": true
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("masterLabel","SamplePrivateLabel")
json.UpdateString("type","SecuredEndpoint")
json.UpdateString("calloutUrl","https://api.example.com")
json.UpdateString("externalCredentials[0].developerName","SampleExternalCredential")
json.UpdateString("customHeaders[0].headerName","SampleHeader")
json.UpdateString("customHeaders[0].headerValue","SampleValue")
json.UpdateInt("customHeaders[0].sequenceNumber",1)
json.UpdateBool("calloutOptions.allowMergeFieldsInBody",false)
json.UpdateBool("calloutOptions.allowMergeFieldsInHeader",true)
json.UpdateBool("calloutOptions.generateAuthorizationHeader",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/named-credential-setup/:DEVELOPER_NAME",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "calloutOptions": {
# "allowMergeFieldsInBody": false,
# "allowMergeFieldsInHeader": true,
# "generateAuthorizationHeader": true
# },
# "calloutUrl": "https://api.example.com",
# "customHeaders": [
# {
# "headerName": "SampleHeader",
# "headerValue": "SampleValue",
# "id": "0pv2o000000PAv6AAG",
# "sequenceNumber": 1
# }
# ],
# "developerName": "SamplePrivate",
# "externalCredentials": [
# {
# "developerName": "SampleExternalCredential",
# "id": "0pt2o000000CaU0AAK",
# "masterLabel": "Sample External Credential",
# "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
# }
# ],
# "id": "0XA2o000000XaAQGA0",
# "masterLabel": "SamplePrivateLabel",
# "parameters": [
# ],
# "type": "SecuredEndpoint",
# "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
AllowMergeFieldsInBody = jResp.BoolOf("calloutOptions.allowMergeFieldsInBody")
AllowMergeFieldsInHeader = jResp.BoolOf("calloutOptions.allowMergeFieldsInHeader")
GenerateAuthorizationHeader = jResp.BoolOf("calloutOptions.generateAuthorizationHeader")
calloutUrl = jResp.stringOf("calloutUrl")
developerName = jResp.stringOf("developerName")
id = jResp.stringOf("id")
masterLabel = jResp.stringOf("masterLabel")
v_type = jResp.stringOf("type")
url = jResp.stringOf("url")
i = 0
count_i = jResp.SizeOfArray("customHeaders")
while i < count_i
jResp.put_I(i)
headerName = jResp.stringOf("customHeaders[i].headerName")
headerValue = jResp.stringOf("customHeaders[i].headerValue")
id = jResp.stringOf("customHeaders[i].id")
sequenceNumber = jResp.IntOf("customHeaders[i].sequenceNumber")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("externalCredentials")
while i < count_i
jResp.put_I(i)
developerName = jResp.stringOf("externalCredentials[i].developerName")
id = jResp.stringOf("externalCredentials[i].id")
masterLabel = jResp.stringOf("externalCredentials[i].masterLabel")
url = jResp.stringOf("externalCredentials[i].url")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("parameters")
while i < count_i
jResp.put_I(i)
i = i + 1
end
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"masterLabel": "SamplePrivateLabel",
"type": "SecuredEndpoint",
"calloutUrl": "https://api.example.com",
"externalCredentials": [
{
"developerName": "SampleExternalCredential"
}
],
"customHeaders": [
{
"headerName": "SampleHeader",
"headerValue": "SampleValue",
"sequenceNumber": 1
}
],
"calloutOptions": {
"allowMergeFieldsInBody": false,
"allowMergeFieldsInHeader": true,
"generateAuthorizationHeader": true
}
}'
https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Update Named Credential",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"named-credential-setup",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": ""
}
]
},
"description": "Update a named credential."
},
"response": [
{
"name": "Successful Update Named Credential",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"named-credential-setup",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "SamplePrivate"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:54:57 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n },\n \"calloutUrl\": \"https://api.example.com\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"id\": \"0pv2o000000PAv6AAG\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SamplePrivate\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n }\n ],\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"parameters\": [],\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n}"
}
]
}
