Lua Requires Chilkat v10.1.0+

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. Lua

local chilkat = require("chilkat")

-- 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
local bootstrap = chilkat.Secrets.new()

-- 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.
local bsId = chilkat.JsonObject.new()
bsId:update_string("appName", "ibm_bs")
bsId:update_string("service", "Example")
bsId:update_string("username", "Joe")

-- ----------------------------------------------------
local secrets = chilkat.Secrets.new()

-- Setup for the IBM Cloud Secrets
secrets.location = "ibm_cloud"
local success = secrets:set_bootstrap_secret(bsId, bootstrap)
if not success then
    print(secrets.last_error_text)
    return
end

-- 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.
local jsonMatch = chilkat.JsonObject.new()
jsonMatch:update_string("appName", "Test*")
-- The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
jsonMatch:update_string("service", "*")
jsonMatch:update_string("domain", "*")
jsonMatch:update_string("username", "*")

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

local results = chilkat.JsonObject.new()
results.emit_compact = false

success = secrets:list_secrets(jsonMatch, results)
if not success then
    print(secrets.last_error_text)
    return
end

print(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.

local appName = ""
local service = ""
local domain = ""
local username = ""
local ibm_id = ""

local i = 0
local numSecrets = results:size_of_array("secrets")
while i < numSecrets do
    results.i = i
    -- Note: appName and domain are optional and may not exist in any given secret.
    appName = results:string_of("secrets[i].appName")
    service = results:string_of("secrets[i].service")
    domain = results:string_of("secrets[i].domain")
    username = results:string_of("secrets[i].username")
    -- Information field for the raw IBM secret ID.
    ibm_id = results:string_of("secrets[i].ibm_id")
    i = i + 1
end