Skip to content

Commit 8b7372f

Browse files
committed
Update permissions section
Add Retire/Restore per class permissions. Move Register to web/email section. Reformat web/email permission list. including splitting the terms in the Rest Access/Web Access into two lines.
1 parent db476f1 commit 8b7372f

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

doc/reference.txt

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1551,44 +1551,56 @@ example that requires database content changes.
15511551
Security / Access Controls
15521552
==========================
15531553

1554-
A set of Permissions is built into the security module by default:
1554+
A set of Permissions is built into the security module by default. For
1555+
each Class defined in the tracker schema, the following permissions
1556+
are defined:
15551557

15561558
- Create (everything)
15571559
- Edit (everything)
1558-
- Search (everything) (used if View does not permit access)
1560+
- Search (everything) - (used if View does not permit access)
1561+
- Retire (everything)
1562+
- Restore (everything)
15591563
- View (everything)
1560-
- Register (User class only)
15611564

1562-
These are assigned to the "Admin" Role by default, and allow a user to do
1563-
anything. Every Class you define in your `tracker schema`_ also gets an
1564-
Create, Edit and View Permission of its own. The web and email interfaces
1565+
All of these are assigned to the "Admin" Role by default for every
1566+
class. They allow a user to do anything. The web and email interfaces
15651567
also define:
15661568

1567-
*Email Access*
1569+
Email Access
15681570
If defined, the user may use the email interface. Used by default to deny
15691571
Anonymous users access to the email interface. When granted to the
15701572
Anonymous user, they will be automatically registered by the email
15711573
interface (see also the ``new_email_user_roles`` configuration option).
1572-
*Web Access*
1573-
If defined, the user may use the web interface. All users are able to see
1574-
the login form, regardless of this setting (thus enabling logging in).
1575-
*Web Roles*
1574+
1575+
Web Access
1576+
If defined, the user may use the web interface. This is usually
1577+
assigned to the Anonymous role as well to allow authorized users to
1578+
access the form based login. If some other authorization mode (basic
1579+
auth, SSO, etc.) is used Web Access can be removed from the
1580+
Anonymous user.
1581+
1582+
Web Roles
15761583
Controls user access to editing the "roles" property of the "user" class.
15771584
TODO: deprecate in favour of a property-based control.
1578-
*Rest Access* and *Xmlrpc Access*
1585+
1586+
Rest Access |br| Xmlrpc Access
15791587
These control access to the Rest and Xmlrpc endpoints. The Admin and User
15801588
roles have these by default in the classic tracker. See the
15811589
`directions in the rest interface documentation`_ and the
15821590
`xmlrpc interface documentation`_.
15831591

1592+
Register
1593+
This is assigned to the anonymous user and allows automatic user
1594+
registration by email or web.
1595+
15841596
These are hooked into the default Roles:
15851597

1586-
- Admin (Create, Edit, Search, View and everything; Web Roles)
1598+
- Admin (Create, Edit, Retire, Restore, Search, View for everything; Web Roles)
15871599
- User (Web Access; Email Access)
15881600
- Anonymous (Web Access)
15891601

1590-
And finally, the "admin" user gets the "Admin" Role, and the "anonymous"
1591-
user gets "Anonymous" assigned when the tracker is installed.
1602+
Finally, the "admin" user gets the "Admin" Role, and the "anonymous"
1603+
user gets the "Anonymous" Role assigned when the tracker is installed.
15921604

15931605
For the "User" Role, the "classic" tracker defines:
15941606

@@ -3997,3 +4009,9 @@ rather than requiring a web server restart.
39974009
.. _change the rate limiting method: rest.html#creating-custom-rate-limits
39984010
.. _`directions in the rest interface documentation`: rest.html#enabling-the-rest-api
39994011
.. _`xmlrpc interface documentation`: xmlrpc.html#through-roundup
4012+
4013+
.. allow line breaks in term definitions.
4014+
.. |br| raw:: html
4015+
4016+
<br/>
4017+

0 commit comments

Comments
 (0)