Chilkat Online Tools

Go / Salesforce Platform APIs / Create Credential

Back to Collection Items

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

    http := chilkat.NewHttp()
    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.

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

    json := chilkat.NewJsonObject()
    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.SetAuthToken("<access_token>")

    resp := http.PostJson3("https://domain.com/services/data/v{{version}}/named-credentials/credential","application/json",json)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        json.DisposeJsonObject()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

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

    http.DisposeHttp()
    json.DisposeJsonObject()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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