-
Notifications
You must be signed in to change notification settings - Fork 534
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Skeletal documentation for authz and identity modules
- Loading branch information
1 parent
d30584b
commit dddb39a
Showing
3 changed files
with
28 additions
and
255 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
``annotator.authz.acl`` module | ||
============================== | ||
|
||
This module configures an authorization policy which grants or denies permission | ||
on objects (especially annotations) based on the presence of ``permissions`` or | ||
``user`` properties on the objects. | ||
|
||
See :func:`annotator.authz.acl` for full API documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
``annotator.identity.simple`` module | ||
===================================== | ||
|
||
This module configures an identity policy which considers the identity of the | ||
current user to be an opaque identifier. By default the identity is | ||
unconfigured, but can be set. | ||
|
||
Example | ||
------- | ||
|
||
:: | ||
|
||
app.include(annotator.identity.simple); | ||
app | ||
.start() | ||
.then(function () { | ||
app.ident.identity = 'joebloggs'; | ||
}); | ||
|
||
See :func:`annotator.identity.simple` for full API documentation. |
This file was deleted.
Oops, something went wrong.