Skip to main content
A connector manifest. A key not listed here is rejected.
Implements: ConnectorManifest

Constructors

Fields

string
required
The manifest format this SDK reads.

Properties

IList<ActionManifest>
required
Type: ActionManifestWhat a person runs on the connection as a whole.
required
How the connector authenticates to the vendor.
IReadOnlyDictionary<string, string>
required
Each values_from lookup list’s name, with the label of the first field that takes its options from it.
The fields a connection holds.
string
required
The manifest’s data as its file writes it, in JSON, which Digest(string) hashes.
IEnumerable<DeclaredAction>
required
Type: DeclaredActionEvery action, with the object it runs on.
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 }}.
IEnumerable<string>
required
The connection fields that set a host the egress list allows.
bool
required
Whether the connector ends an element of a collection field on a date, which a keyed collection allows.
IEnumerable<EntitlementField>
required
Type: EntitlementFieldEvery entitlement field, with its object.
Nullable<EventDelivery>
Type: EventDeliveryHow the connector hears of a change the vendor made, when it does.
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.
string
required
bool
required
Whether the connector declares an account, so the host can match and provision its accounts.
string
required
The KPL name. A workspace connector’s id starts with custom_.
bool
required
Whether any object declares a credential, which the connector issues beside its fields.
bool
required
Whether the connector lists values itself: a lookup list’s, or the records of a resource a field points at.
IDictionary<string, string>
required
The connector’s messages, by snake_case key.
string
required
The connector’s display name.
IList<ObjectManifest>
required
Type: ObjectManifestThe kinds of thing the vendor has.
IEnumerable<PrincipalObjectManifest>
required
Type: PrincipalObjectManifestThe principal objects besides the account.
bool
required
Whether the connector writes the accounts or principals.
IReadOnlyDictionary<string, string>
required
Each object whose records fields offer as values, with the label of the first such field.
IEnumerable<ResourceObjectManifest>
required
bool
required
IEnumerable<ValuedField>
required
Type: ValuedFieldEvery 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.
string
required
MAJOR.MINOR or MAJOR.MINOR.PATCH as a quoted string, which the author chooses.
The worker object, which makes the connector a source of workers, or null when it declares none.
bool
required
Whether the connector changes grants, which an entitlements field allows.
Whether the connector points an account’s link field at another account.

Methods

DeclaredObject()

Gets the account or principal object a kind keys.

Parameters

string
required

Returns

ObjectManifest

Equals()

Parameters

Returns

bool

Parameters

object
required

Returns

bool

FindAction()

Parameters

string
required

Returns

DeclaredAction

GetHashCode()

Returns

int

IsPrincipalGrantable()

Parameters

string
required
string
required

Returns

bool

IsResource()

Whether kind keys a declared resource.

Parameters

string
required

Returns

bool

operator !=()

Parameters

Returns

bool

operator ==()

Parameters

Returns

bool

Parse()

Parameters

string
required

Returns

ConnectorManifest

Problems()

Lists what is wrong across keys.

Returns

ManifestProblem

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

ValueSource

SourceOf()

Gets where an entitlement field’s values come from, or null when it offers none of its own.

Parameters

Returns

ValueSource

ThroughOf()

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

Parameters

required

Returns

EntitlementRef

ToString()

Returns

string

UndeclaredCatalog()

Parameters

string
required

Returns

ArgumentException

UndeclaredKind()

Parameters

string
required

Returns

ArgumentException

WorkspaceProblems()

Lists what a workspace may not upload.

Returns

ManifestProblem