Chilkat Online Tools

Objective-C / Salesforce Platform APIs / Create Credential

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL 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.

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"authenticationProtocol" value: @"Custom"];
[json UpdateNewObject: @"credentials"];
[json UpdateString: @"externalCredential" value: @"SampleExternalCredential"];
[json UpdateString: @"principalName" value: @"SamplePrincipal"];
[json UpdateString: @"principalType" value: @"NamedPrincipal"];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/services/data/v{{version}}/named-credentials/credential" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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

NSString *authenticationProtocol = [jResp StringOf: @"authenticationProtocol"];
NSString *authenticationStatus = [jResp StringOf: @"authenticationStatus"];
NSString *externalCredential = [jResp StringOf: @"externalCredential"];
NSString *principalName = [jResp StringOf: @"principalName"];
NSString *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}"
    }
  ]
}