Chilkat Online Tools

PureBasic / Salesforce Platform APIs / List External Credentials

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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

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

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

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/named-credentials/external-credentials",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "externalCredentials": [
    ;     {
    ;       "authenticationProtocol": "Custom",
    ;       "authenticationProtocolVariant": "NoAuthentication",
    ;       "authenticationStatus": "NotConfigured",
    ;       "customHeaders": [
    ;       ],
    ;       "developerName": "Test",
    ;       "id": "0pt...",
    ;       "masterLabel": "Test",
    ;       "parameters": [
    ;       ],
    ;       "principals": [
    ;       ],
    ;       "relatedNamedCredentials": [
    ;         {
    ;           "developerName": "Test",
    ;           "id": "0XA...",
    ;           "masterLabel": "Test",
    ;           "url": "/services/data/v58.0/named-credentials/named-credential-setup/Test"
    ;         }
    ;       ],
    ;       "url": "/services/data/v58.0/named-credentials/external-credentials/Test"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    authenticationProtocol.s
    authenticationProtocolVariant.s
    authenticationStatus.s
    developerName.s
    id.s
    masterLabel.s
    url.s
    j.i
    count_j.i

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"externalCredentials")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        authenticationProtocol = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].authenticationProtocol")
        authenticationProtocolVariant = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].authenticationProtocolVariant")
        authenticationStatus = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].authenticationStatus")
        developerName = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].developerName")
        id = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].id")
        masterLabel = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].masterLabel")
        url = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].url")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"externalCredentials[i].customHeaders")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"externalCredentials[i].parameters")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"externalCredentials[i].principals")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"externalCredentials[i].relatedNamedCredentials")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            developerName = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].developerName")
            id = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].id")
            masterLabel = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].masterLabel")
            url = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].relatedNamedCredentials[j].url")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/external-credentials

Postman Collection Item JSON

{
  "name": "List External Credentials",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "external-credentials"
      ]
    },
    "description": "Get external credentials that the user can authenticate to."
  },
  "response": [
    {
      "name": "Successful List External Credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "external-credentials"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:46:27 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    \"externalCredentials\": [\n        {\n            \"authenticationProtocol\": \"Custom\",\n            \"authenticationProtocolVariant\": \"NoAuthentication\",\n            \"authenticationStatus\": \"NotConfigured\",\n            \"customHeaders\": [],\n            \"developerName\": \"Test\",\n            \"id\": \"0pt...\",\n            \"masterLabel\": \"Test\",\n            \"parameters\": [],\n            \"principals\": [],\n            \"relatedNamedCredentials\": [\n                {\n                    \"developerName\": \"Test\",\n                    \"id\": \"0XA...\",\n                    \"masterLabel\": \"Test\",\n                    \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n                }\n            ],\n            \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n        }\n    ]\n}"
    }
  ]
}