Chilkat Online Tools

Xojo / Salesforce Platform APIs / Get Credential

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("externalCredential","")
success = queryParams.UpdateString("principalName","")
success = queryParams.UpdateString("principalType","")

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As New Chilkat.HttpResponse
success = http.HttpParams("GET","https://domain.com/services/data/v{{version}}/named-credentials/credential",queryParams,resp)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")
    Return
End If

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

Dim authenticationProtocol As String
authenticationProtocol = jResp.StringOf("authenticationProtocol")
Dim authenticationProtocolVariant As String
authenticationProtocolVariant = jResp.StringOf("authenticationProtocolVariant")
Dim authenticationStatus As String
authenticationStatus = jResp.StringOf("authenticationStatus")
Dim externalCredential As String
externalCredential = jResp.StringOf("externalCredential")
Dim principalName As String
principalName = jResp.StringOf("principalName")
Dim principalType As String
principalType = jResp.StringOf("principalType")

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