ShareMemberInput share.member-input@1

Generated at 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/member-input.v1.json

share.member-input@1: network-wide sharing. Ids only; no resource title or content. Members apply to people audience; pending recipients may preview for seven days.

Fields

FieldTypeRequiredDescriptionConstraints
namestring
  • pattern ^@?[A-Za-z0-9_][A-Za-z0-9_.-]{0,63}$
subjectidentity.subject-ref
roleenumyes
  • one of "viewer", "editor"
expires_atstring
  • format date-time
key_slotlocker.people-slot

Examples

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

Valid: example
{
  "name": "@maticus",
  "role": "viewer"
}
Valid: locked
{
  "name": "@maticus",
  "role": "viewer",
  "key_slot": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
    },
    "algorithm": "ECDH-P256/HKDF-SHA256/AES-256-GCM",
    "recipient_key": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "ephemeral_public_key": {
      "kty": "EC",
      "crv": "P-256",
      "x": "eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg",
      "y": "eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXk"
    },
    "salt": "c3Nzc3Nzc3Nzc3Nzc3Nzcw==",
    "nonce": "bm5ubm5ubm5ubm5u",
    "wrapped_key": "d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3"
  }
}
Rejected: both
{
  "name": "@a",
  "subject": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
  },
  "role": "viewer"
}
Rejected: prefix
{
  "name": "@a*",
  "role": "viewer"
}
Rejected: unknown-field
{
  "name": "@maticus",
  "role": "viewer",
  "title": "must never appear"
}

Validate

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