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 *authenticationProtocol;
const char *authenticationProtocolVariant;
const char *authenticationStatus;
const char *externalCredential;
const char *principalName;
const char *principalType;
// 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,"externalCredential","");
CkJsonObject_UpdateString(queryParams,"principalName","");
CkJsonObject_UpdateString(queryParams,"principalType","");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/services/data/v{{version}}/named-credentials/credential",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)
// {
// "authenticationProtocol": "Custom",
// "authenticationProtocolVariant": "NoAuthentication",
// "authenticationStatus": "Configured",
// "credentials": {},
// "externalCredential": "Test",
// "principalName": "Test",
// "principalType": "NamedPrincipal"
// }
// 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.
authenticationProtocol = CkJsonObject_stringOf(jResp,"authenticationProtocol");
authenticationProtocolVariant = CkJsonObject_stringOf(jResp,"authenticationProtocolVariant");
authenticationStatus = CkJsonObject_stringOf(jResp,"authenticationStatus");
externalCredential = CkJsonObject_stringOf(jResp,"externalCredential");
principalName = CkJsonObject_stringOf(jResp,"principalName");
principalType = CkJsonObject_stringOf(jResp,"principalType");
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "externalCredential="
-d "principalName="
-d "principalType="
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/credential
Postman Collection Item JSON
{
"name": "Get Credential",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=&principalName=&principalType=",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"credential"
],
"query": [
{
"key": "externalCredential",
"value": "",
"description": "Fully qualified developer name of the external credential."
},
{
"key": "principalName",
"value": "",
"description": "Name of the external credential named principal."
},
{
"key": "principalType",
"value": "",
"description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal"
}
]
},
"description": "Get a credential."
},
"response": [
{
"name": "Successful Get Credential",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=Test&principalName=Test&principalType=NamedPrincipal",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"credential"
],
"query": [
{
"key": "externalCredential",
"value": "Test",
"description": "Fully qualified developer name of the external credential."
},
{
"key": "principalName",
"value": "Test",
"description": "Name of the external credential named principal."
},
{
"key": "principalType",
"value": "NamedPrincipal",
"description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 12:01:04 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\": \"Configured\",\n \"credentials\": {},\n \"externalCredential\": \"Test\",\n \"principalName\": \"Test\",\n \"principalType\": \"NamedPrincipal\"\n}"
}
]
}
