Profile Invite Token
Overview
The PRINVT (Profile Invite) token delivers a profile creation invite — for a community profile or a personal profile — to a user you are connected with. The recipient’s instance turns it into a notification carrying the invite reference; acting on that reference is what actually creates the profile.
PRINVT is a directed, non-broadcast action: it is addressed to exactly one recipient and is only accepted from an established, bidirectional connection. Like every action token it is content-addressed — see Content Addressing.
Token Structure
| Field | Type | Required | Description |
|---|---|---|---|
iss |
identity | Yes | The identity sending the invite |
aud |
identity | Yes | The invited user |
iat |
timestamp | Yes | Issue time |
k |
string | Yes | Signing key ID |
t |
string | Yes | Type: PRINVT |
c |
object | Yes | Invite details (see below) |
p (parent), sub (subject) and attachments are forbidden on this type.
Content Schema
| Field | Type | Required | Max length | Description |
|---|---|---|---|---|
refId |
string | Yes | 255 | The invite reference the recipient redeems to create the profile |
nodeName |
string | No | 255 | Human-readable name of the profile being offered |
message |
string | No | 500 | Optional message from the inviter |
Permissions
| Rule | Value |
|---|---|
| Who may create | Authenticated users |
| Who may receive | Any identity |
| Requires connection | Yes — sender and recipient must be connected |
| Requires following | No |
| Unknown senders | Rejected |
Because requires_connected is set, an invite from an identity you have not connected with is rejected before it reaches a hook.
Database Key
The database key pattern is {type}:{issuer}:{audience} — one active invite per (inviter, invitee) pair, so a re-sent invite supersedes the previous one rather than stacking up — see Database Keys.
Processing
PRINVT has an on_receive native hook and no on_create, on_accept or on_reject hook — see the native-hook registry in Action Lifecycle. The hook runs on the recipient’s instance when the token arrives and is verified, and raises the invite as a notification; see Receiving an Action for the surrounding pipeline.
Example
User @alice.cloudillo.net invites @bob.cloudillo.net to create a profile for a community:
| Field | Value |
|---|---|
| iss | alice.cloudillo.net |
| aud | bob.cloudillo.net |
| iat | 2024-04-13T00:01:10.000Z |
| k | 20240101 |
| t | PRINVT |
| c.refId | inv~7NtuTab_K4FwYmARMNuk4 |
| c.nodeName | Photography Club |
| c.message | We’d like you to run this one. |
See Also
- Action Lifecycle - Native hooks and the inbound pipeline
- Token Format - Shared token fields, keys and addressing
- Communities - Community profiles
- Connect Token - Establishing the connection PRINVT requires