# ToolAuthorizationResult

> 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.toolauthorizationresult/
> Summary: ToolAuthorizationResult: The outcome of an authorization decision.

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

The outcome of an authorization decision.

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

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.toolauthorizationresult/">ToolAuthorizationResult</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;ToolAuthorizationResult&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>

## Constructors

### <a id="Tracon_ToolAuthorizationResult__ctor"></a> ToolAuthorizationResult\(\)

```csharp
public ToolAuthorizationResult()
```

## Properties

### <a id="Tracon_ToolAuthorizationResult_IsAllowed"></a> IsAllowed

Gets whether the call may proceed.

```csharp
public required bool IsAllowed { get; init; }
```

#### Property Value

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

### <a id="Tracon_ToolAuthorizationResult_Reason"></a> Reason

Gets the text returned to the model as the tool's result when the call
is denied. [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when allowed.

```csharp
public string? Reason { get; init; }
```

#### Property Value

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

#### Remarks

This text is sent to the model, not shown to the user directly — the
same rule applies to every other model-facing string. It carries
no secret.

## Methods

### <a id="Tracon_ToolAuthorizationResult_Allow"></a> Allow\(\)

Creates an allowing result.

```csharp
public static ToolAuthorizationResult Allow()
```

#### Returns

 [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)

A result with [ToolAuthorizationResult.IsAllowed](/api/tracon.toolauthorizationresult/#Tracon_ToolAuthorizationResult_IsAllowed) set to [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).

### <a id="Tracon_ToolAuthorizationResult_Deny_System_String_"></a> Deny\(string\)

Creates a denying result.

```csharp
public static ToolAuthorizationResult Deny(string reason)
```

#### Parameters

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

The text returned to the model as the tool's result.

#### Returns

 [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)

A result with [ToolAuthorizationResult.IsAllowed](/api/tracon.toolauthorizationresult/#Tracon_ToolAuthorizationResult_IsAllowed) set to [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).

#### Exceptions

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

`reason` is empty or whitespace.

### <a id="Tracon_ToolAuthorizationResult_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_ToolAuthorizationResult_Equals_Tracon_ToolAuthorizationResult_"></a> Equals\(ToolAuthorizationResult?\)

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

#### Parameters

`other` [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)?

#### Returns

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

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

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

#### Returns

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

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

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

#### Returns

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

## Operators

### <a id="Tracon_ToolAuthorizationResult_op_Equality_Tracon_ToolAuthorizationResult_Tracon_ToolAuthorizationResult_"></a> operator ==\(ToolAuthorizationResult?, ToolAuthorizationResult?\)

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

#### Parameters

`left` [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)?

`right` [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)?

#### Returns

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

### <a id="Tracon_ToolAuthorizationResult_op_Inequality_Tracon_ToolAuthorizationResult_Tracon_ToolAuthorizationResult_"></a> operator \!=\(ToolAuthorizationResult?, ToolAuthorizationResult?\)

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

#### Parameters

`left` [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)?

`right` [ToolAuthorizationResult](/api/tracon.toolauthorizationresult/)?

#### Returns

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