Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"masterLabel","Sample External Credential")
CkJsonObject::ckUpdateString(json,"authenticationProtocol","Custom")
CkJsonObject::ckUpdateString(json,"principals[0].principalName","SamplePrincipal")
CkJsonObject::ckUpdateString(json,"principals[0].principalType","NamedPrincipal")
CkJsonObject::ckUpdateInt(json,"principals[0].sequenceNumber",1)
CkJsonObject::ckUpdateString(json,"customHeaders[0].headerName","SampleHeader")
CkJsonObject::ckUpdateString(json,"customHeaders[0].headerValue","SampleHeaderValue")
CkJsonObject::ckUpdateInt(json,"customHeaders[0].sequenceNumber",1)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
headerName.s
headerValue.s
sequenceNumber.i
principalName.s
principalType.s
j.i
count_j.i
authenticationProtocol.s = CkJsonObject::ckStringOf(jResp,"authenticationProtocol")
authenticationStatus.s = CkJsonObject::ckStringOf(jResp,"authenticationStatus")
developerName.s = CkJsonObject::ckStringOf(jResp,"developerName")
id.s = CkJsonObject::ckStringOf(jResp,"id")
masterLabel.s = CkJsonObject::ckStringOf(jResp,"masterLabel")
url.s = CkJsonObject::ckStringOf(jResp,"url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"customHeaders")
While i < count_i
CkJsonObject::setCkI(jResp, i)
headerName = CkJsonObject::ckStringOf(jResp,"customHeaders[i].headerName")
headerValue = CkJsonObject::ckStringOf(jResp,"customHeaders[i].headerValue")
id = CkJsonObject::ckStringOf(jResp,"customHeaders[i].id")
sequenceNumber = CkJsonObject::ckIntOf(jResp,"customHeaders[i].sequenceNumber")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"parameters")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"principals")
While i < count_i
CkJsonObject::setCkI(jResp, i)
authenticationStatus = CkJsonObject::ckStringOf(jResp,"principals[i].authenticationStatus")
id = CkJsonObject::ckStringOf(jResp,"principals[i].id")
principalName = CkJsonObject::ckStringOf(jResp,"principals[i].principalName")
principalType = CkJsonObject::ckStringOf(jResp,"principals[i].principalType")
sequenceNumber = CkJsonObject::ckIntOf(jResp,"principals[i].sequenceNumber")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"principals[i].parameters")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"principals[i].principalAccess")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"relatedNamedCredentials")
While i < count_i
CkJsonObject::setCkI(jResp, i)
developerName = CkJsonObject::ckStringOf(jResp,"relatedNamedCredentials[i].developerName")
id = CkJsonObject::ckStringOf(jResp,"relatedNamedCredentials[i].id")
masterLabel = CkJsonObject::ckStringOf(jResp,"relatedNamedCredentials[i].masterLabel")
url = CkJsonObject::ckStringOf(jResp,"relatedNamedCredentials[i].url")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
