Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "masterLabel": "Sample External Credential",
// "authenticationProtocol": "Custom",
// "principals": [
// {
// "principalName": "SamplePrincipal",
// "principalType": "NamedPrincipal",
// "sequenceNumber": 1
// }
// ],
// "customHeaders": [
// {
// "headerName": "SampleHeader",
// "headerValue": "SampleHeaderValue",
// "sequenceNumber": 1
// }
// ]
// }
CkJsonObject json = new CkJsonObject();
json.UpdateString("masterLabel","Sample External Credential");
json.UpdateString("authenticationProtocol","Custom");
json.UpdateString("principals[0].principalName","SamplePrincipal");
json.UpdateString("principals[0].principalType","NamedPrincipal");
json.UpdateInt("principals[0].sequenceNumber",1);
json.UpdateString("customHeaders[0].headerName","SampleHeader");
json.UpdateString("customHeaders[0].headerValue","SampleHeaderValue");
json.UpdateInt("customHeaders[0].sequenceNumber",1);
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
CkStringBuilder sbRequestBody = new CkStringBuilder();
json.EmitSb(sbRequestBody);
CkHttpResponse resp = http.PTextSb("PUT","https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",sbRequestBody,"utf-8","application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "authenticationProtocol": "Custom",
// "authenticationStatus": "Unknown",
// "customHeaders": [
// {
// "headerName": "SampleHeader",
// "headerValue": "SampleHeaderValue",
// "id": "0pu2o000000KymkAAC",
// "sequenceNumber": 1
// }
// ],
// "developerName": "SampleExternalCredential",
// "id": "0pt2o000000CaU0AAK",
// "masterLabel": "Sample External Credential",
// "parameters": [
// ],
// "principals": [
// {
// "authenticationStatus": "Unknown",
// "id": "0pu2o000000KymjAAC",
// "parameters": [
// ],
// "principalAccess": [
// ],
// "principalName": "SamplePrincipal",
// "principalType": "NamedPrincipal",
// "sequenceNumber": 1
// }
// ],
// "relatedNamedCredentials": [
// {
// "developerName": "SamplePrivate",
// "id": "0XA2o000000XaAQGA0",
// "masterLabel": "SamplePrivateLabel",
// "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
// }
// ],
// "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
String headerName;
String headerValue;
int sequenceNumber;
String principalName;
String principalType;
int j;
int count_j;
String authenticationProtocol = jResp.stringOf("authenticationProtocol");
String authenticationStatus = jResp.stringOf("authenticationStatus");
String developerName = jResp.stringOf("developerName");
String id = jResp.stringOf("id");
String masterLabel = jResp.stringOf("masterLabel");
String url = jResp.stringOf("url");
int i = 0;
int count_i = jResp.SizeOfArray("customHeaders");
while (i < count_i) {
jResp.put_I(i);
headerName = jResp.stringOf("customHeaders[i].headerName");
headerValue = jResp.stringOf("customHeaders[i].headerValue");
id = jResp.stringOf("customHeaders[i].id");
sequenceNumber = jResp.IntOf("customHeaders[i].sequenceNumber");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("parameters");
while (i < count_i) {
jResp.put_I(i);
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("principals");
while (i < count_i) {
jResp.put_I(i);
authenticationStatus = jResp.stringOf("principals[i].authenticationStatus");
id = jResp.stringOf("principals[i].id");
principalName = jResp.stringOf("principals[i].principalName");
principalType = jResp.stringOf("principals[i].principalType");
sequenceNumber = jResp.IntOf("principals[i].sequenceNumber");
j = 0;
count_j = jResp.SizeOfArray("principals[i].parameters");
while (j < count_j) {
jResp.put_J(j);
j = j + 1;
}
j = 0;
count_j = jResp.SizeOfArray("principals[i].principalAccess");
while (j < count_j) {
jResp.put_J(j);
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("relatedNamedCredentials");
while (i < count_i) {
jResp.put_I(i);
developerName = jResp.stringOf("relatedNamedCredentials[i].developerName");
id = jResp.stringOf("relatedNamedCredentials[i].id");
masterLabel = jResp.stringOf("relatedNamedCredentials[i].masterLabel");
url = jResp.stringOf("relatedNamedCredentials[i].url");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"masterLabel": "Sample External Credential",
"authenticationProtocol": "Custom",
"principals": [
{
"principalName": "SamplePrincipal",
"principalType": "NamedPrincipal",
"sequenceNumber": 1
}
],
"customHeaders": [
{
"headerName": "SampleHeader",
"headerValue": "SampleHeaderValue",
"sequenceNumber": 1
}
]
}'
https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Update External Credential",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": ""
}
]
},
"description": "Update an external credential."
},
"response": [
{
"name": "Successful Update External Credential",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "SampleExternalCredential"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:55:19 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": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationStatus\": \"Unknown\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"id\": \"0pu2o000000KymkAAC\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"parameters\": [],\n \"principals\": [\n {\n \"authenticationStatus\": \"Unknown\",\n \"id\": \"0pu2o000000KymjAAC\",\n \"parameters\": [],\n \"principalAccess\": [],\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"SamplePrivate\",\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}"
}
]
}
