Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Update Credential

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "externalCredential": "test",
    ;   "authenticationProtocol": "Custom",
    ;   "principalName": "test",
    ;   "principalType": "NamedPrincipal",
    ;   "credentials": {
    ;     "testCredential": {
    ;       "value": "000000",
    ;       "encrypted": true
    ;     }
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"externalCredential","test")
    CkJsonObject::ckUpdateString(json,"authenticationProtocol","Custom")
    CkJsonObject::ckUpdateString(json,"principalName","test")
    CkJsonObject::ckUpdateString(json,"principalType","NamedPrincipal")
    CkJsonObject::ckUpdateString(json,"credentials.testCredential.value","000000")
    CkJsonObject::ckUpdateBool(json,"credentials.testCredential.encrypted",1)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/services/data/v{{version}}/named-credentials/credential",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "externalCredential": "test",
    "authenticationProtocol": "Custom",
    "principalName": "test",
    "principalType": "NamedPrincipal",
    "credentials": {
        "testCredential": {
            "value": "000000",
            "encrypted": true
        }
    }
}'
https://domain.com/services/data/v{{version}}/named-credentials/credential

Postman Collection Item JSON

{
  "name": "Update Credential",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"externalCredential\": \"test\",\n    \"authenticationProtocol\": \"Custom\",\n    \"principalName\": \"test\",\n    \"principalType\": \"NamedPrincipal\",\n    \"credentials\": {\n        \"testCredential\": {\n            \"value\": \"000000\",\n            \"encrypted\": true\n        }\n    }\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": "Update a credential."
  },
  "response": [
  ]
}