Chilkat Online Tools

autoit / Salesforce Platform APIs / List External 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

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

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

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

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

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sAuthenticationProtocol
Local $sAuthenticationProtocolVariant
Local $sAuthenticationStatus
Local $sDeveloperName
Local $sId
Local $sMasterLabel
Local $sUrl
Local $iJ
Local $iCount_j

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("externalCredentials")
While $i < $iCount_i
    $oJResp.I = $i
    $sAuthenticationProtocol = $oJResp.StringOf("externalCredentials[i].authenticationProtocol")
    $sAuthenticationProtocolVariant = $oJResp.StringOf("externalCredentials[i].authenticationProtocolVariant")
    $sAuthenticationStatus = $oJResp.StringOf("externalCredentials[i].authenticationStatus")
    $sDeveloperName = $oJResp.StringOf("externalCredentials[i].developerName")
    $sId = $oJResp.StringOf("externalCredentials[i].id")
    $sMasterLabel = $oJResp.StringOf("externalCredentials[i].masterLabel")
    $sUrl = $oJResp.StringOf("externalCredentials[i].url")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("externalCredentials[i].customHeaders")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("externalCredentials[i].parameters")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("externalCredentials[i].principals")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("externalCredentials[i].relatedNamedCredentials")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sDeveloperName = $oJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].developerName")
        $sId = $oJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].id")
        $sMasterLabel = $oJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].masterLabel")
        $sUrl = $oJResp.StringOf("externalCredentials[i].relatedNamedCredentials[j].url")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

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