Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oBootstrap
LOCAL oBsId
LOCAL oSecrets
LOCAL oJsonMatch
LOCAL oResults
LOCAL cAppName
LOCAL cService
LOCAL cDomain
LOCAL cUsername
LOCAL cIbm_id
LOCAL i
LOCAL nNumSecrets

nSuccess := 0

//  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
oBootstrap := CreateObject("Chilkat.Secrets")

//  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.
//  ---------------------------------------------------------------------------------------------
oBootstrap:Location := "local_manager"

//  Specify the bootstrap secret to be used.
oBsId := CreateObject("Chilkat.JsonObject")
oBsId:UpdateString("appName", "ibm_bs")
oBsId:UpdateString("service", "Example")
oBsId:UpdateString("username", "Joe")

//  ----------------------------------------------------
oSecrets := CreateObject("Chilkat.Secrets")

//  Setup for the IBM Cloud Secrets
oSecrets:Location := "ibm_cloud"
nSuccess := oSecrets:SetBootstrapSecret(oBsId, oBootstrap)
IF (nSuccess == 0)
    ? oSecrets:LastErrorText
    oBootstrap:destroy()
    oBsId:destroy()
    oSecrets:destroy()
    RETURN
ENDIF

//  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.
oJsonMatch := CreateObject("Chilkat.JsonObject")
oJsonMatch:UpdateString("appName", "Test*")
//  The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
oJsonMatch:UpdateString("service", "*")
oJsonMatch:UpdateString("domain", "*")
oJsonMatch:UpdateString("username", "*")

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

oResults := CreateObject("Chilkat.JsonObject")
oResults:EmitCompact := 0

nSuccess := oSecrets:ListSecrets(oJsonMatch, oResults)
IF (nSuccess == 0)
    ? oSecrets:LastErrorText
    oBootstrap:destroy()
    oBsId:destroy()
    oSecrets:destroy()
    oJsonMatch:destroy()
    oResults:destroy()
    RETURN
ENDIF

? oResults: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.

i := 0
nNumSecrets := oResults:SizeOfArray("secrets")
DO WHILE i < nNumSecrets
    oResults:I := i
    //  Note: appName and domain are optional and may not exist in any given secret.
    cAppName := oResults:StringOf("secrets[i].appName")
    cService := oResults:StringOf("secrets[i].service")
    cDomain := oResults:StringOf("secrets[i].domain")
    cUsername := oResults:StringOf("secrets[i].username")
    //  Information field for the raw IBM secret ID.
    cIbm_id := oResults:StringOf("secrets[i].ibm_id")
    i := i + 1
ENDDO

oBootstrap:destroy()
oBsId:destroy()
oSecrets:destroy()
oJsonMatch:destroy()
oResults:destroy()