Chilkat Online Tools

Foxpro / Salesforce Platform APIs / List Named Credentials

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCalloutUrl
LOCAL lcDeveloperName
LOCAL lcId
LOCAL lcMasterLabel
LOCAL lcV_type
LOCAL lcUrl
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')

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* 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 = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

i = 0
lnCount_i = loJResp.SizeOfArray("namedCredentials")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcCalloutUrl = loJResp.StringOf("namedCredentials[i].calloutUrl")
    lcDeveloperName = loJResp.StringOf("namedCredentials[i].developerName")
    lcId = loJResp.StringOf("namedCredentials[i].id")
    lcMasterLabel = loJResp.StringOf("namedCredentials[i].masterLabel")
    lcV_type = loJResp.StringOf("namedCredentials[i].type")
    lcUrl = loJResp.StringOf("namedCredentials[i].url")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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