Part of Stem. This page defines the Access method of the sync RPC specification. It makes the authority graph inspectable.

The formal schema is attached as the schemaDefinition of this page: a struct {key, input, output} with key pinned to Access.

Explains what access a principal has to a scope and through which grants. The same evaluator that gates every read and write answers this call.

Input

Output

Rules

Evaluates the authority graph for scope's node and returns the live level of principal (null for none) and the chain of Grant CIDs that gives it, from the grant signed by the owner down to the one naming the principal or a group it belongs to.

With no principal, evaluates an unauthenticated peer: level is read when the node is readable by everyone, else null.

public reports whether the node's readers include everyone, independent of the principal.

The method reads the local index only; it does not contact peers and does not count as a disclosure.

A client may call it for any principal, including one that does not exist; the answer is then null.

Today (HM24)

Example

{"key": "Access", "input": {"scope": {"space": {"/": {"bytes": "7QEA…"}}, "node": "bafyrein6a6wfhym6l3vfz5zfkkibj5j6wjibagi3mnbqnspuq2idw52ijb", "depth": "subtree"}, "principal": {"/": {"bytes": "7QEC44…"}}}}

{"principal": {"/": {"bytes": "7QEC44…"}}, "scope": {"space": {"/": {"bytes": "7QEA…"}}, "node": "bafyrein6a6wfhym6l3vfz5zfkkibj5j6wjibagi3mnbqnspuq2idw52ijb", "depth": "subtree"}, "level": "write", "via": [{"/": "bafy…g0"}, {"/": "bafy…g1"}], "public": false}

See also

access-report

Authority

Grant