(Unicode C) 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.

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

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkSecretsW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkSecretsW bootstrap;
    HCkJsonObjectW bsId;
    HCkSecretsW secrets;
    BOOL success;
    HCkJsonObjectW jsonMatch;
    HCkJsonObjectW results;
    const wchar_t *appName;
    const wchar_t *service;
    const wchar_t *domain;
    const wchar_t *username;
    const wchar_t *ibm_id;
    int i;
    int numSecrets;

    // 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
    bootstrap = CkSecretsW_Create();

    // 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.
    // ---------------------------------------------------------------------------------------------
    CkSecretsW_putLocation(bootstrap,L"local_manager");

    // Specify the bootstrap secret to be used.
    bsId = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(bsId,L"appName",L"ibm_bs");
    CkJsonObjectW_UpdateString(bsId,L"service",L"Example");
    CkJsonObjectW_UpdateString(bsId,L"username",L"Joe");

    // ----------------------------------------------------
    secrets = CkSecretsW_Create();

    // Setup for the IBM Cloud Secrets
    CkSecretsW_putLocation(secrets,L"ibm_cloud");
    success = CkSecretsW_SetBootstrapSecret(secrets,bsId,bootstrap);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSecretsW_lastErrorText(secrets));
        CkSecretsW_Dispose(bootstrap);
        CkJsonObjectW_Dispose(bsId);
        CkSecretsW_Dispose(secrets);
        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.
    jsonMatch = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(jsonMatch,L"appName",L"Test*");
    // The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    CkJsonObjectW_UpdateString(jsonMatch,L"service",L"*");
    CkJsonObjectW_UpdateString(jsonMatch,L"domain",L"*");
    CkJsonObjectW_UpdateString(jsonMatch,L"username",L"*");

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

    results = CkJsonObjectW_Create();
    CkJsonObjectW_putEmitCompact(results,FALSE);

    success = CkSecretsW_ListSecrets(secrets,jsonMatch,results);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSecretsW_lastErrorText(secrets));
        CkSecretsW_Dispose(bootstrap);
        CkJsonObjectW_Dispose(bsId);
        CkSecretsW_Dispose(secrets);
        CkJsonObjectW_Dispose(jsonMatch);
        CkJsonObjectW_Dispose(results);
        return;
    }

    wprintf(L"%s\n",CkJsonObjectW_emit(results));

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

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



    CkSecretsW_Dispose(bootstrap);
    CkJsonObjectW_Dispose(bsId);
    CkSecretsW_Dispose(secrets);
    CkJsonObjectW_Dispose(jsonMatch);
    CkJsonObjectW_Dispose(results);

    }