lianja / Salesforce Platform APIs / Get Named Credential by Developer Name
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "calloutOptions": {
// "allowMergeFieldsInBody": false,
// "allowMergeFieldsInHeader": false,
// "generateAuthorizationHeader": true
// },
// "calloutUrl": "https://my.example.com",
// "customHeaders": [
// ],
// "developerName": "Test",
// "externalCredentials": [
// {
// "developerName": "Test",
// "id": "0pt...",
// "masterLabel": "Test",
// "url": "/services/data/v58.0/named-credentials/external-credentials/Test"
// }
// ],
// "id": "0XA...",
// "masterLabel": "Test",
// "parameters": [
// ],
// "type": "SecuredEndpoint",
// "url": "/services/data/v58.0/named-credentials/named-credential-setup/Test"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
llAllowMergeFieldsInBody = loJResp.BoolOf("calloutOptions.allowMergeFieldsInBody")
llAllowMergeFieldsInHeader = loJResp.BoolOf("calloutOptions.allowMergeFieldsInHeader")
llGenerateAuthorizationHeader = loJResp.BoolOf("calloutOptions.generateAuthorizationHeader")
lcCalloutUrl = loJResp.StringOf("calloutUrl")
lcDeveloperName = loJResp.StringOf("developerName")
lcId = loJResp.StringOf("id")
lcMasterLabel = loJResp.StringOf("masterLabel")
lcV_type = loJResp.StringOf("type")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("customHeaders")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("externalCredentials")
do while i < lnCount_i
loJResp.I = i
lcDeveloperName = loJResp.StringOf("externalCredentials[i].developerName")
lcId = loJResp.StringOf("externalCredentials[i].id")
lcMasterLabel = loJResp.StringOf("externalCredentials[i].masterLabel")
lcUrl = loJResp.StringOf("externalCredentials[i].url")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("parameters")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Get Named Credential by Developer Name",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"named-credential-setup",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": null
}
]
},
"description": "Get a named credential."
},
"response": [
{
"name": "Successful Get Named Credential by Developer Name",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"named-credential-setup",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "Test"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:50:01 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 \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": false,\n \"generateAuthorizationHeader\": true\n },\n \"calloutUrl\": \"https://my.example.com\",\n \"customHeaders\": [],\n \"developerName\": \"Test\",\n \"externalCredentials\": [\n {\n \"developerName\": \"Test\",\n \"id\": \"0pt...\",\n \"masterLabel\": \"Test\",\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n }\n ],\n \"id\": \"0XA...\",\n \"masterLabel\": \"Test\",\n \"parameters\": [],\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n}"
}
]
}