Zig

IBM Cloud Secrets - List Matching Secrets

See more Secrets Examples

List secrets in the IBM Cloud Secrets matching one or more wildcarded names for app, service, domain, and username.

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

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // 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
    const bootstrap = try chilkat.Secrets.init();
    defer bootstrap.deinit();

    // 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.setLocation("local_manager");

    // Specify the bootstrap secret to be used.
    const bs_id = try chilkat.JsonObject.init();
    defer bs_id.deinit();
    bs_id.updateString("appName", "ibm_bs") catch {};
    bs_id.updateString("service", "Example") catch {};
    bs_id.updateString("username", "Joe") catch {};

    // ----------------------------------------------------
    const secrets = try chilkat.Secrets.init();
    defer secrets.deinit();

    // Setup for the IBM Cloud Secrets
    secrets.setLocation("ibm_cloud");
    secrets.setBootstrapSecret(bs_id, bootstrap) catch {
        std.debug.print("{s}\n", .{try secrets.getLastErrorText(alloc)});
        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.
    const json_match = try chilkat.JsonObject.init();
    defer json_match.deinit();
    json_match.updateString("appName", "Test*") catch {};
    // The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    json_match.updateString("service", "*") catch {};
    json_match.updateString("domain", "*") catch {};
    json_match.updateString("username", "*") catch {};

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

    const results = try chilkat.JsonObject.init();
    defer results.deinit();
    results.setEmitCompact(false);

    secrets.listSecrets(json_match, results) catch {
        std.debug.print("{s}\n", .{try secrets.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("{s}\n", .{try results.emit(alloc)});

    // 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 app_name: [:0]const u8 = "";
    var service: [:0]const u8 = "";
    var domain: [:0]const u8 = "";
    var username: [:0]const u8 = "";
    var ibm_id: [:0]const u8 = "";

    var i: i32 = 0;
    const num_secrets = results.sizeOfArray("secrets");
    while (i < num_secrets) {
        results.setI(i);
        // Note: appName and domain are optional and may not exist in any given secret.
        app_name = try results.stringOf(alloc, "secrets[i].appName");
        service = try results.stringOf(alloc, "secrets[i].service");
        domain = try results.stringOf(alloc, "secrets[i].domain");
        username = try results.stringOf(alloc, "secrets[i].username");
        // Information field for the raw IBM secret ID.
        ibm_id = try results.stringOf(alloc, "secrets[i].ibm_id");
        i = i + 1;
    }
}