Chilkat Online Tools

Delphi (DLL) / Salesforce Platform APIs / Update External Credential

Back to Collection Items

var

begin
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);CkHttp_putAuthToken(http,'<access_token>');CkJsonObject_EmitSb(json,sbRequestBody);success := CkHttp_HttpSb(http,'PUT','https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME',sbRequestBody,'utf-8','application/json',resp);CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);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;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'parameters');CkJsonObject_putI(jResp,i);i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'principals');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');CkJsonObject_putJ(jResp,j);j := j + 1;j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'principals[i].principalAccess');CkJsonObject_putJ(jResp,j);j := j + 1;i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'relatedNamedCredentials');CkJsonObject_putI(jResp,i);developerName := CkJsonObject__stringOf(jResp,'relatedNamedCredentials[i].developerName');id := CkJsonObject__stringOf(jResp,'relatedNamedCredentials[i].id');masterLabel := CkJsonObject__stringOf(jResp,'relatedNamedCredentials[i].masterLabel');url := CkJsonObject__stringOf(jResp,'relatedNamedCredentials[i].url');i := i + 1;

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}"
    }
  ]
}