Share `share@1`

Generated at 2026-11-13 06:25:48 UTC from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version: 1.1.0
Owner: network
Visibility: public
Status: active
Compatibility: backward
Schema: https://openvibe.network/contracts/share/share.v1.json

share@1: the uniform GET/PUT body. People, not bare subjects; ids only, never a resource title or content except the service's own describe() (title and link). Members apply to people audience; pending recipients may preview for seven days.

Fields

Field	Type	Required	Description	Constraints
`ref`	share.resource-ref	yes
`owner_subject`	identity.subject-ref	yes
`owner`	share.person	yes
`audience`	enum	yes		`one of "public", "link", "people", "private"`
`members`	share.member	yes		`maxItems 100`
`transfer`	share.transfer-view
`lock`	enum		How the resource is sealed (Locker). none means it is stored as it is; people, password and link are the three Locker locks. The server stores the envelope and never opens it.	`one of "none", "people", "password", "link"`
`you`	share.you	yes
`requests`	share.access-request-view	yes
`title`	string \| null	yes
`link`	string \| null	yes		`format uri`
`roles`	array of enum	yes		`minItems 1` `items: one of "viewer", "editor"`
`audiences`	array of enum	yes		`minItems 1` `items: one of "public", "link", "people", "private"`
`transferable`	boolean	yes

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: example

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "people",
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
      },
      "username": "maticus",
      "display_name": "Maticus",
      "avatar_url": "https://cdn.openvibe.network/avatars/maticus.png",
      "role": "viewer",
      "added_by": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "added_at": "2026-11-06T00:00:00Z"
    }
  ],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS"
      },
      "username": "xenia",
      "display_name": "Xenia",
      "avatar_url": null,
      "requested_at": "2026-11-06T00:05:00Z"
    }
  ],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer",
    "editor"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true
}

Valid: link

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "link",
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
      },
      "username": "maticus",
      "display_name": "Maticus",
      "avatar_url": "https://cdn.openvibe.network/avatars/maticus.png",
      "role": "viewer",
      "added_by": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "added_at": "2026-11-06T00:00:00Z"
    }
  ],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true
}

Valid: locked

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "people",
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
      },
      "username": "maticus",
      "display_name": "Maticus",
      "avatar_url": "https://cdn.openvibe.network/avatars/maticus.png",
      "role": "viewer",
      "added_by": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "added_at": "2026-11-06T00:00:00Z",
      "key_slot": {
        "subject": {
          "type": "user",
          "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
        },
        "algorithm": "ECDH-P256/HKDF-SHA256/AES-256-GCM",
        "recipient_key": "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8",
        "ephemeral_public_key": {
          "kty": "EC",
          "crv": "P-256",
          "x": "eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg",
          "y": "eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXk"
        },
        "salt": "c3Nzc3Nzc3Nzc3Nzc3Nzcw==",
        "nonce": "bm5ubm5ubm5ubm5u",
        "wrapped_key": "d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3"
      }
    }
  ],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS"
      },
      "username": "xenia",
      "display_name": "Xenia",
      "avatar_url": null,
      "requested_at": "2026-11-06T00:05:00Z"
    }
  ],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer",
    "editor"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true,
  "lock": "people"
}

Valid: private

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "private",
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
      },
      "username": "maticus",
      "display_name": "Maticus",
      "avatar_url": "https://cdn.openvibe.network/avatars/maticus.png",
      "role": "viewer",
      "added_by": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "added_at": "2026-11-06T00:00:00Z"
    }
  ],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true
}

Valid: public

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "public",
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
      },
      "username": "maticus",
      "display_name": "Maticus",
      "avatar_url": "https://cdn.openvibe.network/avatars/maticus.png",
      "role": "viewer",
      "added_by": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "added_at": "2026-11-06T00:00:00Z"
    }
  ],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true
}

Rejected: audience

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "unlisted",
  "members": [],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true
}

Rejected: lock

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "people",
  "members": [
    {
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
      },
      "username": "maticus",
      "display_name": "Maticus",
      "avatar_url": "https://cdn.openvibe.network/avatars/maticus.png",
      "role": "viewer",
      "added_by": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "added_at": "2026-11-06T00:00:00Z"
    }
  ],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS"
      },
      "username": "xenia",
      "display_name": "Xenia",
      "avatar_url": null,
      "requested_at": "2026-11-06T00:05:00Z"
    }
  ],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer",
    "editor"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true,
  "lock": "everyone"
}

Rejected: unknown-field

{
  "ref": {
    "service": "community",
    "kind": "paste",
    "id": "abc"
  },
  "owner_subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "owner": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "ursula",
    "display_name": "Ursula",
    "avatar_url": null
  },
  "audience": "people",
  "members": [],
  "you": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "role": "owner"
  },
  "requests": [],
  "title": "LOOI bridge notes",
  "link": "https://community.openvibe.network/p/abc",
  "roles": [
    "viewer"
  ],
  "audiences": [
    "public",
    "link",
    "people",
    "private"
  ],
  "transferable": true,
  "content": "must never appear"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('share@1', value);   // { valid, errors: [{ path, message }] }

Share share@1

Fields

Examples

Validate

Share `share@1`