Chilkat Online Tools

Foxpro / Salesforce Platform APIs / List named credentials

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcV_Url
LOCAL lcId
LOCAL lnIsDeleted
LOCAL lcDeveloperName
LOCAL lcLanguage
LOCAL lcMasterLabel
LOCAL lcNamespacePrefix
LOCAL lcCreatedDate
LOCAL lcCreatedById
LOCAL lcLastModifiedDate
LOCAL lcLastModifiedById
LOCAL lcSystemModstamp
LOCAL lcEndpoint
LOCAL lcPrincipalType
LOCAL lcJwtIssuer
LOCAL lcJwtFormulaSubject
LOCAL lcJwtTextSubject
LOCAL lcJwtValidityPeriodSeconds
LOCAL lcJwtAudience
LOCAL lcAuthTokenEndpointUrl
LOCAL lnSize
LOCAL lnTotalSize
LOCAL lnDone
LOCAL lcQueryLocator
LOCAL lcEntityTypeName
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("q","SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lnSize = loJResp.IntOf("size")
lnTotalSize = loJResp.IntOf("totalSize")
lnDone = loJResp.BoolOf("done")
lcQueryLocator = loJResp.StringOf("queryLocator")
lcEntityTypeName = loJResp.StringOf("entityTypeName")
i = 0
lnCount_i = loJResp.SizeOfArray("records")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcV_Type = loJResp.StringOf("records[i].attributes.type")
    lcV_Url = loJResp.StringOf("records[i].attributes.url")
    lcId = loJResp.StringOf("records[i].Id")
    lnIsDeleted = loJResp.BoolOf("records[i].IsDeleted")
    lcDeveloperName = loJResp.StringOf("records[i].DeveloperName")
    lcLanguage = loJResp.StringOf("records[i].Language")
    lcMasterLabel = loJResp.StringOf("records[i].MasterLabel")
    lcNamespacePrefix = loJResp.StringOf("records[i].NamespacePrefix")
    lcCreatedDate = loJResp.StringOf("records[i].CreatedDate")
    lcCreatedById = loJResp.StringOf("records[i].CreatedById")
    lcLastModifiedDate = loJResp.StringOf("records[i].LastModifiedDate")
    lcLastModifiedById = loJResp.StringOf("records[i].LastModifiedById")
    lcSystemModstamp = loJResp.StringOf("records[i].SystemModstamp")
    lcEndpoint = loJResp.StringOf("records[i].Endpoint")
    lcPrincipalType = loJResp.StringOf("records[i].PrincipalType")
    lcJwtIssuer = loJResp.StringOf("records[i].JwtIssuer")
    lcJwtFormulaSubject = loJResp.StringOf("records[i].JwtFormulaSubject")
    lcJwtTextSubject = loJResp.StringOf("records[i].JwtTextSubject")
    lcJwtValidityPeriodSeconds = loJResp.StringOf("records[i].JwtValidityPeriodSeconds")
    lcJwtAudience = loJResp.StringOf("records[i].JwtAudience")
    lcAuthTokenEndpointUrl = loJResp.StringOf("records[i].AuthTokenEndpointUrl")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

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