Chilkat Online Tools

Foxpro / Salesforce Platform APIs / List External Credentials

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAuthenticationProtocol
LOCAL lcAuthenticationProtocolVariant
LOCAL lcAuthenticationStatus
LOCAL lcDeveloperName
LOCAL lcId
LOCAL lcMasterLabel
LOCAL lcUrl
LOCAL j
LOCAL lnCount_j
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/external-credentials",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)

* {
*   "externalCredentials": [
*     {
*       "authenticationProtocol": "Custom",
*       "authenticationProtocolVariant": "NoAuthentication",
*       "authenticationStatus": "NotConfigured",
*       "customHeaders": [
*       ],
*       "developerName": "Test",
*       "id": "0pt...",
*       "masterLabel": "Test",
*       "parameters": [
*       ],
*       "principals": [
*       ],
*       "relatedNamedCredentials": [
*         {
*           "developerName": "Test",
*           "id": "0XA...",
*           "masterLabel": "Test",
*           "url": "/services/data/v58.0/named-credentials/named-credential-setup/Test"
*         }
*       ],
*       "url": "/services/data/v58.0/named-credentials/external-credentials/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("externalCredentials")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcAuthenticationProtocol = loJResp.StringOf("externalCredentials[i].authenticationProtocol")
    lcAuthenticationProtocolVariant = loJResp.StringOf("externalCredentials[i].authenticationProtocolVariant")
    lcAuthenticationStatus = loJResp.StringOf("externalCredentials[i].authenticationStatus")
    lcDeveloperName = loJResp.StringOf("externalCredentials[i].developerName")
    lcId = loJResp.StringOf("externalCredentials[i].id")
    lcMasterLabel = loJResp.StringOf("externalCredentials[i].masterLabel")
    lcUrl = loJResp.StringOf("externalCredentials[i].url")
    j = 0
    lnCount_j = loJResp.SizeOfArray("externalCredentials[i].customHeaders")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("externalCredentials[i].parameters")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("externalCredentials[i].principals")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("externalCredentials[i].relatedNamedCredentials")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcDeveloperName = loJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].developerName")
        lcId = loJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].id")
        lcMasterLabel = loJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].masterLabel")
        lcUrl = loJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].url")
        j = j + 1
    ENDDO
    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/external-credentials

Postman Collection Item JSON

{
  "name": "List External Credentials",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "external-credentials"
      ]
    },
    "description": "Get external credentials that the user can authenticate to."
  },
  "response": [
    {
      "name": "Successful List External Credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "external-credentials"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:46:27 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    \"externalCredentials\": [\n        {\n            \"authenticationProtocol\": \"Custom\",\n            \"authenticationProtocolVariant\": \"NoAuthentication\",\n            \"authenticationStatus\": \"NotConfigured\",\n            \"customHeaders\": [],\n            \"developerName\": \"Test\",\n            \"id\": \"0pt...\",\n            \"masterLabel\": \"Test\",\n            \"parameters\": [],\n            \"principals\": [],\n            \"relatedNamedCredentials\": [\n                {\n                    \"developerName\": \"Test\",\n                    \"id\": \"0XA...\",\n                    \"masterLabel\": \"Test\",\n                    \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n                }\n            ],\n            \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n        }\n    ]\n}"
    }
  ]
}