Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Get Credential

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAuthenticationProtocol
LOCAL lcAuthenticationProtocolVariant
LOCAL lcAuthenticationStatus
LOCAL lcExternalCredential
LOCAL lcPrincipalName
LOCAL lcPrincipalType

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("externalCredential","")
loQueryParams.UpdateString("principalName","")
loQueryParams.UpdateString("principalType","")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/named-credentials/credential",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "authenticationProtocol": "Custom",
*   "authenticationProtocolVariant": "NoAuthentication",
*   "authenticationStatus": "Configured",
*   "credentials": {},
*   "externalCredential": "Test",
*   "principalName": "Test",
*   "principalType": "NamedPrincipal"
* }

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

lcAuthenticationProtocol = loJResp.StringOf("authenticationProtocol")
lcAuthenticationProtocolVariant = loJResp.StringOf("authenticationProtocolVariant")
lcAuthenticationStatus = loJResp.StringOf("authenticationStatus")
lcExternalCredential = loJResp.StringOf("externalCredential")
lcPrincipalName = loJResp.StringOf("principalName")
lcPrincipalType = loJResp.StringOf("principalType")

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -G -d "externalCredential="
	-d "principalName="
	-d "principalType="
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/credential

Postman Collection Item JSON

{
  "name": "Get Credential",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=&principalName=&principalType=",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "credential"
      ],
      "query": [
        {
          "key": "externalCredential",
          "value": "",
          "description": "Fully qualified developer name of the external credential."
        },
        {
          "key": "principalName",
          "value": "",
          "description": "Name of the external credential named principal."
        },
        {
          "key": "principalType",
          "value": "",
          "description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal"
        }
      ]
    },
    "description": "Get a credential."
  },
  "response": [
    {
      "name": "Successful Get Credential",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=Test&principalName=Test&principalType=NamedPrincipal",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "credential"
          ],
          "query": [
            {
              "key": "externalCredential",
              "value": "Test",
              "description": "Fully qualified developer name of the external credential."
            },
            {
              "key": "principalName",
              "value": "Test",
              "description": "Name of the external credential named principal."
            },
            {
              "key": "principalType",
              "value": "NamedPrincipal",
              "description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 Nov 2023 12:01:04 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    \"authenticationProtocolVariant\": \"NoAuthentication\",\n    \"authenticationStatus\": \"Configured\",\n    \"credentials\": {},\n    \"externalCredential\": \"Test\",\n    \"principalName\": \"Test\",\n    \"principalType\": \"NamedPrincipal\"\n}"
    }
  ]
}