Arke
ReferenceSchemas

Collection

Reference for the arke/collection@v1 profile -- permission containers with role-based access.

Profile

arke/collection@v1

Required Properties

PropertyTypeDescription
labelstringDisplay name
rolesRolesConfigRole definitions mapping role names to action arrays

Optional Properties

PropertyTypeDescription
descriptionstringCollection description
display_image_urlstringDisplay image URL

Roles Configuration

{
  "owner": ["view", "edit", "create", "delete", "manage"],
  "editor": ["view", "edit", "create"],
  "viewer": ["view"],
  "public": ["view"]
}

Custom roles can be defined with any combination of actions:

{
  "transcriber": ["view", "annotate"],
  "reviewer": ["view", "annotate", "approve"]
}

Relationships

Role Assignments

Role names are used as predicates. Peer must be user, group, or * (wildcard for public):

{ "predicate": "owner", "peer": "01JUSER...", "peer_type": "user" }
{ "predicate": "public", "peer": "*", "peer_type": "wildcard" }

Content

{ "predicate": "contains", "peer": "01JFOLDER...", "peer_type": "folder" }

Validation Rules

  • Must have a label string
  • Must have roles object with valid action arrays
  • Must have at least one owner role assignment
  • Role assignments must target user, group, or wildcard

On this page