Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
headerName: PWideChar;
headerValue: PWideChar;
sequenceNumber: Integer;
principalName: PWideChar;
principalType: PWideChar;
j: Integer;
count_j: Integer;
authenticationProtocol: PWideChar;
authenticationStatus: PWideChar;
developerName: PWideChar;
id: PWideChar;
masterLabel: PWideChar;
url: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_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.
// {
// "developerName": "SampleExternalCredential",
// "masterLabel": "Sample External Credential",
// "authenticationProtocol": "Custom",
// "principals": [
// {
// "principalName": "SamplePrincipal",
// "principalType": "NamedPrincipal",
// "sequenceNumber": 1
// }
// ],
// "customHeaders": [
// {
// "headerName": "SampleHeader",
// "headerValue": "SampleHeaderValue",
// "sequenceNumber": 1
// }
// ]
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'developerName','SampleExternalCredential');
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_putAuthToken(http,'<access_token>');
resp := CkHttp_PostJson3(http,'https://domain.com/services/data/v{{version}}/named-credentials/external-credentials','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_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": [
// ],
// "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
authenticationProtocol := CkJsonObject__stringOf(jResp,'authenticationProtocol');
authenticationStatus := CkJsonObject__stringOf(jResp,'authenticationStatus');
developerName := CkJsonObject__stringOf(jResp,'developerName');
id := CkJsonObject__stringOf(jResp,'id');
masterLabel := CkJsonObject__stringOf(jResp,'masterLabel');
url := CkJsonObject__stringOf(jResp,'url');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'customHeaders');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
headerName := CkJsonObject__stringOf(jResp,'customHeaders[i].headerName');
headerValue := CkJsonObject__stringOf(jResp,'customHeaders[i].headerValue');
id := CkJsonObject__stringOf(jResp,'customHeaders[i].id');
sequenceNumber := CkJsonObject_IntOf(jResp,'customHeaders[i].sequenceNumber');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'parameters');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'principals');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
authenticationStatus := CkJsonObject__stringOf(jResp,'principals[i].authenticationStatus');
id := CkJsonObject__stringOf(jResp,'principals[i].id');
principalName := CkJsonObject__stringOf(jResp,'principals[i].principalName');
principalType := CkJsonObject__stringOf(jResp,'principals[i].principalType');
sequenceNumber := CkJsonObject_IntOf(jResp,'principals[i].sequenceNumber');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'principals[i].parameters');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'principals[i].principalAccess');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'relatedNamedCredentials');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"developerName": "SampleExternalCredential",
"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
Postman Collection Item JSON
{
"name": "Create External Credential",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"developerName\": \"SampleExternalCredential\",\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",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials"
]
},
"description": "Create an external credential."
},
"response": [
{
"name": "Successful Create External Credential",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"developerName\": \"SampleExternalCredential\",\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",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:53:51 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": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"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 \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}"
}
]
}
