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;
const char *authenticationProtocol;
const char *authenticationProtocolVariant;
const char *authenticationStatus;
const char *developerName;
const char *id;
const char *masterLabel;
const char *url;
int j;
int count_j;
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/external-credentials",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)
// {
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"externalCredentials");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
authenticationProtocol = CkJsonObject_stringOf(jResp,"externalCredentials[i].authenticationProtocol");
authenticationProtocolVariant = CkJsonObject_stringOf(jResp,"externalCredentials[i].authenticationProtocolVariant");
authenticationStatus = CkJsonObject_stringOf(jResp,"externalCredentials[i].authenticationStatus");
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");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"externalCredentials[i].customHeaders");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"externalCredentials[i].parameters");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"externalCredentials[i].principals");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"externalCredentials[i].relatedNamedCredentials");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
developerName = CkJsonObject_stringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].developerName");
id = CkJsonObject_stringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].id");
masterLabel = CkJsonObject_stringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].masterLabel");
url = CkJsonObject_stringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].url");
j = j + 1;
}
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/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}"
}
]
}
