---
product: Chilkat
product_version: 11.7.0
language: powerbuilder
language_label: PowerBuilder
class: Secrets
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/powerbuilder_SecretsRef.html
---
# Chilkat Secrets — PowerBuilder — v11.7.0

> Chilkat 11.7.0 · language=powerbuilder · class=Secrets
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Secrets.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/guide.md`.

## Purpose

**Manage application secrets through one consistent API.**

`Chilkat.Secrets` provides a unified interface for storing, retrieving, listing, and deleting secrets across local, cloud-based, and in-memory secret stores. It supports string, binary, and JSON secrets, making it useful for passwords, API keys, OAuth credentials, tokens, unlock codes, certificates, and private configuration data.

**Local secure storage**

- Windows Credential Manager
- Apple Keychain

**Cloud secret managers**

- AWS Secrets Manager
- Azure Key Vault
- IBM Cloud Secrets Manager
- Oracle Cloud Secrets
- Doppler Secrets

**Temporary secrets**

Use in-memory secrets when values should exist only for the lifetime of the running process.

**Flexible content types**

Store and retrieve secrets as strings, binary data, or structured JSON.

**Note:** Cloud-based secret managers often require local bootstrap credentials. These can be stored securely in the Windows Credential Manager or Apple Keychain and then used to authenticate to the cloud secret manager.

Start with the [Conceptual Overview](https://www.chilkatsoft.com/chilkat_secrets_api.asp) and [Components of a Secret Name](https://www.chilkatsoft.com/components_of_a_secret_name.asp). For an extended overview, see the [Secrets Class Overview](https://www.chilkatsoft.com/secrets_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```powerbuilder
oleobject loo_Secrets
integer li_rc

loo_Secrets = create oleobject
li_rc = loo_Secrets.ConnectToNewObject("Chilkat.Secrets")
if li_rc < 0 then
    destroy loo_Secrets
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_Secrets ...

destroy loo_Secrets
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.Secrets.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PowerBuilder.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `blob LastBinaryResult (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AutoSplit` | property, read/write | `long AutoSplit` |
| `Compression` | property, read/write | `long Compression` |
| `Location` | property, read/write | `string Location` |
| `UncommonOptions` | property, read/write | `string UncommonOptions` |
| `DeleteSecret` | method | `long DeleteSecret(ChilkatJsonObject jsonId)` |
| `GetSecretBd` | method | `long GetSecretBd(ChilkatJsonObject jsonId, ChilkatBinData bd)` |
| `GetSecretJson` | method | `long GetSecretJson(ChilkatJsonObject jsonId, ChilkatJsonObject jsonOut)` |
| `GetSecretSb` | method | `long GetSecretSb(ChilkatJsonObject jsonId, ChilkatStringBuilder sb)` |
| `GetSecretStr` | method | `string GetSecretStr(ChilkatJsonObject jsonId)` |
| `ListSecrets` | method | `long ListSecrets(ChilkatJsonObject json, ChilkatJsonObject jsonOut)` |
| `SecretSpecToJson` | method | `long SecretSpecToJson(string secretSpec, ChilkatJsonObject json)` |
| `SetBootstrapSecret` | method | `long SetBootstrapSecret(ChilkatJsonObject jsonId, ChilkatSecrets secretContent)` |
| `UpdateSecretBd` | method | `long UpdateSecretBd(ChilkatJsonObject jsonId, ChilkatBinData secret)` |
| `UpdateSecretJson` | method | `long UpdateSecretJson(ChilkatJsonObject jsonId, ChilkatJsonObject secret)` |
| `UpdateSecretSb` | method | `long UpdateSecretSb(ChilkatJsonObject jsonId, ChilkatStringBuilder sb)` |
| `UpdateSecretStr` | method | `long UpdateSecretStr(ChilkatJsonObject jsonId, string secret)` |

## Properties

### Secrets.AutoSplit

`Chilkat 11.7.0 · powerbuilder · Secrets · AutoSplit · property · read/write · since 10.1.0`

```powerbuilder
long AutoSplit
```

The AutoSplit property is specific to `local_manager` secrets on Windows. The Windows Credentials Manager supports a maximum of 2560 bytes per secret. If a secret exceeds this size, it will be automatically compressed and split when created or updated, and automatically recomposed when retrieved.

A secret can be split into a maximum of 10 parts.

The default value is `1`.

### Secrets.Compression

`Chilkat 11.7.0 · powerbuilder · Secrets · Compression · property · read/write · since 10.1.0`

```powerbuilder
long Compression
```

If set to `1`, then the contents of the secret will be stored compressed. The default value of this property is `0`.

### Secrets.Location

`Chilkat 11.7.0 · powerbuilder · Secrets · Location · property · read/write · since 10.1.0`

```powerbuilder
string Location
```

The location of the secrets. Possible values are:

- `local_manager` - On Windows this is the Credentials Manager. On MacOS and iOS it is the Keychain. This is not yet an option on Linux or Android.
- `aws_secrets_manager` - AWS Secrets Manager
- `azure_key_vault` - Azure Key Vault
- `ibm_cloud` - IBM Cloud Secrets Manager
- `oracle_cloud` - Oracle Cloud Secrets
- `doppler` - Doppler Secrets
- `memory` - In-Memory Secrets

The default location is the `local_manager`. On Linux and Android, `local_manager` will behave the same as `memory`.

### Secrets.UncommonOptions

`Chilkat 11.7.0 · powerbuilder · Secrets · UncommonOptions · property · read/write · since 10.1.0`

```powerbuilder
string UncommonOptions
```

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

## Methods

### Secrets.DeleteSecret

`Chilkat 11.7.0 · powerbuilder · Secrets · DeleteSecret · method · since 10.1.0`

```powerbuilder
long DeleteSecret(ChilkatJsonObject jsonId)
```

Deletes a secret. Cloud secrets managers will typically disable the secret and schedule the secret for deletion after some number of days.

Returns 1 for success, 0 for failure.

Async variant: `DeleteSecretAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretBd

`Chilkat 11.7.0 · powerbuilder · Secrets · GetSecretBd · method · since 10.1.0`

```powerbuilder
long GetSecretBd(ChilkatJsonObject jsonId, ChilkatBinData bd)
```

Fetches a binary secret and returns the content in `bd`.

Returns 1 for success, 0 for failure.

Async variant: `GetSecretBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretJson

`Chilkat 11.7.0 · powerbuilder · Secrets · GetSecretJson · method · since 10.1.0`

```powerbuilder
long GetSecretJson(ChilkatJsonObject jsonId, ChilkatJsonObject jsonOut)
```

Fetches a JSON secret and returns the content in `jsonOut`.

Returns 1 for success, 0 for failure.

Async variant: `GetSecretJsonAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretSb

`Chilkat 11.7.0 · powerbuilder · Secrets · GetSecretSb · method · since 10.1.0`

```powerbuilder
long GetSecretSb(ChilkatJsonObject jsonId, ChilkatStringBuilder sb)
```

Fetches a string secret and returns the content in `sb`.

Returns 1 for success, 0 for failure.

Async variant: `GetSecretSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretStr

`Chilkat 11.7.0 · powerbuilder · Secrets · GetSecretStr · method · since 10.1.0`

```powerbuilder
string GetSecretStr(ChilkatJsonObject jsonId)
```

Fetches a string secret and returns the content of the secret.

Returns `null` on failure

Async variant: `GetSecretStrAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.ListSecrets

`Chilkat 11.7.0 · powerbuilder · Secrets · ListSecrets · method · since 10.1.0`

```powerbuilder
long ListSecrets(ChilkatJsonObject json, ChilkatJsonObject jsonOut)
```

Lists secrets matching the wildcarded or exact values passed in `json`. The results of the query are returned in `jsonOut`.

Returns 1 for success, 0 for failure.

Async variant: `ListSecretsAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.SecretSpecToJson

`Chilkat 11.7.0 · powerbuilder · Secrets · SecretSpecToJson · method · since 11.5.0`

```powerbuilder
long SecretSpecToJson(string secretSpec, ChilkatJsonObject json)
```

Converts a secret specification string (`secretSpec`) to JSON. A secret specification string is formatted as "!!part1\|part2\|part3\|part4" where parts 3 and 4 are optional. `json` is the output argument.

Returns 1 for success, 0 for failure.

### Secrets.SetBootstrapSecret

`Chilkat 11.7.0 · powerbuilder · Secrets · SetBootstrapSecret · method · since 10.1.0`

```powerbuilder
long SetBootstrapSecret(ChilkatJsonObject jsonId, ChilkatSecrets secretContent)
```

Accessing a cloud-based secrets manager requires authentication credentials, which cannot be stored in the manager itself. Instead, they must be securely stored locally.

One solution is to store the authentication credentials as a secret in the Windows Credentials Manager or Apple Keychain. These credentials serve as the `bootstrap secret` for authenticating with the cloud-based secrets manager.

`jsonId` contains the name of the bootstrap secret. `secretContent` contains the bootstrap's secret content.

Returns 1 for success, 0 for failure.

### Secrets.UpdateSecretBd

`Chilkat 11.7.0 · powerbuilder · Secrets · UpdateSecretBd · method · since 10.1.0`

```powerbuilder
long UpdateSecretBd(ChilkatJsonObject jsonId, ChilkatBinData secret)
```

Creates a binary secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the binary content of the secret in `secret`.

Returns 1 for success, 0 for failure.

Async variant: `UpdateSecretBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.UpdateSecretJson

`Chilkat 11.7.0 · powerbuilder · Secrets · UpdateSecretJson · method · since 10.1.0`

```powerbuilder
long UpdateSecretJson(ChilkatJsonObject jsonId, ChilkatJsonObject secret)
```

Creates a JSON secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the JSON content of the secret in `secret`.

Returns 1 for success, 0 for failure.

Async variant: `UpdateSecretJsonAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.UpdateSecretSb

`Chilkat 11.7.0 · powerbuilder · Secrets · UpdateSecretSb · method · since 10.1.0`

```powerbuilder
long UpdateSecretSb(ChilkatJsonObject jsonId, ChilkatStringBuilder sb)
```

Creates a string secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the string content of the secret in `sb`.

Returns 1 for success, 0 for failure.

Async variant: `UpdateSecretSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.UpdateSecretStr

`Chilkat 11.7.0 · powerbuilder · Secrets · UpdateSecretStr · method · since 10.1.0`

```powerbuilder
long UpdateSecretStr(ChilkatJsonObject jsonId, string secret)
```

Creates a string secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the string content of the secret in `secret`.

Note: Starting in Chilkat **v11.3.0**, if the `service` = `"Chilkat"` and the `username` = `"unlock_code"`, then the secret (which is the Chilkat unlock code) can be stored and retrieved without Chilkat being unlocked. This allows for the Chilkat unlock code itself to be persisted to a secrets manager.

Returns 1 for success, 0 for failure.

Async variant: `UpdateSecretStrAsync` — same arguments, returns a `Task` (see Async variants below).

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```powerbuilder
ChilkatTask DeleteSecretAsync(ChilkatJsonObject jsonId)
ChilkatTask GetSecretBdAsync(ChilkatJsonObject jsonId, ChilkatBinData bd)
ChilkatTask GetSecretJsonAsync(ChilkatJsonObject jsonId, ChilkatJsonObject jsonOut)
ChilkatTask GetSecretSbAsync(ChilkatJsonObject jsonId, ChilkatStringBuilder sb)
ChilkatTask GetSecretStrAsync(ChilkatJsonObject jsonId)
ChilkatTask ListSecretsAsync(ChilkatJsonObject json, ChilkatJsonObject jsonOut)
ChilkatTask UpdateSecretBdAsync(ChilkatJsonObject jsonId, ChilkatBinData secret)
ChilkatTask UpdateSecretJsonAsync(ChilkatJsonObject jsonId, ChilkatJsonObject secret)
ChilkatTask UpdateSecretSbAsync(ChilkatJsonObject jsonId, ChilkatStringBuilder sb)
ChilkatTask UpdateSecretStrAsync(ChilkatJsonObject jsonId, string secret)
```

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/StringBuilder.md)

