(JavaScript) IBM Cloud Secrets - List Matching Secrets

See more Secrets Examples

Note: This example requires Chilkat v10.1.0 or later.

For more information, see https://cknotes.com/chilkat-secrets-class-added-in-version-10-1-0/

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

// The bootstrap secret will contain the following information:

// IBM Cloud API Key

// See following examples for setting up a bootstrap secret in memory, 
// or in the local manager (Windows Credentials Manager or Apple Keychain)
// Setup Bootstrap Secret in Local Manager
// Setup Bootstrap Secret in Memory
var bootstrap = new CkSecrets();

// Set the location of the bootstrap secret.
// Can be "local_manager" or "memory", depending on how you setup the bootstrap secret.
// ---------------------------------------------------------------------------------------------
// If your operating system is NOT Windows or MacOS/iOS, then change "local_manager" to "memory"
// You can also, if desired, use "memory" on Windows and MacOS/iOS if your bootstrap secret was previously setup in memory.
// ---------------------------------------------------------------------------------------------
bootstrap.Location = "local_manager";

// Specify the bootstrap secret to be used.
var bsId = new CkJsonObject();
bsId.UpdateString("appName","ibm_bs");
bsId.UpdateString("service","Example");
bsId.UpdateString("username","Joe");

// ----------------------------------------------------
var secrets = new CkSecrets();

// Setup for the IBM Cloud Secrets
secrets.Location = "ibm_cloud";
success = secrets.SetBootstrapSecret(bsId,bootstrap);
if (success == false) {
    console.log(secrets.LastErrorText);
    return;
}

// Set wildcarded or exact values for appName, service, domain, and username.
// Omit any members where anything is allowed to match, or alternatively specify "*" to match anything.
var jsonMatch = new CkJsonObject();
jsonMatch.UpdateString("appName","Test*");
// The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
jsonMatch.UpdateString("service","*");
jsonMatch.UpdateString("domain","*");
jsonMatch.UpdateString("username","*");

// You'll also need to specify your IBM Cloud instance ID and region for each API call.
jsonMatch.UpdateString("instance_id","a88a0c56-50a6-4461-9911-345b173e1171");
jsonMatch.UpdateString("region","us-south");

var results = new CkJsonObject();
results.EmitCompact = false;

success = secrets.ListSecrets(jsonMatch,results);
if (success == false) {
    console.log(secrets.LastErrorText);
    return;
}

console.log(results.Emit());

// Sample output:

// {
//   "secrets": [
//     {
//       "appName": "Test",
//       "service": "Something",
//       "domain": "Xyz",
//       "username": "Abc",
//       "ibm_id": "13a3d6fa-c25c-1afb-e54b-8cd2e0565f68"
//     },
//     {
//       "appName": "Test2",
//       "service": "Custom",
//       "domain": "Ocean",
//       "username": "Starfish",
//       "ibm_id": "767a3c55-d332-8bab-18e4-9e174d41a158"
//     }
//   ]
// }

// ---------------------------------------------------------------------------------------
// Here's sample code for parsing the JSON list of secrets.

var appName;
var service;
var domain;
var username;
var ibm_id;

var i = 0;
var numSecrets = results.SizeOfArray("secrets");
while (i < numSecrets) {
    results.I = i;
    // Note: appName and domain are optional and may not exist in any given secret.
    appName = results.StringOf("secrets[i].appName");
    service = results.StringOf("secrets[i].service");
    domain = results.StringOf("secrets[i].domain");
    username = results.StringOf("secrets[i].username");
    // Information field for the raw IBM secret ID.
    ibm_id = results.StringOf("secrets[i].ibm_id");
    i = i+1;
}