Chilkat Online Tools

Node.js / Salesforce Platform APIs / Get External Credentials by Developer Name

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>";

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

    // 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

    var authenticationProtocol = jResp.StringOf("authenticationProtocol");
    var authenticationProtocolVariant = jResp.StringOf("authenticationProtocolVariant");
    var authenticationStatus = jResp.StringOf("authenticationStatus");
    var developerName = jResp.StringOf("developerName");
    var id = jResp.StringOf("id");
    var masterLabel = jResp.StringOf("masterLabel");
    var url = jResp.StringOf("url");
    var i = 0;
    var count_i = jResp.SizeOfArray("customHeaders");
    while (i < count_i) {
        jResp.I = i;
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("parameters");
    while (i < count_i) {
        jResp.I = i;
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("principals");
    while (i < count_i) {
        jResp.I = i;
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("relatedNamedCredentials");
    while (i < count_i) {
        jResp.I = i;
        developerName = jResp.StringOf("relatedNamedCredentials[i].developerName");
        id = jResp.StringOf("relatedNamedCredentials[i].id");
        masterLabel = jResp.StringOf("relatedNamedCredentials[i].masterLabel");
        url = jResp.StringOf("relatedNamedCredentials[i].url");
        i = i+1;
    }


}

chilkatExample();

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