Class ClientSecretKey

Namespace

FoundationaLLM.Common.Models.Authorization

Assembly

FoundationaLLM.Common.dll

Represents a key to be shared to or received from the client. This key can be validated by recomputing the hash using the ClientSecret + Salt as input.

public class ClientSecretKey

Inheritance

object

ClientSecretKey

Derived

AgentClientSecretKey

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

ClientSecret

The client secret portion of this key. This is information only supposed to be held in memory for a short period of time and delivered to the customer as quickly as possible.

public required string ClientSecret { get; set; }

Property Value

string

ClientSecretString

The string representation of the client secret key.

public string ClientSecretString { get; }

Property Value

string

ContextId

The context identifier this key is associated with.

public required string ContextId { get; set; }

Property Value

string

Remarks

The context identifier is relative to the FoundationaLLM instance identifier.

Id

The unique identifier of this secret key.

public required string Id { get; set; }

Property Value

string

InstanceId

The FoundationaLLM instance identifier this key is associated with.

public required string InstanceId { get; set; }

Property Value

string

Methods

TryParse(string, out ClientSecretKey?)

Tries to parse a ClientSecretKey instance from the given string.

public static bool TryParse(string clientSecretString, out ClientSecretKey? clientSecretKey)

Parameters

clientSecretString string

The string representation to be parsed.

clientSecretKey ClientSecretKey

The ClientSecretKey that was parsed.

Returns

bool

true if the input string was successfully parsed, false otherwise.