Chilkat Online Tools

TCL / Salesforce Platform APIs / List named credentials

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "q" "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpParams $http "GET" "https://domain.com/services/data/v{{version}}/tooling/query/" $queryParams $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set size [CkJsonObject_IntOf $jResp "size"]
set totalSize [CkJsonObject_IntOf $jResp "totalSize"]
set done [CkJsonObject_BoolOf $jResp "done"]
set queryLocator [CkJsonObject_stringOf $jResp "queryLocator"]
set entityTypeName [CkJsonObject_stringOf $jResp "entityTypeName"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "records"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_Type [CkJsonObject_stringOf $jResp "records[i].attributes.type"]
    set v_Url [CkJsonObject_stringOf $jResp "records[i].attributes.url"]
    set Id [CkJsonObject_stringOf $jResp "records[i].Id"]
    set IsDeleted [CkJsonObject_BoolOf $jResp "records[i].IsDeleted"]
    set DeveloperName [CkJsonObject_stringOf $jResp "records[i].DeveloperName"]
    set Language [CkJsonObject_stringOf $jResp "records[i].Language"]
    set MasterLabel [CkJsonObject_stringOf $jResp "records[i].MasterLabel"]
    set NamespacePrefix [CkJsonObject_stringOf $jResp "records[i].NamespacePrefix"]
    set CreatedDate [CkJsonObject_stringOf $jResp "records[i].CreatedDate"]
    set CreatedById [CkJsonObject_stringOf $jResp "records[i].CreatedById"]
    set LastModifiedDate [CkJsonObject_stringOf $jResp "records[i].LastModifiedDate"]
    set LastModifiedById [CkJsonObject_stringOf $jResp "records[i].LastModifiedById"]
    set SystemModstamp [CkJsonObject_stringOf $jResp "records[i].SystemModstamp"]
    set Endpoint [CkJsonObject_stringOf $jResp "records[i].Endpoint"]
    set PrincipalType [CkJsonObject_stringOf $jResp "records[i].PrincipalType"]
    set JwtIssuer [CkJsonObject_stringOf $jResp "records[i].JwtIssuer"]
    set JwtFormulaSubject [CkJsonObject_stringOf $jResp "records[i].JwtFormulaSubject"]
    set JwtTextSubject [CkJsonObject_stringOf $jResp "records[i].JwtTextSubject"]
    set JwtValidityPeriodSeconds [CkJsonObject_stringOf $jResp "records[i].JwtValidityPeriodSeconds"]
    set JwtAudience [CkJsonObject_stringOf $jResp "records[i].JwtAudience"]
    set AuthTokenEndpointUrl [CkJsonObject_stringOf $jResp "records[i].AuthTokenEndpointUrl"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}