Chilkat Online Tools

C / Salesforce Platform APIs / Create Credential

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 json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *authenticationProtocol;
    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();

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "authenticationProtocol": "Custom",
    //   "credentials": {},
    //   "externalCredential": "SampleExternalCredential",
    //   "principalName": "SamplePrincipal",
    //   "principalType": "NamedPrincipal"
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"authenticationProtocol","Custom");
    CkJsonObject_UpdateNewObject(json,"credentials");
    CkJsonObject_UpdateString(json,"externalCredential","SampleExternalCredential");
    CkJsonObject_UpdateString(json,"principalName","SamplePrincipal");
    CkJsonObject_UpdateString(json,"principalType","NamedPrincipal");

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

    resp = CkHttp_PostJson3(http,"https://domain.com/services/data/v{{version}}/named-credentials/credential","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        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(json);
        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",
    //   "authenticationStatus": "Unknown",
    //   "credentials": {},
    //   "externalCredential": "SampleExternalCredential",
    //   "principalName": "SamplePrincipal",
    //   "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");
    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(json);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "authenticationProtocol": "Custom",
    "credentials": {},
    "externalCredential": "SampleExternalCredential",
    "principalName": "SamplePrincipal",
    "principalType": "NamedPrincipal"
}'
https://domain.com/services/data/v{{version}}/named-credentials/credential

Postman Collection Item JSON

{
  "name": "Create Credential",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"authenticationProtocol\": \"Custom\",\n    \"credentials\": {},\n    \"externalCredential\": \"SampleExternalCredential\",\n    \"principalName\": \"SamplePrincipal\",\n    \"principalType\": \"NamedPrincipal\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "credential"
      ]
    },
    "description": "Create a credential."
  },
  "response": [
    {
      "name": "successful Create Credential",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"authenticationProtocol\": \"Custom\",\n    \"credentials\": {},\n    \"externalCredential\": \"SampleExternalCredential\",\n    \"principalName\": \"SamplePrincipal\",\n    \"principalType\": \"NamedPrincipal\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "credential"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 Nov 2023 12:06:08 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    \"authenticationStatus\": \"Unknown\",\n    \"credentials\": {},\n    \"externalCredential\": \"SampleExternalCredential\",\n    \"principalName\": \"SamplePrincipal\",\n    \"principalType\": \"NamedPrincipal\"\n}"
    }
  ]
}