Scopes

A scope is a fact that brings together multiple templates and filters. They can be used in permissioning to indicate the nodes covered by the permission relative to the permission's targeted node.

Scope Creation

Scopes are created using the createscope API call.

Example:

POST /createscope {
    "parentId": "00000000C320A7BFD903745851915F6C33D20634E36C37C6",
    "name": "ApplicationScope",
    "description": "Covers the facts accessible by this application",
    "templateIds": [
        "00000000A5ABACFABC029D2A526291DDF04559242F286757",
        "00000000AE5AA31410B5AABEEE9E981A890CD932F21C3204"
    ],
    "filterIds": [
        "000000002B46D4331F76C89EE12CC82E9CA87EFFFA695CC0",
        "00000000F33F1BBE66809D4B5682A6823744AB253AE99F51"
    ]
}

The scope name must be unique within the associated login.

A scope can be referenced either using its node id, or using one of the following FRNs.

Description FRI
Full FRI frn:scope:0000000009C2602130DEC995888A2CE624A7FCA1513E1B48:ApplicationScope
Login understood frn:scope::ApplicationScope
Short FRI :NameAndAddressScope

Scopes in Permissions

The only use of scopes, currently, is in permissions to specify nodes covered by the permission.