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

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("q","SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200")

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


Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",queryParams)
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)

' {
'   "size": 1,
'   "totalSize": 1,
'   "done": true,
'   "queryLocator": null,
'   "entityTypeName": "NamedCredential",
'   "records": [
'     {
'       "attributes": {
'         "type": "NamedCredential",
'         "url": "/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO"
'       },
'       "Id": "0XA4H000000TNRhWAO",
'       "IsDeleted": false,
'       "DeveloperName": "Slack_Webhook_for_integration_Channel",
'       "Language": "en_US",
'       "MasterLabel": "Slack Webhook for #integration Channel",
'       "NamespacePrefix": null,
'       "CreatedDate": "2020-11-06T14:04:44.000+0000",
'       "CreatedById": "00558000000yFyDAAU",
'       "LastModifiedDate": "2020-11-06T14:04:44.000+0000",
'       "LastModifiedById": "00558000000yFyDAAU",
'       "SystemModstamp": "2020-11-06T14:04:44.000+0000",
'       "Endpoint": "https://hooks.slack.com/services/SECRET",
'       "PrincipalType": "Anonymous",
'       "JwtIssuer": null,
'       "JwtFormulaSubject": null,
'       "JwtTextSubject": null,
'       "JwtValidityPeriodSeconds": null,
'       "JwtAudience": null,
'       "AuthTokenEndpointUrl": null
'     }
'   ]
' }

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



Dim v_Type As String
Dim v_Url As String
Dim Id As String
Dim IsDeleted As Boolean
Dim DeveloperName As String
Dim Language As String
Dim MasterLabel As String
Dim NamespacePrefix As String
Dim CreatedDate As String
Dim CreatedById As String
Dim LastModifiedDate As String
Dim LastModifiedById As String
Dim SystemModstamp As String
Dim Endpoint As String
Dim PrincipalType As String
Dim JwtIssuer As String
Dim JwtFormulaSubject As String
Dim JwtTextSubject As String
Dim JwtValidityPeriodSeconds As String
Dim JwtAudience As String
Dim AuthTokenEndpointUrl As String

Dim size As Integer = jResp.IntOf("size")
Dim totalSize As Integer = jResp.IntOf("totalSize")
Dim done As Boolean = jResp.BoolOf("done")
Dim queryLocator As String = jResp.StringOf("queryLocator")
Dim entityTypeName As String = jResp.StringOf("entityTypeName")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("records")
While i < count_i
    jResp.I = i
    v_Type = jResp.StringOf("records[i].attributes.type")
    v_Url = jResp.StringOf("records[i].attributes.url")
    Id = jResp.StringOf("records[i].Id")
    IsDeleted = jResp.BoolOf("records[i].IsDeleted")
    DeveloperName = jResp.StringOf("records[i].DeveloperName")
    Language = jResp.StringOf("records[i].Language")
    MasterLabel = jResp.StringOf("records[i].MasterLabel")
    NamespacePrefix = jResp.StringOf("records[i].NamespacePrefix")
    CreatedDate = jResp.StringOf("records[i].CreatedDate")
    CreatedById = jResp.StringOf("records[i].CreatedById")
    LastModifiedDate = jResp.StringOf("records[i].LastModifiedDate")
    LastModifiedById = jResp.StringOf("records[i].LastModifiedById")
    SystemModstamp = jResp.StringOf("records[i].SystemModstamp")
    Endpoint = jResp.StringOf("records[i].Endpoint")
    PrincipalType = jResp.StringOf("records[i].PrincipalType")
    JwtIssuer = jResp.StringOf("records[i].JwtIssuer")
    JwtFormulaSubject = jResp.StringOf("records[i].JwtFormulaSubject")
    JwtTextSubject = jResp.StringOf("records[i].JwtTextSubject")
    JwtValidityPeriodSeconds = jResp.StringOf("records[i].JwtValidityPeriodSeconds")
    JwtAudience = jResp.StringOf("records[i].JwtAudience")
    AuthTokenEndpointUrl = jResp.StringOf("records[i].AuthTokenEndpointUrl")
    i = i + 1
End While

Curl Command

curl -G -d "q=SELECT%20FIELDS%28ALL%29%20FROM%20NamedCredential%20LIMIT%20200"
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "List named credentials",
  "protocolProfileBehavior": {
    "strictSSL": false,
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
        }
      ]
    }
  },
  "response": [
    {
      "name": "List named credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:09:27 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=5/15000"
        },
        {
          "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    \"size\": 1,\n    \"totalSize\": 1,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"NamedCredential\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"NamedCredential\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO\"\n            },\n            \"Id\": \"0XA4H000000TNRhWAO\",\n            \"IsDeleted\": false,\n            \"DeveloperName\": \"Slack_Webhook_for_integration_Channel\",\n            \"Language\": \"en_US\",\n            \"MasterLabel\": \"Slack Webhook for #integration Channel\",\n            \"NamespacePrefix\": null,\n            \"CreatedDate\": \"2020-11-06T14:04:44.000+0000\",\n            \"CreatedById\": \"00558000000yFyDAAU\",\n            \"LastModifiedDate\": \"2020-11-06T14:04:44.000+0000\",\n            \"LastModifiedById\": \"00558000000yFyDAAU\",\n            \"SystemModstamp\": \"2020-11-06T14:04:44.000+0000\",\n            \"Endpoint\": \"https://hooks.slack.com/services/SECRET\",\n            \"PrincipalType\": \"Anonymous\",\n            \"JwtIssuer\": null,\n            \"JwtFormulaSubject\": null,\n            \"JwtTextSubject\": null,\n            \"JwtValidityPeriodSeconds\": null,\n            \"JwtAudience\": null,\n            \"AuthTokenEndpointUrl\": null\n        }\n    ]\n}"
    }
  ]
}