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

> Chilkat 11.7.0 · language=dataflex · 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/dataflex/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**

```dataflex
// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoSecrets
Get Create(RefClass(cComChilkatSecrets)) to hoSecrets
```

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

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` | `Function ComDebugLogFilePath Returns String Procedure Set ComDebugLogFilePath String value` | 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` | `Function ComLastBinaryResult Returns Variant` | 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` | `Function ComLastErrorHtml Returns String` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `Function ComLastErrorText Returns String` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `Function ComLastErrorXml Returns String` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `Function ComLastMethodSuccess Returns Boolean Procedure Set ComLastMethodSuccess Boolean value` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `LastStringResult` | `Function ComLastStringResult Returns String` | 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` | `Function ComLastStringResultLen Returns Integer` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `Function ComVerboseLogging Returns Boolean Procedure Set ComVerboseLogging Boolean value` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Function ComVersion Returns String` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AutoSplit` | property, read/write | `Function ComAutoSplit Returns Boolean Procedure Set ComAutoSplit Boolean value` |
| `Compression` | property, read/write | `Function ComCompression Returns Boolean Procedure Set ComCompression Boolean value` |
| `Location` | property, read/write | `Function ComLocation Returns String Procedure Set ComLocation String value` |
| `UncommonOptions` | property, read/write | `Function ComUncommonOptions Returns String Procedure Set ComUncommonOptions String value` |
| `DeleteSecret` | method | `Function ComDeleteSecret cComChilkatJsonObject jsonId Returns Boolean` |
| `GetSecretBd` | method | `Function ComGetSecretBd cComChilkatJsonObject jsonId cComChilkatBinData bd Returns Boolean` |
| `GetSecretJson` | method | `Function ComGetSecretJson cComChilkatJsonObject jsonId cComChilkatJsonObject jsonOut Returns Boolean` |
| `GetSecretSb` | method | `Function ComGetSecretSb cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns Boolean` |
| `GetSecretStr` | method | `Function ComGetSecretStr cComChilkatJsonObject jsonId Returns String` |
| `ListSecrets` | method | `Function ComListSecrets cComChilkatJsonObject json cComChilkatJsonObject jsonOut Returns Boolean` |
| `SecretSpecToJson` | method | `Function ComSecretSpecToJson String secretSpec cComChilkatJsonObject json Returns Boolean` |
| `SetBootstrapSecret` | method | `Function ComSetBootstrapSecret cComChilkatJsonObject jsonId cComChilkatSecrets secretContent Returns Boolean` |
| `UpdateSecretBd` | method | `Function ComUpdateSecretBd cComChilkatJsonObject jsonId cComChilkatBinData secret Returns Boolean` |
| `UpdateSecretJson` | method | `Function ComUpdateSecretJson cComChilkatJsonObject jsonId cComChilkatJsonObject secret Returns Boolean` |
| `UpdateSecretSb` | method | `Function ComUpdateSecretSb cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns Boolean` |
| `UpdateSecretStr` | method | `Function ComUpdateSecretStr cComChilkatJsonObject jsonId String secret Returns Boolean` |

## Properties

### Secrets.AutoSplit

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

```dataflex
Function ComAutoSplit Returns Boolean
Procedure Set ComAutoSplit Boolean value
```

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 `True`.

### Secrets.Compression

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

```dataflex
Function ComCompression Returns Boolean
Procedure Set ComCompression Boolean value
```

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

### Secrets.Location

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

```dataflex
Function ComLocation Returns String
Procedure Set ComLocation String value
```

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 · dataflex · Secrets · UncommonOptions · property · read/write · since 10.1.0`

```dataflex
Function ComUncommonOptions Returns String
Procedure Set ComUncommonOptions String value
```

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 · dataflex · Secrets · DeleteSecret · method · since 10.1.0`

```dataflex
Function ComDeleteSecret cComChilkatJsonObject jsonId Returns Boolean
```

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

Returns True for success, False for failure.

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

### Secrets.GetSecretBd

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

```dataflex
Function ComGetSecretBd cComChilkatJsonObject jsonId cComChilkatBinData bd Returns Boolean
```

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

Returns True for success, False for failure.

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

### Secrets.GetSecretJson

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

```dataflex
Function ComGetSecretJson cComChilkatJsonObject jsonId cComChilkatJsonObject jsonOut Returns Boolean
```

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

Returns True for success, False for failure.

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

### Secrets.GetSecretSb

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

```dataflex
Function ComGetSecretSb cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns Boolean
```

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

Returns True for success, False for failure.

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

### Secrets.GetSecretStr

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

```dataflex
Function ComGetSecretStr cComChilkatJsonObject jsonId Returns String
```

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 · dataflex · Secrets · ListSecrets · method · since 10.1.0`

```dataflex
Function ComListSecrets cComChilkatJsonObject json cComChilkatJsonObject jsonOut Returns Boolean
```

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

Returns True for success, False for failure.

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

### Secrets.SecretSpecToJson

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

```dataflex
Function ComSecretSpecToJson String secretSpec cComChilkatJsonObject json Returns Boolean
```

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 True for success, False for failure.

### Secrets.SetBootstrapSecret

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

```dataflex
Function ComSetBootstrapSecret cComChilkatJsonObject jsonId cComChilkatSecrets secretContent Returns Boolean
```

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 True for success, False for failure.

### Secrets.UpdateSecretBd

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

```dataflex
Function ComUpdateSecretBd cComChilkatJsonObject jsonId cComChilkatBinData secret Returns Boolean
```

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 True for success, False for failure.

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

### Secrets.UpdateSecretJson

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

```dataflex
Function ComUpdateSecretJson cComChilkatJsonObject jsonId cComChilkatJsonObject secret Returns Boolean
```

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 True for success, False for failure.

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

### Secrets.UpdateSecretSb

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

```dataflex
Function ComUpdateSecretSb cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns Boolean
```

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 True for success, False for failure.

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

### Secrets.UpdateSecretStr

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

```dataflex
Function ComUpdateSecretStr cComChilkatJsonObject jsonId String secret Returns Boolean
```

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 True for success, False 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.

```dataflex
Function ComDeleteSecretAsync cComChilkatJsonObject jsonId Returns cComChilkatTask
Function ComGetSecretBdAsync cComChilkatJsonObject jsonId cComChilkatBinData bd Returns cComChilkatTask
Function ComGetSecretJsonAsync cComChilkatJsonObject jsonId cComChilkatJsonObject jsonOut Returns cComChilkatTask
Function ComGetSecretSbAsync cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns cComChilkatTask
Function ComGetSecretStrAsync cComChilkatJsonObject jsonId Returns cComChilkatTask
Function ComListSecretsAsync cComChilkatJsonObject json cComChilkatJsonObject jsonOut Returns cComChilkatTask
Function ComUpdateSecretBdAsync cComChilkatJsonObject jsonId cComChilkatBinData secret Returns cComChilkatTask
Function ComUpdateSecretJsonAsync cComChilkatJsonObject jsonId cComChilkatJsonObject secret Returns cComChilkatTask
Function ComUpdateSecretSbAsync cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns cComChilkatTask
Function ComUpdateSecretStrAsync cComChilkatJsonObject jsonId String secret Returns cComChilkatTask
```

## Related classes

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

