Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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": "Sample External Credential",
# "authenticationProtocol": "Custom",
# "principals": [
# {
# "principalName": "SamplePrincipal",
# "principalType": "NamedPrincipal",
# "sequenceNumber": 1
# }
# ],
# "customHeaders": [
# {
# "headerName": "SampleHeader",
# "headerValue": "SampleHeaderValue",
# "sequenceNumber": 1
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "masterLabel" "Sample External Credential"
CkJsonObject_UpdateString $json "authenticationProtocol" "Custom"
CkJsonObject_UpdateString $json "principals[0].principalName" "SamplePrincipal"
CkJsonObject_UpdateString $json "principals[0].principalType" "NamedPrincipal"
CkJsonObject_UpdateInt $json "principals[0].sequenceNumber" 1
CkJsonObject_UpdateString $json "customHeaders[0].headerName" "SampleHeader"
CkJsonObject_UpdateString $json "customHeaders[0].headerValue" "SampleHeaderValue"
CkJsonObject_UpdateInt $json "customHeaders[0].sequenceNumber" 1
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set resp [new_CkHttpResponse]
set success [CkHttp_HttpSb $http "PUT" "https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME" $sbRequestBody "utf-8" "application/json" $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "authenticationProtocol": "Custom",
# "authenticationStatus": "Unknown",
# "customHeaders": [
# {
# "headerName": "SampleHeader",
# "headerValue": "SampleHeaderValue",
# "id": "0pu2o000000KymkAAC",
# "sequenceNumber": 1
# }
# ],
# "developerName": "SampleExternalCredential",
# "id": "0pt2o000000CaU0AAK",
# "masterLabel": "Sample External Credential",
# "parameters": [
# ],
# "principals": [
# {
# "authenticationStatus": "Unknown",
# "id": "0pu2o000000KymjAAC",
# "parameters": [
# ],
# "principalAccess": [
# ],
# "principalName": "SamplePrincipal",
# "principalType": "NamedPrincipal",
# "sequenceNumber": 1
# }
# ],
# "relatedNamedCredentials": [
# {
# "developerName": "SamplePrivate",
# "id": "0XA2o000000XaAQGA0",
# "masterLabel": "SamplePrivateLabel",
# "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
# }
# ],
# "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set authenticationProtocol [CkJsonObject_stringOf $jResp "authenticationProtocol"]
set authenticationStatus [CkJsonObject_stringOf $jResp "authenticationStatus"]
set developerName [CkJsonObject_stringOf $jResp "developerName"]
set id [CkJsonObject_stringOf $jResp "id"]
set masterLabel [CkJsonObject_stringOf $jResp "masterLabel"]
set url [CkJsonObject_stringOf $jResp "url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "customHeaders"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set headerName [CkJsonObject_stringOf $jResp "customHeaders[i].headerName"]
set headerValue [CkJsonObject_stringOf $jResp "customHeaders[i].headerValue"]
set id [CkJsonObject_stringOf $jResp "customHeaders[i].id"]
set sequenceNumber [CkJsonObject_IntOf $jResp "customHeaders[i].sequenceNumber"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "parameters"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "principals"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set authenticationStatus [CkJsonObject_stringOf $jResp "principals[i].authenticationStatus"]
set id [CkJsonObject_stringOf $jResp "principals[i].id"]
set principalName [CkJsonObject_stringOf $jResp "principals[i].principalName"]
set principalType [CkJsonObject_stringOf $jResp "principals[i].principalType"]
set sequenceNumber [CkJsonObject_IntOf $jResp "principals[i].sequenceNumber"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "principals[i].parameters"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "principals[i].principalAccess"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "relatedNamedCredentials"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set developerName [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].developerName"]
set id [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].id"]
set masterLabel [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].masterLabel"]
set url [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].url"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"masterLabel": "Sample External Credential",
"authenticationProtocol": "Custom",
"principals": [
{
"principalName": "SamplePrincipal",
"principalType": "NamedPrincipal",
"sequenceNumber": 1
}
],
"customHeaders": [
{
"headerName": "SampleHeader",
"headerValue": "SampleHeaderValue",
"sequenceNumber": 1
}
]
}'
https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Update External Credential",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": ""
}
]
},
"description": "Update an external credential."
},
"response": [
{
"name": "Successful Update External Credential",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "SampleExternalCredential"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:55:19 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 \"authenticationProtocol\": \"Custom\",\n \"authenticationStatus\": \"Unknown\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"id\": \"0pu2o000000KymkAAC\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"parameters\": [],\n \"principals\": [\n {\n \"authenticationStatus\": \"Unknown\",\n \"id\": \"0pu2o000000KymjAAC\",\n \"parameters\": [],\n \"principalAccess\": [],\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"SamplePrivate\",\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}"
}
]
}
