Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcHeaderName
LOCAL lcHeaderValue
LOCAL lnSequenceNumber
LOCAL lcPrincipalName
LOCAL lcPrincipalType
LOCAL j
LOCAL lnCount_j
LOCAL lcAuthenticationProtocol
LOCAL lcAuthenticationStatus
LOCAL lcDeveloperName
LOCAL lcId
LOCAL lcMasterLabel
LOCAL lcUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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
* }
* ]
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("developerName","SampleExternalCredential")
loJson.UpdateString("masterLabel","Sample External Credential")
loJson.UpdateString("authenticationProtocol","Custom")
loJson.UpdateString("principals[0].principalName","SamplePrincipal")
loJson.UpdateString("principals[0].principalType","NamedPrincipal")
loJson.UpdateInt("principals[0].sequenceNumber",1)
loJson.UpdateString("customHeaders[0].headerName","SampleHeader")
loJson.UpdateString("customHeaders[0].headerValue","SampleHeaderValue")
loJson.UpdateInt("customHeaders[0].sequenceNumber",1)
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcAuthenticationProtocol = loJResp.StringOf("authenticationProtocol")
lcAuthenticationStatus = loJResp.StringOf("authenticationStatus")
lcDeveloperName = loJResp.StringOf("developerName")
lcId = loJResp.StringOf("id")
lcMasterLabel = loJResp.StringOf("masterLabel")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("customHeaders")
DO WHILE i < lnCount_i
loJResp.I = i
lcHeaderName = loJResp.StringOf("customHeaders[i].headerName")
lcHeaderValue = loJResp.StringOf("customHeaders[i].headerValue")
lcId = loJResp.StringOf("customHeaders[i].id")
lnSequenceNumber = loJResp.IntOf("customHeaders[i].sequenceNumber")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("parameters")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("principals")
DO WHILE i < lnCount_i
loJResp.I = i
lcAuthenticationStatus = loJResp.StringOf("principals[i].authenticationStatus")
lcId = loJResp.StringOf("principals[i].id")
lcPrincipalName = loJResp.StringOf("principals[i].principalName")
lcPrincipalType = loJResp.StringOf("principals[i].principalType")
lnSequenceNumber = loJResp.IntOf("principals[i].sequenceNumber")
j = 0
lnCount_j = loJResp.SizeOfArray("principals[i].parameters")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("principals[i].principalAccess")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("relatedNamedCredentials")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
