# ApiKeyDraft

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.apikeydraft/
> Summary: ApiKeyDraft: A draft for creating an API key.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Abstractions.dll</code></div>

A draft for creating an API key.

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

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.apikeydraft/">ApiKeyDraft</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;ApiKeyDraft&gt;</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Remarks

The raw value, digest, and prefix are generated by
[IApiKeyStore.CreateAsync](/api/tracon.iapikeystore/#Tracon_IApiKeyStore_CreateAsync_Tracon_ApiKeyDraft_System_Threading_CancellationToken_); the draft carries only the
information given by the operator.

## Constructors

### <a id="Tracon_ApiKeyDraft__ctor"></a> ApiKeyDraft\(\)

```csharp
public ApiKeyDraft()
```

## Properties

### <a id="Tracon_ApiKeyDraft_ExpiresAt"></a> ExpiresAt

The expiration. Never expires if [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null).

```csharp
public DateTimeOffset? ExpiresAt { get; init; }
```

#### Property Value

 [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)?

### <a id="Tracon_ApiKeyDraft_Name"></a> Name

The name for the operator to recognize the key by.

```csharp
public required string Name { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_ApiKeyDraft_Scopes"></a> Scopes

The scope set. Must not be empty.

```csharp
public required IReadOnlyList<ApiKeyScope> Scopes { get; init; }
```

#### Property Value

 [IReadOnlyList](https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist\-1)<[ApiKeyScope](/api/tracon.apikeyscope/)\>

### <a id="Tracon_ApiKeyDraft_TenantId"></a> TenantId

The tenant the key is bound to.

```csharp
public required string TenantId { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Methods

### <a id="Tracon_ApiKeyDraft_Equals_System_Object_"></a> Equals\(object?\)

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

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ApiKeyDraft_Equals_Tracon_ApiKeyDraft_"></a> Equals\(ApiKeyDraft?\)

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

#### Parameters

`other` [ApiKeyDraft](/api/tracon.apikeydraft/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ApiKeyDraft_GetHashCode"></a> GetHashCode\(\)

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

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_ApiKeyDraft_ToString"></a> ToString\(\)

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

#### Returns

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Operators

### <a id="Tracon_ApiKeyDraft_op_Equality_Tracon_ApiKeyDraft_Tracon_ApiKeyDraft_"></a> operator ==\(ApiKeyDraft?, ApiKeyDraft?\)

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

#### Parameters

`left` [ApiKeyDraft](/api/tracon.apikeydraft/)?

`right` [ApiKeyDraft](/api/tracon.apikeydraft/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ApiKeyDraft_op_Inequality_Tracon_ApiKeyDraft_Tracon_ApiKeyDraft_"></a> operator \!=\(ApiKeyDraft?, ApiKeyDraft?\)

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

#### Parameters

`left` [ApiKeyDraft](/api/tracon.apikeydraft/)?

`right` [ApiKeyDraft](/api/tracon.apikeydraft/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)