Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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
; }
; ]
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("developerName","SampleExternalCredential")
$oJson.UpdateString("masterLabel","Sample External Credential")
$oJson.UpdateString("authenticationProtocol","Custom")
$oJson.UpdateString("principals[0].principalName","SamplePrincipal")
$oJson.UpdateString("principals[0].principalType","NamedPrincipal")
$oJson.UpdateInt("principals[0].sequenceNumber",1)
$oJson.UpdateString("customHeaders[0].headerName","SampleHeader")
$oJson.UpdateString("customHeaders[0].headerValue","SampleHeaderValue")
$oJson.UpdateInt("customHeaders[0].sequenceNumber",1)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.PostJson3("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sHeaderName
Local $sHeaderValue
Local $iSequenceNumber
Local $sPrincipalName
Local $sPrincipalType
Local $iJ
Local $iCount_j
Local $sAuthenticationProtocol = $oJResp.StringOf("authenticationProtocol")
Local $sAuthenticationStatus = $oJResp.StringOf("authenticationStatus")
Local $sDeveloperName = $oJResp.StringOf("developerName")
Local $sId = $oJResp.StringOf("id")
Local $sMasterLabel = $oJResp.StringOf("masterLabel")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("customHeaders")
While $i < $iCount_i
$oJResp.I = $i
$sHeaderName = $oJResp.StringOf("customHeaders[i].headerName")
$sHeaderValue = $oJResp.StringOf("customHeaders[i].headerValue")
$sId = $oJResp.StringOf("customHeaders[i].id")
$iSequenceNumber = $oJResp.IntOf("customHeaders[i].sequenceNumber")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("parameters")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("principals")
While $i < $iCount_i
$oJResp.I = $i
$sAuthenticationStatus = $oJResp.StringOf("principals[i].authenticationStatus")
$sId = $oJResp.StringOf("principals[i].id")
$sPrincipalName = $oJResp.StringOf("principals[i].principalName")
$sPrincipalType = $oJResp.StringOf("principals[i].principalType")
$iSequenceNumber = $oJResp.IntOf("principals[i].sequenceNumber")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("principals[i].parameters")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("principals[i].principalAccess")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("relatedNamedCredentials")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
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}"
}
]
}
