Chilkat Online Tools

Perl / Salesforce Platform APIs / Create Credential

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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 = chilkat::CkJsonObject->new();
$json->UpdateString("authenticationProtocol","Custom");
$json->UpdateNewObject("credentials");
$json->UpdateString("externalCredential","SampleExternalCredential");
$json->UpdateString("principalName","SamplePrincipal");
$json->UpdateString("principalType","NamedPrincipal");

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");

# resp is a HttpResponse
$resp = $http->PostJson3("https://domain.com/services/data/v{{version}}/named-credentials/credential","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$authenticationProtocol = $jResp->stringOf("authenticationProtocol");
$authenticationStatus = $jResp->stringOf("authenticationStatus");
$externalCredential = $jResp->stringOf("externalCredential");
$principalName = $jResp->stringOf("principalName");
$principalType = $jResp->stringOf("principalType");

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