Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Update named 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.

    ; {
    ;   "FullName": "MyNamedCredential",
    ;   "Metadata": {
    ;     "label": "My Named Credential",
    ;     "endpoint": "arn:aws:AWS_REGION:AWS_ACCOUNT_ID",
    ;     "principalType": "Anonymous",
    ;     "protocol": "NoAuthentication"
    ;   }
    ; }

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

    CkJsonObject::ckUpdateString(json,"FullName","MyNamedCredential")
    CkJsonObject::ckUpdateString(json,"Metadata.label","My Named Credential")
    CkJsonObject::ckUpdateString(json,"Metadata.endpoint","arn:aws:AWS_REGION:AWS_ACCOUNT_ID")
    CkJsonObject::ckUpdateString(json,"Metadata.principalType","Anonymous")
    CkJsonObject::ckUpdateString(json,"Metadata.protocol","NoAuthentication")

    ; 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,"PATCH","https://domain.com/services/data/v{{version}}/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID",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 PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
    "FullName": "MyNamedCredential",
    "Metadata": {
        "label": "My Named Credential",
        "endpoint" : "arn:aws:AWS_REGION:AWS_ACCOUNT_ID",
        "principalType" : "Anonymous",
        "protocol": "NoAuthentication" 
    }
}'
https://domain.com/services/data/v{{version}}/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID

Postman Collection Item JSON

{
  "name": "Update named credential",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"FullName\": \"MyNamedCredential\",\n    \"Metadata\": {\n        \"label\": \"My Named Credential\",\n        \"endpoint\" : \"arn:aws:AWS_REGION:AWS_ACCOUNT_ID\",\n        \"principalType\" : \"Anonymous\",\n        \"protocol\": \"NoAuthentication\" \n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "sobjects",
        "NamedCredential",
        ":NAMED_CREDENTIAL_ID"
      ],
      "variable": [
        {
          "key": "NAMED_CREDENTIAL_ID",
          "value": null
        }
      ]
    }
  },
  "response": [
  ]
}