Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *headerName;
const wchar_t *headerValue;
int sequenceNumber;
const wchar_t *principalName;
const wchar_t *principalType;
int j;
int count_j;
const wchar_t *authenticationProtocol;
const wchar_t *authenticationStatus;
const wchar_t *developerName;
const wchar_t *id;
const wchar_t *masterLabel;
const wchar_t *url;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// 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 = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"masterLabel",L"Sample External Credential");
CkJsonObjectW_UpdateString(json,L"authenticationProtocol",L"Custom");
CkJsonObjectW_UpdateString(json,L"principals[0].principalName",L"SamplePrincipal");
CkJsonObjectW_UpdateString(json,L"principals[0].principalType",L"NamedPrincipal");
CkJsonObjectW_UpdateInt(json,L"principals[0].sequenceNumber",1);
CkJsonObjectW_UpdateString(json,L"customHeaders[0].headerName",L"SampleHeader");
CkJsonObjectW_UpdateString(json,L"customHeaders[0].headerValue",L"SampleHeaderValue");
CkJsonObjectW_UpdateInt(json,L"customHeaders[0].sequenceNumber",1);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
authenticationProtocol = CkJsonObjectW_stringOf(jResp,L"authenticationProtocol");
authenticationStatus = CkJsonObjectW_stringOf(jResp,L"authenticationStatus");
developerName = CkJsonObjectW_stringOf(jResp,L"developerName");
id = CkJsonObjectW_stringOf(jResp,L"id");
masterLabel = CkJsonObjectW_stringOf(jResp,L"masterLabel");
url = CkJsonObjectW_stringOf(jResp,L"url");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"customHeaders");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
headerName = CkJsonObjectW_stringOf(jResp,L"customHeaders[i].headerName");
headerValue = CkJsonObjectW_stringOf(jResp,L"customHeaders[i].headerValue");
id = CkJsonObjectW_stringOf(jResp,L"customHeaders[i].id");
sequenceNumber = CkJsonObjectW_IntOf(jResp,L"customHeaders[i].sequenceNumber");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"parameters");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"principals");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
authenticationStatus = CkJsonObjectW_stringOf(jResp,L"principals[i].authenticationStatus");
id = CkJsonObjectW_stringOf(jResp,L"principals[i].id");
principalName = CkJsonObjectW_stringOf(jResp,L"principals[i].principalName");
principalType = CkJsonObjectW_stringOf(jResp,L"principals[i].principalType");
sequenceNumber = CkJsonObjectW_IntOf(jResp,L"principals[i].sequenceNumber");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"principals[i].parameters");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"principals[i].principalAccess");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relatedNamedCredentials");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
developerName = CkJsonObjectW_stringOf(jResp,L"relatedNamedCredentials[i].developerName");
id = CkJsonObjectW_stringOf(jResp,L"relatedNamedCredentials[i].id");
masterLabel = CkJsonObjectW_stringOf(jResp,L"relatedNamedCredentials[i].masterLabel");
url = CkJsonObjectW_stringOf(jResp,L"relatedNamedCredentials[i].url");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(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}"
}
]
}
