Chilkat Online Tools

Swift / Salesforce Platform APIs / Get Named Credential 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/named-credential-setup/: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)

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

    var AllowMergeFieldsInBody: Bool = jResp.BoolOf("calloutOptions.allowMergeFieldsInBody")
    var AllowMergeFieldsInHeader: Bool = jResp.BoolOf("calloutOptions.allowMergeFieldsInHeader")
    var GenerateAuthorizationHeader: Bool = jResp.BoolOf("calloutOptions.generateAuthorizationHeader")
    var calloutUrl: String? = jResp.StringOf("calloutUrl")
    var developerName: String? = jResp.StringOf("developerName")
    var id: String? = jResp.StringOf("id")
    var masterLabel: String? = jResp.StringOf("masterLabel")
    var v_type: String? = jResp.StringOf("type")
    var url: String? = jResp.StringOf("url")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("customHeaders").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("externalCredentials").intValue
    while i < count_i {
        jResp.I = i
        developerName = jResp.StringOf("externalCredentials[i].developerName")
        id = jResp.StringOf("externalCredentials[i].id")
        masterLabel = jResp.StringOf("externalCredentials[i].masterLabel")
        url = jResp.StringOf("externalCredentials[i].url")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("parameters").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }


}

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