Xecrets.Sdk.Models.XfEncryptedKeys.md

May 26, 2026 · View on GitHub

Extra, possibly imported, encrypted private keys for a user.

public record XfEncryptedKeys : System.IEquatable<Xecrets.Sdk.Models.XfEncryptedKeys>

Inheritance System.Object → XfEncryptedKeys

Implements System.IEquatable<XfEncryptedKeys >

Remarks

This type is used for interoperability with AxCrypt, so the JSON property names and structure cannot be changed without breaking compatibility with AxCrypt. It's intended to be used for importing of private keys, typically from AxCrypt, but could also be from another instance or installation of Xecrets Ez.

Properties

XfEncryptedKeys.Empty Property

An empty instance.

public static Xecrets.Sdk.Models.XfEncryptedKeys Empty { get; }

Property Value

XfEncryptedKeys

XfEncryptedKeys.UserKeys Property

A list of encrypted private keys for a physical user, possibly with multiple email addresses, possibly with multiple keys for each email address.

public System.Collections.Generic.IList<Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys> UserKeys { get; init; }

Property Value

System.Collections.Generic.IList<EncryptedUserKeys >

Methods

XfEncryptedKeys.Deserialize(string) Method

Deserialize a JSON string to an instance.

public static Xecrets.Sdk.Models.XfEncryptedKeys Deserialize(string json);

Parameters

json System.String

The json to deserialize

Returns

XfEncryptedKeys
The deserialized instance or an empty instance.

XfEncryptedKeys.Serialize(XfEncryptedKeys) Method

Serialize this instance to a JSON string.

public static string Serialize(Xecrets.Sdk.Models.XfEncryptedKeys xfEncryptedKeys);

Parameters

xfEncryptedKeys XfEncryptedKeys

The instance to serialize.

Returns

System.String
A JSON string