Chilkat Online Tools

Ruby / Salesforce Platform APIs / Get Credential

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("externalCredential","")
queryParams.UpdateString("principalName","")
queryParams.UpdateString("principalType","")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/named-credentials/credential",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

authenticationProtocol = jResp.stringOf("authenticationProtocol")
authenticationProtocolVariant = jResp.stringOf("authenticationProtocolVariant")
authenticationStatus = jResp.stringOf("authenticationStatus")
externalCredential = jResp.stringOf("externalCredential")
principalName = jResp.stringOf("principalName")
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}"
    }
  ]
}