Chilkat Online Tools

Ruby / Salesforce Platform APIs / List External Credentials

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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
count_i = jResp.SizeOfArray("externalCredentials")
while i < count_i
    jResp.put_I(i)
    authenticationProtocol = jResp.stringOf("externalCredentials[i].authenticationProtocol")
    authenticationProtocolVariant = jResp.stringOf("externalCredentials[i].authenticationProtocolVariant")
    authenticationStatus = jResp.stringOf("externalCredentials[i].authenticationStatus")
    developerName = jResp.stringOf("externalCredentials[i].developerName")
    id = jResp.stringOf("externalCredentials[i].id")
    masterLabel = jResp.stringOf("externalCredentials[i].masterLabel")
    url = jResp.stringOf("externalCredentials[i].url")
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].customHeaders")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].parameters")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].principals")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("externalCredentials[i].relatedNamedCredentials")
    while j < count_j
        jResp.put_J(j)
        developerName = jResp.stringOf("externalCredentials[i].relatedNamedCredentials[j].developerName")
        id = jResp.stringOf("externalCredentials[i].relatedNamedCredentials[j].id")
        masterLabel = jResp.stringOf("externalCredentials[i].relatedNamedCredentials[j].masterLabel")
        url = jResp.stringOf("externalCredentials[i].relatedNamedCredentials[j].url")
        j = j + 1
    end
    i = i + 1
end

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