home api list

Hexostore API Documentation

bundle_permission

/api/bundle_permission/

List methods: post, get

Detail methods: get, delete

BundlePermissions represent a link between two users defined by the bundle, aka. a relationship. This is how we allow one user to view/modify another user's data.

Fields

bundle:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field is required.

name:

Unicode string data. Ex: "Hello World"

This field may be blank

This field may be null

resource_uri:

The unique URI where the object resides.

This field is readonly.

user_allowed:

A user. Maybe specified by URI, email, or ID. Using a URI is recommended.

This field is returned fully populated.

This field is required.

user_target:

A user. Maybe specified by URI, email, or ID. Using a URI is recommended.

This field is returned fully populated.

This field is required.

Filtering Options

bundle: exact, in

user_allowed: exact, in

user_target: exact, in

Sorting Options

No sorting supported

© 2024 by CarrĂ© Technologies Inc.