Chilkat Online Tools

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

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

$AllowMergeFieldsInBody = $jResp->BoolOf('calloutOptions.allowMergeFieldsInBody');
$AllowMergeFieldsInHeader = $jResp->BoolOf('calloutOptions.allowMergeFieldsInHeader');
$GenerateAuthorizationHeader = $jResp->BoolOf('calloutOptions.generateAuthorizationHeader');
$calloutUrl = $jResp->stringOf('calloutUrl');
$developerName = $jResp->stringOf('developerName');
$id = $jResp->stringOf('id');
$masterLabel = $jResp->stringOf('masterLabel');
$v_type = $jResp->stringOf('type');
$url = $jResp->stringOf('url');
$i = 0;
$count_i = $jResp->SizeOfArray('customHeaders');
while ($i < $count_i) {
    $jResp->put_I($i);
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('externalCredentials');
while ($i < $count_i) {
    $jResp->put_I($i);
    $developerName = $jResp->stringOf('externalCredentials[i].developerName');
    $id = $jResp->stringOf('externalCredentials[i].id');
    $masterLabel = $jResp->stringOf('externalCredentials[i].masterLabel');
    $url = $jResp->stringOf('externalCredentials[i].url');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('parameters');
while ($i < $count_i) {
    $jResp->put_I($i);
    $i = $i + 1;
}


?>

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