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

# DesiredCredential

> A credential a write issues to its principal, or revokes.

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

**Implements:** `IEquatable<DesiredCredential>`

## Constructors

```csharp
public DesiredCredential()
```

## Properties

**Fields** `JsonObject` *required*

Its settings, and any secret the host supplies.

**Key** `string` *required*

The credential's key, as the manifest declares it under the principal's object.

**Revokes** `bool` *required*

**Status** `Nullable\<PrincipalStatus\>`

**Type:** `Nullable<PrincipalStatus>`

[Removed](https://klef.ai/docs/connector-sdk/reference/model/principalstatus.md) to revoke the credential, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) to issue one.

## Methods

### Equals()

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

#### Parameters

**other** `DesiredCredential` *required*

#### Returns

`bool`

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

#### Parameters

**obj** `object` *required*

#### Returns

`bool`

### GetHashCode()

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

#### Returns

`int`

### operator !=()

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

#### Parameters

**left** `DesiredCredential` *required*

**right** `DesiredCredential` *required*

#### Returns

`bool`

### operator ==()

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

#### Parameters

**left** `DesiredCredential` *required*

**right** `DesiredCredential` *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.