Chilkat Online Tools

VB6 / Salesforce Platform APIs / Get External Credentials by Developer Name

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 ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "authenticationProtocol": "Custom",
'   "authenticationProtocolVariant": "NoAuthentication",
'   "authenticationStatus": "NotConfigured",
'   "customHeaders": [
'   ],
'   "developerName": "Test",
'   "id": "0pt...",
'   "masterLabel": "Test",
'   "parameters": [
'   ],
'   "principals": [
'   ],
'   "relatedNamedCredentials": [
'     {
'       "developerName": "Test",
'       "id": "0XA...",
'       "masterLabel": "Test",
'       "url": "/services/data/v58.0/named-credentials/named-credential-setup/Test"
'     }
'   ],
'   "url": "/services/data/v58.0/named-credentials/external-credentials/Test"
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim authenticationProtocol As String
authenticationProtocol = jResp.StringOf("authenticationProtocol")
Dim authenticationProtocolVariant As String
authenticationProtocolVariant = jResp.StringOf("authenticationProtocolVariant")
Dim authenticationStatus As String
authenticationStatus = jResp.StringOf("authenticationStatus")
Dim developerName As String
developerName = jResp.StringOf("developerName")
Dim id As String
id = jResp.StringOf("id")
Dim masterLabel As String
masterLabel = jResp.StringOf("masterLabel")
Dim url As String
url = jResp.StringOf("url")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("customHeaders")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("parameters")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("principals")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("relatedNamedCredentials")
Do 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
Loop

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME

Postman Collection Item JSON

{
  "name": "Get External Credentials by Developer Name",
  "request": {
    "method": "GET",
    "header": [
    ],
    "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": "Get an external credential, including the named credentials and principals associated with it and the type and status of each principal."
  },
  "response": [
    {
      "name": "Successful Get External Credentials by Developer Name",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "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": "Test"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:49:36 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    \"authenticationProtocolVariant\": \"NoAuthentication\",\n    \"authenticationStatus\": \"NotConfigured\",\n    \"customHeaders\": [],\n    \"developerName\": \"Test\",\n    \"id\": \"0pt...\",\n    \"masterLabel\": \"Test\",\n    \"parameters\": [],\n    \"principals\": [],\n    \"relatedNamedCredentials\": [\n        {\n            \"developerName\": \"Test\",\n            \"id\": \"0XA...\",\n            \"masterLabel\": \"Test\",\n            \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n        }\n    ],\n    \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n}"
    }
  ]
}