Chilkat Online Tools

Objective-C / Salesforce Platform APIs / List named credentials

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"q" value: @"SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/services/data/v{{version}}/tooling/query/" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *v_Type = 0;
NSString *v_Url = 0;
NSString *Id = 0;
BOOL IsDeleted;
NSString *DeveloperName = 0;
NSString *Language = 0;
NSString *MasterLabel = 0;
NSString *NamespacePrefix = 0;
NSString *CreatedDate = 0;
NSString *CreatedById = 0;
NSString *LastModifiedDate = 0;
NSString *LastModifiedById = 0;
NSString *SystemModstamp = 0;
NSString *Endpoint = 0;
NSString *PrincipalType = 0;
NSString *JwtIssuer = 0;
NSString *JwtFormulaSubject = 0;
NSString *JwtTextSubject = 0;
NSString *JwtValidityPeriodSeconds = 0;
NSString *JwtAudience = 0;
NSString *AuthTokenEndpointUrl = 0;

int size = [[jResp IntOf: @"size"] intValue];
int totalSize = [[jResp IntOf: @"totalSize"] intValue];
BOOL done = [jResp BoolOf: @"done"];
NSString *queryLocator = [jResp StringOf: @"queryLocator"];
NSString *entityTypeName = [jResp StringOf: @"entityTypeName"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"records"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: 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;
}

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