Chilkat Online Tools

Swift / Salesforce Platform APIs / Create External Credential

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

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

    // {
    //   "developerName": "SampleExternalCredential",
    //   "masterLabel": "Sample External Credential",
    //   "authenticationProtocol": "Custom",
    //   "principals": [
    //     {
    //       "principalName": "SamplePrincipal",
    //       "principalType": "NamedPrincipal",
    //       "sequenceNumber": 1
    //     }
    //   ],
    //   "customHeaders": [
    //     {
    //       "headerName": "SampleHeader",
    //       "headerValue": "SampleHeaderValue",
    //       "sequenceNumber": 1
    //     }
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("developerName", value: "SampleExternalCredential")
    json.UpdateString("masterLabel", value: "Sample External Credential")
    json.UpdateString("authenticationProtocol", value: "Custom")
    json.UpdateString("principals[0].principalName", value: "SamplePrincipal")
    json.UpdateString("principals[0].principalType", value: "NamedPrincipal")
    json.UpdateInt("principals[0].sequenceNumber", value: 1)
    json.UpdateString("customHeaders[0].headerName", value: "SampleHeader")
    json.UpdateString("customHeaders[0].headerValue", value: "SampleHeaderValue")
    json.UpdateInt("customHeaders[0].sequenceNumber", value: 1)

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

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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": [
    //   ],
    //   "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

    var headerName: String?
    var headerValue: String?
    var sequenceNumber: Int
    var principalName: String?
    var principalType: String?
    var j: Int
    var count_j: Int

    var authenticationProtocol: String? = jResp.StringOf("authenticationProtocol")
    var authenticationStatus: String? = jResp.StringOf("authenticationStatus")
    var developerName: String? = jResp.StringOf("developerName")
    var id: String? = jResp.StringOf("id")
    var masterLabel: String? = jResp.StringOf("masterLabel")
    var url: String? = jResp.StringOf("url")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("customHeaders").intValue
    while i < count_i {
        jResp.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").intValue
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("parameters").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("principals").intValue
    while i < count_i {
        jResp.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").intValue
        j = 0
        count_j = jResp.SizeOfArray("principals[i].parameters").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("principals[i].principalAccess").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("relatedNamedCredentials").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
   "developerName": "SampleExternalCredential",
   "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

Postman Collection Item JSON

{
  "name": "Create External Credential",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"developerName\": \"SampleExternalCredential\",\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",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "external-credentials"
      ]
    },
    "description": "Create an external credential."
  },
  "response": [
    {
      "name": "Successful Create External Credential",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"developerName\": \"SampleExternalCredential\",\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",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "external-credentials"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:53:51 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    \"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    \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}"
    }
  ]
}