Perl 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. Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# 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
my $bootstrap = Chilkat2::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.
my $bsId = Chilkat2::JsonObject->new;
$bsId->UpdateString('appName', 'ibm_bs');
$bsId->UpdateString('service', 'Example');
$bsId->UpdateString('username', 'Joe');

# ----------------------------------------------------
my $secrets = Chilkat2::Secrets->new;

# Setup for the IBM Cloud Secrets
$secrets->Location('ibm_cloud');
my $success = $secrets->SetBootstrapSecret($bsId, $bootstrap);
if (!$success) {
    print $secrets->LastErrorText, "\n";
    exit;
}

# 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.
my $jsonMatch = Chilkat2::JsonObject->new;
$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');

my $results = Chilkat2::JsonObject->new;
$results->EmitCompact(0);

$success = $secrets->ListSecrets($jsonMatch, $results);
if (!$success) {
    print $secrets->LastErrorText, "\n";
    exit;
}

print $results->Emit(), "\n";

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

my $appName = '';
my $service = '';
my $domain = '';
my $username = '';
my $ibm_id = '';

my $i = 0;
my $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;
}