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

# ConnectorManifest

> A connector manifest.

A connector manifest. A key not listed here is rejected.

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

**Implements:** `IEquatable<ConnectorManifest>`

## Constructors

```csharp
public ConnectorManifest()
```

## Fields

**Format1** `string` *required*

The manifest format this SDK reads.

## Properties

**Account** `AccountObjectManifest` *required*

**Actions** `IList\<ActionManifest\>` *required*

**Type:** `IList<ActionManifest>`

What a person runs on the connection as a whole.

**Auth** `AuthManifest` *required*

How the connector authenticates to the vendor.

**CatalogNames** `IReadOnlyDictionary\<string, string\>` *required*

Each values\_from lookup list's name, with the label of the first field that takes its options from it.

**Connection** `ConnectionManifest`

The fields a connection holds.

**Data** `string` *required*

The manifest's data as its file writes it, in JSON, which [Digest(string)](https://klef.ai/docs/connector-sdk/reference/sdk/manifestschema.md) hashes.

**DeclaredActions** `IEnumerable\<DeclaredAction\>` *required*

**Type:** `IEnumerable<DeclaredAction>`

Every action, with the object it runs on.

**Egress** `IList\<string\>` *required*

Hosts the connector may call: a host such as api.acme.com, a wildcard such as \*.acme.com, or a template such as \{\{ connection.subdomain }}.acme.com or \{\{ connection.baseUrl | host }}.

**EgressFields** `IEnumerable\<string\>` *required*

The connection fields that set a host the egress list allows.

**EndsElements** `bool` *required*

Whether the connector ends an element of a collection field on a date, which a keyed collection allows.

**EntitlementFields** `IEnumerable\<EntitlementField\>` *required*

**Type:** `IEnumerable<EntitlementField>`

Every entitlement field, with its object.

**Events** `Nullable\<EventDelivery\>`

**Type:** `Nullable<EventDelivery>`

How the connector hears of a change the vendor made, when it does.

**ExtensibleItems** `IReadOnlyDictionary\<string, string\>` *required*

Each extensible item's label, by its path, such as `worker.workRelationships.assignments`: its object's key and the keys of the fields that lead to it. An array's item or a map's entry is at its field's path.

**Format** `string` *required*

**HasAccount** `bool` *required*

Whether the connector declares an account, so the host can match and provision its accounts.

**Id** `string` *required*

The KPL name. A workspace connector's id starts with custom\_.

**Installation** `InstallationManifest`

**IssuesCredentials** `bool` *required*

Whether any object declares a credential, which the connector issues beside its fields.

**ListsCatalog** `bool` *required*

Whether the connector lists values itself: a lookup list's, or the records of a resource a field points at.

**Messages** `IDictionary\<string, string\>` *required*

The connector's messages, by snake\_case key.

**Name** `string` *required*

The connector's display name.

**Objects** `IList\<ObjectManifest\>` *required*

**Type:** `IList<ObjectManifest>`

The kinds of thing the vendor has.

**Presentation** `PresentationManifest`

**Principals** `IEnumerable\<PrincipalObjectManifest\>` *required*

**Type:** `IEnumerable<PrincipalObjectManifest>`

The principal objects besides the account.

**Provisions** `bool` *required*

Whether the connector writes the accounts or principals.

**RecordObjects** `IReadOnlyDictionary\<string, string\>` *required*

Each object whose records fields offer as values, with the label of the first such field.

**Resources** `IEnumerable\<ResourceObjectManifest\>` *required*

**Type:** `IEnumerable<ResourceObjectManifest>`

**RunsActions** `bool` *required*

**ValuedFields** `IEnumerable\<ValuedField\>` *required*

**Type:** `IEnumerable<ValuedField>`

Every field that offers values, with where they come from. An entitlement field without a scope offers the records of its object, and its item's object and scope parts the records of the entitlement's object and scope, unless the field names a `values_from` lookup list.

**Version** `string` *required*

MAJOR.MINOR or MAJOR.MINOR.PATCH as a quoted string, which the author chooses.

**Worker** `WorkerObjectManifest`

The worker object, which makes the connector a source of workers, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when it declares none.

**WritesGrants** `bool` *required*

Whether the connector changes grants, which an entitlements field allows.

**WritesLinks** `bool` *required*

Whether the connector points an account's link field at another account.

## Methods

### DeclaredObject()

```csharp
public ObjectManifest DeclaredObject(string kind)
```

Gets the account or principal object a kind keys.

#### Parameters

**kind** `string` *required*

#### Returns

`ObjectManifest`

### Equals()

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

#### Parameters

**other** `ConnectorManifest` *required*

#### Returns

`bool`

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

#### Parameters

**obj** `object` *required*

#### Returns

`bool`

### FindAction()

```csharp
public DeclaredAction? FindAction(string key)
```

#### Parameters

**key** `string` *required*

#### Returns

`DeclaredAction`

### GetHashCode()

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

#### Returns

`int`

### IsPrincipalGrantable()

```csharp
public bool IsPrincipalGrantable(string kind, string field)
```

#### Parameters

**kind** `string` *required*

**field** `string` *required*

#### Returns

`bool`

### IsResource()

```csharp
public bool IsResource(string kind)
```

Whether `kind` keys a declared resource.

#### Parameters

**kind** `string` *required*

#### Returns

`bool`

### operator !=()

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

#### Parameters

**left** `ConnectorManifest` *required*

**right** `ConnectorManifest` *required*

#### Returns

`bool`

### operator ==()

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

#### Parameters

**left** `ConnectorManifest` *required*

**right** `ConnectorManifest` *required*

#### Returns

`bool`

### Parse()

```csharp
public static ConnectorManifest Parse(string yaml)
```

#### Parameters

**yaml** `string` *required*

#### Returns

`ConnectorManifest`

### Problems()

```csharp
public IReadOnlyList<ManifestProblem> Problems()
```

Lists what is wrong across keys.

#### Returns

`IReadOnlyList<ManifestProblem>`

### ResourceValueSources()

```csharp
public ILookup<string, ValueSource> ResourceValueSources()
```

The sources whose values are the objects of each top-level resource kind: the values of each field on the kind, and of each item property that is its object or its scope.

#### Returns

`ILookup<String,ValueSource>`

### SourceOf()

```csharp
public static ValueSource? SourceOf(EntitlementsFieldManifest field)
```

Gets where an entitlement field's values come from, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when it offers none of its own.

#### Parameters

**field** `EntitlementsFieldManifest` *required*

#### Returns

`ValueSource`

### ThroughOf()

```csharp
public EntitlementRef ThroughOf(PrincipalRef via)
```

Names the entitlement a grant held through a principal comes through: membership of it.

#### Parameters

**via** `PrincipalRef` *required*

#### Returns

`EntitlementRef`

### ToString()

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

#### Returns

`string`

### UndeclaredCatalog()

```csharp
public ArgumentException UndeclaredCatalog(string source)
```

#### Parameters

**source** `string` *required*

#### Returns

`ArgumentException`

### UndeclaredKind()

```csharp
public ArgumentException UndeclaredKind(string kind)
```

#### Parameters

**kind** `string` *required*

#### Returns

`ArgumentException`

### WorkspaceProblems()

```csharp
public IReadOnlyList<ManifestProblem> WorkspaceProblems()
```

Lists what a workspace may not upload.

#### Returns

`IReadOnlyList<ManifestProblem>`


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