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

# ConnectorGuard

> Guards and records a connector's writes.

```csharp
public sealed class ConnectorGuard : ITargetConnector, IConnector, ISupportsPrincipalWrites, ISupportsGrants, ISupportsGrantReads, ISupportsActions, ISupportsOperations, ISupportsCatalog, ISupportsDiscovery
```

**Implements:** `ITargetConnector`, `IConnector`, `ISupportsPrincipalWrites`, `ISupportsGrants`, `ISupportsGrantReads`, `ISupportsActions`, `ISupportsOperations`, `ISupportsCatalog`, `ISupportsDiscovery`

## Constructors

```csharp
public ConnectorGuard(ITargetConnector inner, ConnectorManifest manifest, LiveTenant tenant, RunBudget? budget = null)
```

Guards and records a connector's writes.

### Parameters

**inner** `ITargetConnector` *required*

**manifest** `ConnectorManifest` *required*

**tenant** `LiveTenant` *required*

**budget** `RunBudget`

## Properties

**Budget** `RunBudget` *required*

What the run may spend.

**Violations** `IReadOnlyCollection\<string\>` *required*

The writes the guard refused.

**Writes** `IReadOnlyCollection\<VendorWrite\>` *required*

**Type:** `IReadOnlyCollection<VendorWrite>`

Every write that reached the vendor.

## Methods

### ByKitAsync()

```csharp
public Task ByKitAsync(Func<Task> write)
```

Runs a write of the kit's own.

#### Parameters

**write** `Func\<Task\>` *required*

#### Returns

`Task`

### ChangeGrantsAsync()

```csharp
public Task<GrantOutcome> ChangeGrantsAsync(ConnectionContext context, PrincipalRef holder, string entitlementField, IReadOnlyCollection<string> add, IReadOnlyCollection<string> remove, string operationId, CancellationToken cancellationToken)
```

Adds and removes grants on one field of an account or a principal.

#### Parameters

**context** `ConnectionContext` *required*

**holder** `PrincipalRef` *required*

**entitlementField** `string` *required*

**add** `IReadOnlyCollection\<string\>` *required*

**remove** `IReadOnlyCollection\<string\>` *required*

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<GrantOutcome>`

### CheckConnectionAsync()

```csharp
public Task<ConnectionCheck> CheckConnectionAsync(ConnectionContext context, CancellationToken cancellationToken)
```

Checks the connection.

#### Parameters

**context** `ConnectionContext` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<ConnectionCheck>`

### CleanUpAsync()

```csharp
public Task CleanUpAsync(Func<Task> write)
```

Runs the kit's clean-up, past any budget.

#### Parameters

**write** `Func\<Task\>` *required*

#### Returns

`Task`

### CreatePrincipalAsync()

```csharp
public Task<WriteOutcome> CreatePrincipalAsync(ConnectionContext context, DesiredPrincipal desired, CancellationToken cancellationToken)
```

Creates a principal, or fails when the vendor already holds it.

#### Parameters

**context** `ConnectionContext` *required*

**desired** `DesiredPrincipal` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<WriteOutcome>`

### DiscoverAsync()

```csharp
public Task<Discovery> DiscoverAsync(ConnectionContext context, CancellationToken cancellationToken)
```

Reads what the tenant adds to the manifest.

#### Parameters

**context** `ConnectionContext` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Discovery>`

### FailNext()

```csharp
public void FailNext(string operation, FailureKind kind)
```

Fails the next call to an operation.

#### Parameters

**operation** `string` *required*

**kind** `FailureKind` *required*

### GetOperationAsync()

```csharp
public Task<OperationState> GetOperationAsync(ConnectionContext context, string handle, CancellationToken cancellationToken)
```

Says where a pending write stands.

#### Parameters

**context** `ConnectionContext` *required*

**handle** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<OperationState>`

### GetPrincipalAsync()

```csharp
public Task<PrincipalRead> GetPrincipalAsync(ConnectionContext context, string kind, string id, JsonObject? desired, CancellationToken cancellationToken)
```

Reads one principal by its id, with its status as the SDK reads it.

#### Parameters

**context** `ConnectionContext` *required*

**kind** `string` *required*

**id** `string` *required*

**desired** `JsonObject` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<PrincipalRead>`

### InvokeActionAsync()

```csharp
public Task<ActionOutcome> InvokeActionAsync(ConnectionContext context, string action, string? externalId, JsonObject fields, string operationId, CancellationToken cancellationToken)
```

Runs a declared action, on a leased object when it runs on one.

#### Parameters

**context** `ConnectionContext` *required*

**action** `string` *required*

**externalId** `string` *required*

**fields** `JsonObject` *required*

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<ActionOutcome>`

### Lease()

```csharp
public void Lease(string account)
```

Allows writes to one account.

#### Parameters

**account** `string` *required*

### Leased()

```csharp
public bool Leased(string account)
```

Checks whether an account is leased.

#### Parameters

**account** `string` *required*

#### Returns

`bool`

### ListCatalogAsync()

```csharp
public Task<Page<CatalogValue>> ListCatalogAsync(ConnectionContext context, string source, PageRequest page, CancellationToken cancellationToken)
```

Lists one page of a resource's records, or of a values\_from lookup list.

#### Parameters

**context** `ConnectionContext` *required*

**source** `string` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<CatalogValue>>`

### ListGrantsAsync()

```csharp
public Task<Page<Grant>> ListGrantsAsync(ConnectionContext context, string entitlementField, GrantFilter filter, PageRequest page, CancellationToken cancellationToken)
```

Lists one page of a field's grants.

#### Parameters

**context** `ConnectionContext` *required*

**entitlementField** `string` *required*

**filter** `GrantFilter` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<Grant>>`

### ListPrincipalsAsync()

```csharp
public Task<Page<Principal>> ListPrincipalsAsync(ConnectionContext context, string kind, PageRequest page, CancellationToken cancellationToken)
```

Lists one page of principals of one kind, each with its status as the SDK reads it.

#### Parameters

**context** `ConnectionContext` *required*

**kind** `string` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<Principal>>`

### Normalize()

```csharp
public JsonObject Normalize(JsonObject payload)
```

Puts an account's payload in the form the target reports.

#### Parameters

**payload** `JsonObject` *required*

#### Returns

`JsonObject`

### ReadGrantsAsync()

```csharp
public Task<IReadOnlyDictionary<string, FieldGrants>> ReadGrantsAsync(ConnectionContext context, string entitlementField, IReadOnlyCollection<string> values, CancellationToken cancellationToken)
```

Reads who holds the given values.

#### Parameters

**context** `ConnectionContext` *required*

**entitlementField** `string` *required*

**values** `IReadOnlyCollection\<string\>` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<IReadOnlyDictionary<String,FieldGrants>>`

### RemoveAsync()

```csharp
public Task RemoveAsync(string account, Func<Task> delete)
```

Deletes a leased account through the tenant.

#### Parameters

**account** `string` *required*

**delete** `Func\<Task\>` *required*

#### Returns

`Task`

### TenantIdAsync()

```csharp
public Task<string?> TenantIdAsync(ConnectionContext context, CancellationToken cancellationToken)
```

Reads the vendor's id for the tenant.

#### Parameters

**context** `ConnectionContext` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<string>`

### UpdatePrincipalAsync()

```csharp
public Task<WriteOutcome> UpdatePrincipalAsync(ConnectionContext context, string id, DesiredPrincipal desired, CancellationToken cancellationToken)
```

Updates an existing principal.

#### Parameters

**context** `ConnectionContext` *required*

**id** `string` *required*

**desired** `DesiredPrincipal` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<WriteOutcome>`


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