Swift / Salesforce Platform APIs / Get External Credentials by Developer Name
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "authenticationProtocol": "Custom",
// "authenticationProtocolVariant": "NoAuthentication",
// "authenticationStatus": "NotConfigured",
// "customHeaders": [
// ],
// "developerName": "Test",
// "id": "0pt...",
// "masterLabel": "Test",
// "parameters": [
// ],
// "principals": [
// ],
// "relatedNamedCredentials": [
// {
// "developerName": "Test",
// "id": "0XA...",
// "masterLabel": "Test",
// "url": "/services/data/v58.0/named-credentials/named-credential-setup/Test"
// }
// ],
// "url": "/services/data/v58.0/named-credentials/external-credentials/Test"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var authenticationProtocol: String? = jResp.string(of: "authenticationProtocol")
var authenticationProtocolVariant: String? = jResp.string(of: "authenticationProtocolVariant")
var authenticationStatus: String? = jResp.string(of: "authenticationStatus")
var developerName: String? = jResp.string(of: "developerName")
var id: String? = jResp.string(of: "id")
var masterLabel: String? = jResp.string(of: "masterLabel")
var url: String? = jResp.string(of: "url")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "customHeaders").intValue
while i < count_i {
jResp.i = i
i = i + 1
}
i = 0
count_i = jResp.size(ofArray: "parameters").intValue
while i < count_i {
jResp.i = i
i = i + 1
}
i = 0
count_i = jResp.size(ofArray: "principals").intValue
while i < count_i {
jResp.i = i
i = i + 1
}
i = 0
count_i = jResp.size(ofArray: "relatedNamedCredentials").intValue
while i < count_i {
jResp.i = i
developerName = jResp.string(of: "relatedNamedCredentials[i].developerName")
id = jResp.string(of: "relatedNamedCredentials[i].id")
masterLabel = jResp.string(of: "relatedNamedCredentials[i].masterLabel")
url = jResp.string(of: "relatedNamedCredentials[i].url")
i = i + 1
}
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Get External Credentials by Developer Name",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": ""
}
]
},
"description": "Get an external credential, including the named credentials and principals associated with it and the type and status of each principal."
},
"response": [
{
"name": "Successful Get External Credentials by Developer Name",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "Test"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:49:36 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\": \"NotConfigured\",\n \"customHeaders\": [],\n \"developerName\": \"Test\",\n \"id\": \"0pt...\",\n \"masterLabel\": \"Test\",\n \"parameters\": [],\n \"principals\": [],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"Test\",\n \"id\": \"0XA...\",\n \"masterLabel\": \"Test\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n}"
}
]
}