> ## Documentation Index
> Fetch the complete documentation index at: https://klef.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PrincipalKey

> What principals of a read find one by.

```csharp
public sealed record PrincipalKey : IEquatable<PrincipalKey>
```

**Implements:** `IEquatable<PrincipalKey>`

## Constructors

```csharp
public PrincipalKey(string Name, string Value)
```

What principals of a read find one by.

### Parameters

**Name** `string` *required*

What the key is, such as email.

**Value** `string` *required*

The key's value.

## Properties

**Name** `string` *required*

What the key is, such as email.

**Value** `string` *required*

The key's value.

## Methods

### Deconstruct()

```csharp
public void Deconstruct(out string Name, out string Value)
```

#### Parameters

**Name** `string` *required*

**Value** `string` *required*

### Equals()

```csharp
public bool Equals(PrincipalKey? other)
```

#### Parameters

**other** `PrincipalKey` *required*

#### Returns

`bool`

```csharp
public override bool Equals(object? obj)
```

#### Parameters

**obj** `object` *required*

#### Returns

`bool`

### GetHashCode()

```csharp
public override int GetHashCode()
```

#### Returns

`int`

### Id()

```csharp
public static PrincipalKey Id(string value)
```

Builds the key for a principal's id.

#### Parameters

**value** `string` *required*

#### Returns

`PrincipalKey`

### operator !=()

```csharp
public static bool operator !=(PrincipalKey? left, PrincipalKey? right)
```

#### Parameters

**left** `PrincipalKey` *required*

**right** `PrincipalKey` *required*

#### Returns

`bool`

### operator ==()

```csharp
public static bool operator ==(PrincipalKey? left, PrincipalKey? right)
```

#### Parameters

**left** `PrincipalKey` *required*

**right** `PrincipalKey` *required*

#### Returns

`bool`

### ToString()

```csharp
public override string ToString()
```

#### Returns

`string`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.