Chilkat Online Tools

VB.NET / Salesforce Platform APIs / List External Credentials

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

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

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


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

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


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

' {
'   "externalCredentials": [
'     {
'       "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
Dim authenticationProtocolVariant As String
Dim authenticationStatus As String
Dim developerName As String
Dim id As String
Dim masterLabel As String
Dim url As String
Dim j As Integer
Dim count_j As Integer

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("externalCredentials")
While i < count_i
    jResp.I = i
    authenticationProtocol = jResp.StringOf("externalCredentials[i].authenticationProtocol")
    authenticationProtocolVariant = jResp.StringOf("externalCredentials[i].authenticationProtocolVariant")
    authenticationStatus = jResp.StringOf("externalCredentials[i].authenticationStatus")
    developerName = jResp.StringOf("externalCredentials[i].developerName")
    id = jResp.StringOf("externalCredentials[i].id")
    masterLabel = jResp.StringOf("externalCredentials[i].masterLabel")
    url = jResp.StringOf("externalCredentials[i].url")
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].customHeaders")
    While j < count_j
        jResp.J = j
        j = j + 1
    End While
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].parameters")
    While j < count_j
        jResp.J = j
        j = j + 1
    End While
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].principals")
    While j < count_j
        jResp.J = j
        j = j + 1
    End While
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].relatedNamedCredentials")
    While j < count_j
        jResp.J = j
        developerName = jResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].developerName")
        id = jResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].id")
        masterLabel = jResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].masterLabel")
        url = jResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].url")
        j = j + 1
    End While
    i = i + 1
End While

Curl Command

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

Postman Collection Item JSON

{
  "name": "List External Credentials",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "external-credentials"
      ]
    },
    "description": "Get external credentials that the user can authenticate to."
  },
  "response": [
    {
      "name": "Successful List External Credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "external-credentials"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:46:27 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    \"externalCredentials\": [\n        {\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        }\n    ]\n}"
    }
  ]
}