Chilkat Online Tools

C / Salesforce Platform APIs / List named credentials

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *v_Type;
    const char *v_Url;
    const char *Id;
    BOOL IsDeleted;
    const char *DeveloperName;
    const char *Language;
    const char *MasterLabel;
    const char *NamespacePrefix;
    const char *CreatedDate;
    const char *CreatedById;
    const char *LastModifiedDate;
    const char *LastModifiedById;
    const char *SystemModstamp;
    const char *Endpoint;
    const char *PrincipalType;
    const char *JwtIssuer;
    const char *JwtFormulaSubject;
    const char *JwtTextSubject;
    const char *JwtValidityPeriodSeconds;
    const char *JwtAudience;
    const char *AuthTokenEndpointUrl;
    int size;
    int totalSize;
    BOOL done;
    const char *queryLocator;
    const char *entityTypeName;
    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();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"q","SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200");

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

    resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/services/data/v{{version}}/tooling/query/",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

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

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

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

    CkHttpResponse_Dispose(resp);

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

    // {
    //   "size": 1,
    //   "totalSize": 1,
    //   "done": true,
    //   "queryLocator": null,
    //   "entityTypeName": "NamedCredential",
    //   "records": [
    //     {
    //       "attributes": {
    //         "type": "NamedCredential",
    //         "url": "/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO"
    //       },
    //       "Id": "0XA4H000000TNRhWAO",
    //       "IsDeleted": false,
    //       "DeveloperName": "Slack_Webhook_for_integration_Channel",
    //       "Language": "en_US",
    //       "MasterLabel": "Slack Webhook for #integration Channel",
    //       "NamespacePrefix": null,
    //       "CreatedDate": "2020-11-06T14:04:44.000+0000",
    //       "CreatedById": "00558000000yFyDAAU",
    //       "LastModifiedDate": "2020-11-06T14:04:44.000+0000",
    //       "LastModifiedById": "00558000000yFyDAAU",
    //       "SystemModstamp": "2020-11-06T14:04:44.000+0000",
    //       "Endpoint": "https://hooks.slack.com/services/SECRET",
    //       "PrincipalType": "Anonymous",
    //       "JwtIssuer": null,
    //       "JwtFormulaSubject": null,
    //       "JwtTextSubject": null,
    //       "JwtValidityPeriodSeconds": null,
    //       "JwtAudience": null,
    //       "AuthTokenEndpointUrl": null
    //     }
    //   ]
    // }

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

    size = CkJsonObject_IntOf(jResp,"size");
    totalSize = CkJsonObject_IntOf(jResp,"totalSize");
    done = CkJsonObject_BoolOf(jResp,"done");
    queryLocator = CkJsonObject_stringOf(jResp,"queryLocator");
    entityTypeName = CkJsonObject_stringOf(jResp,"entityTypeName");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"records");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        v_Type = CkJsonObject_stringOf(jResp,"records[i].attributes.type");
        v_Url = CkJsonObject_stringOf(jResp,"records[i].attributes.url");
        Id = CkJsonObject_stringOf(jResp,"records[i].Id");
        IsDeleted = CkJsonObject_BoolOf(jResp,"records[i].IsDeleted");
        DeveloperName = CkJsonObject_stringOf(jResp,"records[i].DeveloperName");
        Language = CkJsonObject_stringOf(jResp,"records[i].Language");
        MasterLabel = CkJsonObject_stringOf(jResp,"records[i].MasterLabel");
        NamespacePrefix = CkJsonObject_stringOf(jResp,"records[i].NamespacePrefix");
        CreatedDate = CkJsonObject_stringOf(jResp,"records[i].CreatedDate");
        CreatedById = CkJsonObject_stringOf(jResp,"records[i].CreatedById");
        LastModifiedDate = CkJsonObject_stringOf(jResp,"records[i].LastModifiedDate");
        LastModifiedById = CkJsonObject_stringOf(jResp,"records[i].LastModifiedById");
        SystemModstamp = CkJsonObject_stringOf(jResp,"records[i].SystemModstamp");
        Endpoint = CkJsonObject_stringOf(jResp,"records[i].Endpoint");
        PrincipalType = CkJsonObject_stringOf(jResp,"records[i].PrincipalType");
        JwtIssuer = CkJsonObject_stringOf(jResp,"records[i].JwtIssuer");
        JwtFormulaSubject = CkJsonObject_stringOf(jResp,"records[i].JwtFormulaSubject");
        JwtTextSubject = CkJsonObject_stringOf(jResp,"records[i].JwtTextSubject");
        JwtValidityPeriodSeconds = CkJsonObject_stringOf(jResp,"records[i].JwtValidityPeriodSeconds");
        JwtAudience = CkJsonObject_stringOf(jResp,"records[i].JwtAudience");
        AuthTokenEndpointUrl = CkJsonObject_stringOf(jResp,"records[i].AuthTokenEndpointUrl");
        i = i + 1;
    }



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

    }

Curl Command

curl -G -d "q=SELECT%20FIELDS%28ALL%29%20FROM%20NamedCredential%20LIMIT%20200"
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "List named credentials",
  "protocolProfileBehavior": {
    "strictSSL": false,
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
        }
      ]
    }
  },
  "response": [
    {
      "name": "List named credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:09:27 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=5/15000"
        },
        {
          "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    \"size\": 1,\n    \"totalSize\": 1,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"NamedCredential\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"NamedCredential\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO\"\n            },\n            \"Id\": \"0XA4H000000TNRhWAO\",\n            \"IsDeleted\": false,\n            \"DeveloperName\": \"Slack_Webhook_for_integration_Channel\",\n            \"Language\": \"en_US\",\n            \"MasterLabel\": \"Slack Webhook for #integration Channel\",\n            \"NamespacePrefix\": null,\n            \"CreatedDate\": \"2020-11-06T14:04:44.000+0000\",\n            \"CreatedById\": \"00558000000yFyDAAU\",\n            \"LastModifiedDate\": \"2020-11-06T14:04:44.000+0000\",\n            \"LastModifiedById\": \"00558000000yFyDAAU\",\n            \"SystemModstamp\": \"2020-11-06T14:04:44.000+0000\",\n            \"Endpoint\": \"https://hooks.slack.com/services/SECRET\",\n            \"PrincipalType\": \"Anonymous\",\n            \"JwtIssuer\": null,\n            \"JwtFormulaSubject\": null,\n            \"JwtTextSubject\": null,\n            \"JwtValidityPeriodSeconds\": null,\n            \"JwtAudience\": null,\n            \"AuthTokenEndpointUrl\": null\n        }\n    ]\n}"
    }
  ]
}