Chilkat Online Tools

Ruby / Salesforce Platform APIs / List named credentials

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("q","SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200")

# 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}}/tooling/query/",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)

# {
#   "size": 1,
#   "totalSize": 1,
#   "done": true,
#   "queryLocator": null,
#   "entityTypeName": "NamedCredential",
#   "records": [
#     {
#       "attributes": {
#         "type": "NamedCredential",
#         "url": "/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO"
#       },
#       "Id": "0XA4H000000TNRhWAO",
#       "IsDeleted": false,
#       "DeveloperName": "Slack_Webhook_for_integration_Channel",
#       "Language": "en_US",
#       "MasterLabel": "Slack Webhook for #integration Channel",
#       "NamespacePrefix": null,
#       "CreatedDate": "2020-11-06T14:04:44.000+0000",
#       "CreatedById": "00558000000yFyDAAU",
#       "LastModifiedDate": "2020-11-06T14:04:44.000+0000",
#       "LastModifiedById": "00558000000yFyDAAU",
#       "SystemModstamp": "2020-11-06T14:04:44.000+0000",
#       "Endpoint": "https://hooks.slack.com/services/SECRET",
#       "PrincipalType": "Anonymous",
#       "JwtIssuer": null,
#       "JwtFormulaSubject": null,
#       "JwtTextSubject": null,
#       "JwtValidityPeriodSeconds": null,
#       "JwtAudience": null,
#       "AuthTokenEndpointUrl": null
#     }
#   ]
# }

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

size = jResp.IntOf("size")
totalSize = jResp.IntOf("totalSize")
done = jResp.BoolOf("done")
queryLocator = jResp.stringOf("queryLocator")
entityTypeName = jResp.stringOf("entityTypeName")
i = 0
count_i = jResp.SizeOfArray("records")
while i < count_i
    jResp.put_I(i)
    v_Type = jResp.stringOf("records[i].attributes.type")
    v_Url = jResp.stringOf("records[i].attributes.url")
    Id = jResp.stringOf("records[i].Id")
    IsDeleted = jResp.BoolOf("records[i].IsDeleted")
    DeveloperName = jResp.stringOf("records[i].DeveloperName")
    Language = jResp.stringOf("records[i].Language")
    MasterLabel = jResp.stringOf("records[i].MasterLabel")
    NamespacePrefix = jResp.stringOf("records[i].NamespacePrefix")
    CreatedDate = jResp.stringOf("records[i].CreatedDate")
    CreatedById = jResp.stringOf("records[i].CreatedById")
    LastModifiedDate = jResp.stringOf("records[i].LastModifiedDate")
    LastModifiedById = jResp.stringOf("records[i].LastModifiedById")
    SystemModstamp = jResp.stringOf("records[i].SystemModstamp")
    Endpoint = jResp.stringOf("records[i].Endpoint")
    PrincipalType = jResp.stringOf("records[i].PrincipalType")
    JwtIssuer = jResp.stringOf("records[i].JwtIssuer")
    JwtFormulaSubject = jResp.stringOf("records[i].JwtFormulaSubject")
    JwtTextSubject = jResp.stringOf("records[i].JwtTextSubject")
    JwtValidityPeriodSeconds = jResp.stringOf("records[i].JwtValidityPeriodSeconds")
    JwtAudience = jResp.stringOf("records[i].JwtAudience")
    AuthTokenEndpointUrl = jResp.stringOf("records[i].AuthTokenEndpointUrl")
    i = i + 1
end

Curl Command

curl -G -d "q=SELECT%20FIELDS%28ALL%29%20FROM%20NamedCredential%20LIMIT%20200"
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "List named credentials",
  "protocolProfileBehavior": {
    "strictSSL": false,
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
        }
      ]
    }
  },
  "response": [
    {
      "name": "List named credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:09:27 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=5/15000"
        },
        {
          "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    \"size\": 1,\n    \"totalSize\": 1,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"NamedCredential\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"NamedCredential\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO\"\n            },\n            \"Id\": \"0XA4H000000TNRhWAO\",\n            \"IsDeleted\": false,\n            \"DeveloperName\": \"Slack_Webhook_for_integration_Channel\",\n            \"Language\": \"en_US\",\n            \"MasterLabel\": \"Slack Webhook for #integration Channel\",\n            \"NamespacePrefix\": null,\n            \"CreatedDate\": \"2020-11-06T14:04:44.000+0000\",\n            \"CreatedById\": \"00558000000yFyDAAU\",\n            \"LastModifiedDate\": \"2020-11-06T14:04:44.000+0000\",\n            \"LastModifiedById\": \"00558000000yFyDAAU\",\n            \"SystemModstamp\": \"2020-11-06T14:04:44.000+0000\",\n            \"Endpoint\": \"https://hooks.slack.com/services/SECRET\",\n            \"PrincipalType\": \"Anonymous\",\n            \"JwtIssuer\": null,\n            \"JwtFormulaSubject\": null,\n            \"JwtTextSubject\": null,\n            \"JwtValidityPeriodSeconds\": null,\n            \"JwtAudience\": null,\n            \"AuthTokenEndpointUrl\": null\n        }\n    ]\n}"
    }
  ]
}