(SQL Server) IBM Cloud Secrets - Get a String Secret

See more Secrets Examples

Demonstrates how to fetch the content of a string secret from the IBM Cloud Secrets.

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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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
    DECLARE @bootstrap int
    -- Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Secrets', @bootstrap OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- 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.
    -- ---------------------------------------------------------------------------------------------
    EXEC sp_OASetProperty @bootstrap, 'Location', 'local_manager'

    -- Specify the bootstrap secret to be used.
    DECLARE @bsId int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @bsId OUT

    DECLARE @success int
    EXEC sp_OAMethod @bsId, 'UpdateString', @success OUT, 'appName', 'ibm_bs'
    EXEC sp_OAMethod @bsId, 'UpdateString', @success OUT, 'service', 'Example'
    EXEC sp_OAMethod @bsId, 'UpdateString', @success OUT, 'username', 'Joe'

    -- ----------------------------------------------------
    DECLARE @secrets int
    -- Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Secrets', @secrets OUT

    EXEC sp_OASetProperty @secrets, 'Location', 'ibm_cloud'
    DECLARE @success int
    EXEC sp_OAMethod @secrets, 'SetBootstrapSecret', @success OUT, @bsId, @bootstrap
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @secrets, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @bootstrap
        EXEC @hr = sp_OADestroy @bsId
        EXEC @hr = sp_OADestroy @secrets
        RETURN
      END

    -- Specify the secret to be fetched.
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appName', 'Test'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'service', 'Something'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'domain', 'Xyz'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'username', 'Abc'

    -- You'll also need to specify your IBM Cloud instance ID and region for each API call.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'instance_id', 'a88a0c56-50a6-4461-9911-345b173e1171'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'region', 'us-south'

    -- Get the secret.
    DECLARE @secretValue nvarchar(4000)
    EXEC sp_OAMethod @secrets, 'GetSecretStr', @secretValue OUT, @json
    EXEC sp_OAGetProperty @secrets, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @secrets, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @bootstrap
        EXEC @hr = sp_OADestroy @bsId
        EXEC @hr = sp_OADestroy @secrets
        EXEC @hr = sp_OADestroy @json
        RETURN
      END


    PRINT 'The content of the secret: ' + @secretValue

    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @bootstrap
    EXEC @hr = sp_OADestroy @bsId
    EXEC @hr = sp_OADestroy @secrets
    EXEC @hr = sp_OADestroy @json


END
GO