Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
headerName: WideString;
headerValue: WideString;
sequenceNumber: Integer;
principalName: WideString;
principalType: WideString;
j: Integer;
count_j: Integer;
authenticationProtocol: WideString;
authenticationStatus: WideString;
developerName: WideString;
id: WideString;
masterLabel: WideString;
url: WideString;
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 := TChilkatHttp.Create(Self);
// 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 := TChilkatJsonObject.Create(Self);
json.UpdateString('masterLabel','Sample External Credential');
json.UpdateString('authenticationProtocol','Custom');
json.UpdateString('principals[0].principalName','SamplePrincipal');
json.UpdateString('principals[0].principalType','NamedPrincipal');
json.UpdateInt('principals[0].sequenceNumber',1);
json.UpdateString('customHeaders[0].headerName','SampleHeader');
json.UpdateString('customHeaders[0].headerValue','SampleHeaderValue');
json.UpdateInt('customHeaders[0].sequenceNumber',1);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
resp := http.PTextSb('PUT','https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
authenticationProtocol := jResp.StringOf('authenticationProtocol');
authenticationStatus := jResp.StringOf('authenticationStatus');
developerName := jResp.StringOf('developerName');
id := jResp.StringOf('id');
masterLabel := jResp.StringOf('masterLabel');
url := jResp.StringOf('url');
i := 0;
count_i := jResp.SizeOfArray('customHeaders');
while i < count_i do
begin
jResp.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('parameters');
while i < count_i do
begin
jResp.I := i;
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('principals');
while i < count_i do
begin
jResp.I := i;
authenticationStatus := jResp.StringOf('principals[i].authenticationStatus');
id := jResp.StringOf('principals[i].id');
principalName := jResp.StringOf('principals[i].principalName');
principalType := jResp.StringOf('principals[i].principalType');
sequenceNumber := jResp.IntOf('principals[i].sequenceNumber');
j := 0;
count_j := jResp.SizeOfArray('principals[i].parameters');
while j < count_j do
begin
jResp.J := j;
j := j + 1;
end;
j := 0;
count_j := jResp.SizeOfArray('principals[i].principalAccess');
while j < count_j do
begin
jResp.J := j;
j := j + 1;
end;
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('relatedNamedCredentials');
while i < count_i do
begin
jResp.I := i;
developerName := jResp.StringOf('relatedNamedCredentials[i].developerName');
id := jResp.StringOf('relatedNamedCredentials[i].id');
masterLabel := jResp.StringOf('relatedNamedCredentials[i].masterLabel');
url := jResp.StringOf('relatedNamedCredentials[i].url');
i := i + 1;
end;
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}"
}
]
}
