Chilkat Online Tools

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

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    BOOL AllowMergeFieldsInBody;
    BOOL AllowMergeFieldsInHeader;
    BOOL GenerateAuthorizationHeader;
    const char *calloutUrl;
    const char *developerName;
    const char *id;
    const char *masterLabel;
    const char *v_type;
    const char *url;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttp_putAuthToken(http,"<access_token>");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    AllowMergeFieldsInBody = CkJsonObject_BoolOf(jResp,"calloutOptions.allowMergeFieldsInBody");
    AllowMergeFieldsInHeader = CkJsonObject_BoolOf(jResp,"calloutOptions.allowMergeFieldsInHeader");
    GenerateAuthorizationHeader = CkJsonObject_BoolOf(jResp,"calloutOptions.generateAuthorizationHeader");
    calloutUrl = CkJsonObject_stringOf(jResp,"calloutUrl");
    developerName = CkJsonObject_stringOf(jResp,"developerName");
    id = CkJsonObject_stringOf(jResp,"id");
    masterLabel = CkJsonObject_stringOf(jResp,"masterLabel");
    v_type = CkJsonObject_stringOf(jResp,"type");
    url = CkJsonObject_stringOf(jResp,"url");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"customHeaders");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"externalCredentials");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        developerName = CkJsonObject_stringOf(jResp,"externalCredentials[i].developerName");
        id = CkJsonObject_stringOf(jResp,"externalCredentials[i].id");
        masterLabel = CkJsonObject_stringOf(jResp,"externalCredentials[i].masterLabel");
        url = CkJsonObject_stringOf(jResp,"externalCredentials[i].url");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"parameters");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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