Chilkat Online Tools

VB.NET / Salesforce Platform APIs / List Named 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/named-credential-setup",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)

' {
'   "namedCredentials": [
'     {
'       "calloutUrl": "https://my.example.com",
'       "developerName": "Test",
'       "id": "0XA...",
'       "masterLabel": "Test",
'       "type": "SecuredEndpoint",
'       "url": "/services/data/v58.0/named-credentials/named-credential-setup/Test"
'     }
'   ]
' }

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



Dim calloutUrl As String
Dim developerName As String
Dim id As String
Dim masterLabel As String
Dim v_type As String
Dim url As String

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("namedCredentials")
While i < count_i
    jResp.I = i
    calloutUrl = jResp.StringOf("namedCredentials[i].calloutUrl")
    developerName = jResp.StringOf("namedCredentials[i].developerName")
    id = jResp.StringOf("namedCredentials[i].id")
    masterLabel = jResp.StringOf("namedCredentials[i].masterLabel")
    v_type = jResp.StringOf("namedCredentials[i].type")
    url = jResp.StringOf("namedCredentials[i].url")
    i = i + 1
End While

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Named Credentials",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "named-credential-setup"
      ]
    },
    "description": "Get a list of named credentials in the org."
  },
  "response": [
    {
      "name": "Successful List Named Credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "named-credential-setup"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:45:55 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    \"namedCredentials\": [\n        {\n            \"calloutUrl\": \"https://my.example.com\",\n            \"developerName\": \"Test\",\n            \"id\": \"0XA...\",\n            \"masterLabel\": \"Test\",\n            \"type\": \"SecuredEndpoint\",\n            \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n        }\n    ]\n}"
    }
  ]
}