{
{"first", "John"},
{"middle", "Patrick"},
{"last", "Smith"}
}
},
required = true
},
new KeeperRecordField
{
type = "oneTimeCode",
value = new[]
{
"otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
label = "My TOTP",
required = true
}
};
newRecord.notes = "\tThis custom type record was created\n\tvia .NET SDK copied from https://docs.keeper.io/secrets-manager/secrets-manager/developer-sdk-library/.net-sdk";
var recordUid = await SecretsManagerClient.CreateSecret(options, "[FOLDER_UID]", newRecord);
```
{% endtab %}
{% endtabs %}
### Delete a Secret
The .Net KSM SDK can delete records in the Keeper Vault.
{% tabs %}
{% tab title="Delete Secret" %}
```csharp
DeleteSecret(smOptions, recordsUids);
```
| Parameter | Type | Required |
|---|
smOptions | SecretsManagerOptions | Yes |
recordsUids | string[] | Yes |
{% endtab %}
{% tab title="Example" %}
using SecretsManager;
// setup secrets manager
var storage = new LocalConfigStorage("ksm-config.json");
//SecretsManagerClient.InitializeStorage(storage, "<One Time Access Token>");
var smOptions = new SecretsManagerOptions(storage);
// delete a specific secret by record UID
await SecretsManagerClient.DeleteSecret(smOptions, new string[] {"EG6KdJaaLG7esRZbMnfbFA"});
{% endtab %}
{% endtabs %}
### Caching
To protect against losing access to your secrets when network access is lost, the .Net SDK allows caching of secrets to the local machine in an encrypted file.
**Setup and Configure Cache**
In order to setup caching in the .Net SDK, include a caching post function as the second argument when instantiating a`SecretsManagerOptions` object.
The .Net SDK includes a default caching function `cachingPostFunction` which stores cached queries to a file.
```csharp
var options = new SecretsManagerOptions(storage, SecretsManagerClient.CachingPostFunction);
var secrets = await SecretsManagerClient.GetSecrets(options);
```
### Folders
Folders have full CRUD support - create, read, update and delete operations.
### Read Folders
Downloads full folder hierarchy.
```csharp
Task GetFolders(SecretsManagerOptions options)
```
**Response**
Type: `KeeperFolder[]`
**Example Usage**
```csharp
using SecretsManager;
var options = new SecretsManagerOptions(new LocalConfigStorage("ksm-config.json"));
var folders = await SecretsManagerClient.GetFolders(options);
```
### Create a Folder
Requires `CreateOptions` and folder name to be provided. The folder UID parameter in `CreateOptions` is required - UID of a shared folder, while sub-folder UID is optional and if missing, a new regular folder is created directly under the parent (shared folder). There's no requirement for the sub-folder to be a direct descendant of the parent shared folder - it could be many levels deep.
```csharp
Task CreateFolder(SecretsManagerOptions options, CreateOptions createOptions, string folderName, KeeperFolder[] folders = null)
```
| Parameter | Type | Required | Default | Description |
|---|
options | SecretsManagerOptions | Yes | | Preconfigured options |
createOptions | CreateOptions | Yes | | The parent and sub-folder UIDs |
folderName | string | Yes | | The Folder name |
folders | KeeperFolder[] | No | null | List of folders to use in the search for parent and sub-folder from CreateOptions |
```csharp
public class CreateOptions {
public string FolderUid { get; }
public string SubFolderUid { get; }
}
```
```csharp
public class KeeperFolder {
public byte[] FolderKey { get; }
public string FolderUid { get; }
public string ParentUid { get; }
public string Name { get; }
}
```
**Example Usage**
```csharp
using SecretsManager;
var options = new SecretsManagerOptions(new LocalConfigStorage("ksm-config.json"));
var co = new CreateOptions("[PARENT_SHARED_FOLDER_UID]");
var folderUid = await SecretsManagerClient.CreateFolder(options, co, "new_folder");
```
### Update a Folder
Updates the folder metadata - currently folder name only.
```csharp
Task UpdateFolder(SecretsManagerOptions options, string folderUid, string folderName, KeeperFolder[] folders = null)
```
| Parameter | Type | Required | Default | Description |
|---|
options | SecretsManagerOptions | Yes | | Preconfigured options |
folderUid | string | Yes | | The folder UID |
folderName | string | Yes | | The new folder name |
folders | KeeperFolder[] | No | null | List of folders to use in the search for parent folder |
**Example Usage**
```csharp
using SecretsManager;
var options = new SecretsManagerOptions(new LocalConfigStorage("ksm-config.json"));
await SecretsManagerClient.UpdateFolder(options, "[FOLDER_UID]", "new_folder_name");
```
### Delete Folders
Removes a list of folders. Use `forceDeletion` flag to remove non-empty folders.
{% hint style="info" %}
When using forceDeletion avoid sending parent with its children folder UIDs. Depending on the delete order you may get an error - *ex.* if parent force-deleted child first. There's no guarantee that list will always be processed in FIFO order.
{% endhint %}
{% hint style="info" %}
Any folders UIDs missing from the vault or not shared to the KSM Application will not result in error.
{% endhint %}
```csharp
Task DeleteFolder(SecretsManagerOptions options, string[] folderUids, bool forceDeletion = false)
```
| Parameter | Type | Required | Default | Description |
|---|
options | SecretsManagerOptions | Yes | | Preconfigured options |
folderUids | string[] | Yes | | The folder UID list |
forceDeletion | bool | No | false | Force deletion of non-empty folders |
**Example Usage**
```csharp
using SecretsManager;
var options = new SecretsManagerOptions(new LocalConfigStorage("ksm-config.json"));
await SecretsManagerClient.DeleteFolder(options, new string[]{"[FOLDER_UID1]", "[FOLDER_UID2]"}, true);
```
### Proxy support
.NET SDK supports setting proxy through environment variables and passing proxy url to `SecretsManagerOptions` directly
{% hint style="info" %}
Keeper recommends using **environment variables** for proxy settings. This approach keeps configuration details out of code, ensures consistency across tools and environments, and simplifies deployment and maintenance
{% endhint %}
**Example usage through environment variables**
```
HTTPS_PROXY=http://user:password@127.0.0.1:3128 dotnet run
```
Example usage passing url to `SecretsManagerOptions`
```csharp
var options = new SecretsManagerOptions(storage, null, false, "http://user:password@127.0.0.1:3128");
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.keeper.io/en/keeperpam/secrets-manager/developer-sdk-library/.net-sdk.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
