Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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
' }
' ]
' }
Dim json As New Chilkat.JsonObject
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>"
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim headerName As String
Dim headerValue As String
Dim sequenceNumber As Integer
Dim principalName As String
Dim principalType As String
Dim j As Integer
Dim count_j As Integer
Dim authenticationProtocol As String = jResp.StringOf("authenticationProtocol")
Dim authenticationStatus As String = jResp.StringOf("authenticationStatus")
Dim developerName As String = jResp.StringOf("developerName")
Dim id As String = jResp.StringOf("id")
Dim masterLabel As String = jResp.StringOf("masterLabel")
Dim url As String = jResp.StringOf("url")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("customHeaders")
While i < count_i
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 While
i = 0
count_i = jResp.SizeOfArray("parameters")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("principals")
While i < count_i
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
jResp.J = j
j = j + 1
End While
j = 0
count_j = jResp.SizeOfArray("principals[i].principalAccess")
While j < count_j
jResp.J = j
j = j + 1
End While
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("relatedNamedCredentials")
While i < count_i
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 While
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}"
}
]
}
