Chilkat Online Tools

autoit / Salesforce Platform APIs / Get Named Credential by Developer Name

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/named-credential-setup/:DEVELOPER_NAME",$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)

; {
;   "calloutOptions": {
;     "allowMergeFieldsInBody": false,
;     "allowMergeFieldsInHeader": false,
;     "generateAuthorizationHeader": true
;   },
;   "calloutUrl": "https://my.example.com",
;   "customHeaders": [
;   ],
;   "developerName": "Test",
;   "externalCredentials": [
;     {
;       "developerName": "Test",
;       "id": "0pt...",
;       "masterLabel": "Test",
;       "url": "/services/data/v58.0/named-credentials/external-credentials/Test"
;     }
;   ],
;   "id": "0XA...",
;   "masterLabel": "Test",
;   "parameters": [
;   ],
;   "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

Local $bAllowMergeFieldsInBody = $oJResp.BoolOf("calloutOptions.allowMergeFieldsInBody")
Local $bAllowMergeFieldsInHeader = $oJResp.BoolOf("calloutOptions.allowMergeFieldsInHeader")
Local $bGenerateAuthorizationHeader = $oJResp.BoolOf("calloutOptions.generateAuthorizationHeader")
Local $sCalloutUrl = $oJResp.StringOf("calloutUrl")
Local $sDeveloperName = $oJResp.StringOf("developerName")
Local $sId = $oJResp.StringOf("id")
Local $sMasterLabel = $oJResp.StringOf("masterLabel")
Local $sV_type = $oJResp.StringOf("type")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("customHeaders")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("externalCredentials")
While $i < $iCount_i
    $oJResp.I = $i
    $sDeveloperName = $oJResp.StringOf("externalCredentials[i].developerName")
    $sId = $oJResp.StringOf("externalCredentials[i].id")
    $sMasterLabel = $oJResp.StringOf("externalCredentials[i].masterLabel")
    $sUrl = $oJResp.StringOf("externalCredentials[i].url")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("parameters")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME

Postman Collection Item JSON

{
  "name": "Get Named Credential by Developer Name",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "named-credential-setup",
        ":DEVELOPER_NAME"
      ],
      "variable": [
        {
          "key": "DEVELOPER_NAME",
          "value": null
        }
      ]
    },
    "description": "Get a named credential."
  },
  "response": [
    {
      "name": "Successful Get Named Credential by Developer Name",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "named-credential-setup",
            ":DEVELOPER_NAME"
          ],
          "variable": [
            {
              "key": "DEVELOPER_NAME",
              "value": "Test"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:50:01 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    \"calloutOptions\": {\n        \"allowMergeFieldsInBody\": false,\n        \"allowMergeFieldsInHeader\": false,\n        \"generateAuthorizationHeader\": true\n    },\n    \"calloutUrl\": \"https://my.example.com\",\n    \"customHeaders\": [],\n    \"developerName\": \"Test\",\n    \"externalCredentials\": [\n        {\n            \"developerName\": \"Test\",\n            \"id\": \"0pt...\",\n            \"masterLabel\": \"Test\",\n            \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n        }\n    ],\n    \"id\": \"0XA...\",\n    \"masterLabel\": \"Test\",\n    \"parameters\": [],\n    \"type\": \"SecuredEndpoint\",\n    \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n}"
    }
  ]
}