Chilkat Online Tools

TCL / Salesforce Platform APIs / Get External Credentials by Developer Name

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "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

set authenticationProtocol [CkJsonObject_stringOf $jResp "authenticationProtocol"]
set authenticationProtocolVariant [CkJsonObject_stringOf $jResp "authenticationProtocolVariant"]
set authenticationStatus [CkJsonObject_stringOf $jResp "authenticationStatus"]
set developerName [CkJsonObject_stringOf $jResp "developerName"]
set id [CkJsonObject_stringOf $jResp "id"]
set masterLabel [CkJsonObject_stringOf $jResp "masterLabel"]
set url [CkJsonObject_stringOf $jResp "url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "customHeaders"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "parameters"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "principals"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "relatedNamedCredentials"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set developerName [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].developerName"]
    set id [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].id"]
    set masterLabel [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].masterLabel"]
    set url [CkJsonObject_stringOf $jResp "relatedNamedCredentials[i].url"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get External Credentials by Developer Name",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "external-credentials",
        ":DEVELOPER_NAME"
      ],
      "variable": [
        {
          "key": "DEVELOPER_NAME",
          "value": ""
        }
      ]
    },
    "description": "Get an external credential, including the named credentials and principals associated with it and the type and status of each principal."
  },
  "response": [
    {
      "name": "Successful Get External Credentials by Developer Name",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "external-credentials",
            ":DEVELOPER_NAME"
          ],
          "variable": [
            {
              "key": "DEVELOPER_NAME",
              "value": "Test"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:49:36 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    \"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}"
    }
  ]
}