specs/vtc/groups/create/v0_1/payload library

Classes

DynamicRule

A dynamic group's membership rule: a member belongs when every condition holds and they have not opted out. The community evaluates it under its groups policy and recomputes membership whenever a fact it reads changes, always excluding opted-out entries.

Group

A community group, as a caller who may see it sees it. Members a caller may not see are absent: memberCount only to those who may see the group's members, managers and credentialAuthorityValidUntil only to its managers.

Payload

An administrator creates a community group: the community's VTA mints the group's own DID and, where it issues credentials, the community authorises it to issue membership credentials; the group is recorded only afterwards. The outer document members are owned by the framework — SPEC §6.3.

Response

The success response to a vtc/groups/create/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/groups/create/0.1#response.

RuleCondition

One test over a verified fact about a member. fact: role tests the member's community role; fact: field tests an admin- or credential-sourced directory field named by field; fact: personhood tests whether a personhood assertion is on file; fact: joinedAt tests when they joined. A rule never reads a self-asserted (member-sourced) field: a member must not be able to join a group by editing their card.

Extension Types

GroupAudience

Who may see something about a group, narrowest first. admins: holders of vtc.groups.manage for the group (unqualified, or qualified group:<groupId>). groupMembers: the group's own members, and its managers. members: every active member of the community.

GroupKind

static: membership is explicit — added, joined, or granted on request. dynamic: membership is computed from rule over verified facts only; nobody is added by hand, but a member may opt out (vtc/groups/leave), an exclusion the rule cannot override, and undo it (vtc/groups/join). A dynamic group never confers authority. Fixed for the group's life.

JoinPolicy

How a member enters a static group by themselves. closed: only a manager adds them. request: a member asks and a manager decides. open: a member joins at once, subject to the community's groups policy. A group carrying authority is always closed.

RuleConditionFact

RuleConditionFact is a closed set of string values defined by this specification's schema.

RuleConditionOp

equals compares with value; oneOf with any of values; exists needs neither; before and after compare a date fact with value.

Constants

payloadSchemaJson → const String

This specification's payload schema, as JSON text.

responsePayloadSchemaJson → const String

As payloadSchemaJson, for the success-response variant.

responseSpec → const SpecPolicy

The SPEC §7.2 policy for the success-response variant.

responseTypeUri → const String

The success-response form of typeUri (SPEC §4.4.1).

spec → const SpecPolicy

The SPEC §7.2 policy for the request variant, taken from this specification's front matter.

typeUri → const String

The Trust Task type URI this library's Payload is carried under.

Typedefs

EntryId = String

Opaque identifier of one directory entry: dir_ followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.

Ext = Map<String, dynamic>

Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.

FieldKey = String

Identifier of a directory field. A key with no . is a BASE field, the same in every community: displayName, nickname, avatar, pronouns, bio, links (written by the member) and role, joinedAt, did, personhood (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (org.example.employer), so a base key never collides with one, and a key is never reused with a different meaning once defined.

GroupDescription = String

What the group is for. Plain text; a reader MUST NOT treat it as instructions. Same placement rules as GroupName.

GroupId = String

Opaque identifier of a community group: grp_ followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.

GroupName = String

The group's name, shown to those who may see the group. The community's own record: never in the group's DID document or its credentials' subject beyond the group's DID. Plain text.