Chilkat Online Tools

autoit / 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.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("q","SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sV_Type
Local $sV_Url
Local $sId
Local $bIsDeleted
Local $sDeveloperName
Local $sLanguage
Local $sMasterLabel
Local $sNamespacePrefix
Local $sCreatedDate
Local $sCreatedById
Local $sLastModifiedDate
Local $sLastModifiedById
Local $sSystemModstamp
Local $sEndpoint
Local $sPrincipalType
Local $sJwtIssuer
Local $sJwtFormulaSubject
Local $sJwtTextSubject
Local $sJwtValidityPeriodSeconds
Local $sJwtAudience
Local $sAuthTokenEndpointUrl

Local $iSize = $oJResp.IntOf("size")
Local $iTotalSize = $oJResp.IntOf("totalSize")
Local $bDone = $oJResp.BoolOf("done")
Local $sQueryLocator = $oJResp.StringOf("queryLocator")
Local $sEntityTypeName = $oJResp.StringOf("entityTypeName")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("records")
While $i < $iCount_i
    $oJResp.I = $i
    $sV_Type = $oJResp.StringOf("records[i].attributes.type")
    $sV_Url = $oJResp.StringOf("records[i].attributes.url")
    $sId = $oJResp.StringOf("records[i].Id")
    $bIsDeleted = $oJResp.BoolOf("records[i].IsDeleted")
    $sDeveloperName = $oJResp.StringOf("records[i].DeveloperName")
    $sLanguage = $oJResp.StringOf("records[i].Language")
    $sMasterLabel = $oJResp.StringOf("records[i].MasterLabel")
    $sNamespacePrefix = $oJResp.StringOf("records[i].NamespacePrefix")
    $sCreatedDate = $oJResp.StringOf("records[i].CreatedDate")
    $sCreatedById = $oJResp.StringOf("records[i].CreatedById")
    $sLastModifiedDate = $oJResp.StringOf("records[i].LastModifiedDate")
    $sLastModifiedById = $oJResp.StringOf("records[i].LastModifiedById")
    $sSystemModstamp = $oJResp.StringOf("records[i].SystemModstamp")
    $sEndpoint = $oJResp.StringOf("records[i].Endpoint")
    $sPrincipalType = $oJResp.StringOf("records[i].PrincipalType")
    $sJwtIssuer = $oJResp.StringOf("records[i].JwtIssuer")
    $sJwtFormulaSubject = $oJResp.StringOf("records[i].JwtFormulaSubject")
    $sJwtTextSubject = $oJResp.StringOf("records[i].JwtTextSubject")
    $sJwtValidityPeriodSeconds = $oJResp.StringOf("records[i].JwtValidityPeriodSeconds")
    $sJwtAudience = $oJResp.StringOf("records[i].JwtAudience")
    $sAuthTokenEndpointUrl = $oJResp.StringOf("records[i].AuthTokenEndpointUrl")
    $i = $i + 1
Wend

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