Skip to content
Snippets Groups Projects
Commit 479cbf43 authored by florian's avatar florian
Browse files

DOC: Merge old text on possible actions and entity permissions

parent 86828884
No related branches found
No related tags found
1 merge request!67DRAFT: F permission docs
.. _Entity Permissions: .. _Entity Permissions Table:
Entity Permissions Entity Permissions
================== ==================
......
...@@ -49,6 +49,25 @@ Role permissions ...@@ -49,6 +49,25 @@ Role permissions
Entity permissions Entity permissions
****************** ******************
As the name suggests, entity permissions define what a certain user or role is
allowed to do with a specific entity. Thus, entity permissions can be used to,
e.g., deny everone but administration users to update or delete a specific
record types, or to allow everyone to retrieve a specific record. See the
:ref:`Entity permissions table` for a full list of possible entity
permissions. Typical permissions are:
- ``RETRIEVE:ENTITY``: To retrieve the full entity (name,
description, data type, …) with all parents and properties (unless
prohibited by another rule on the property level).
- ``RETRIEVE:ACL``: To retrieve the full and final ACL of this
entity.
- ``RETRIEVE:ENTITY:1234``: To retrieve the entity ``1234``.
- ``RETRIEVE:*:1234``: For all “retrieve” actions concerning the
entity ``1234``.
.. _Calculation: .. _Calculation:
Permission calculation Permission calculation
...@@ -68,24 +87,6 @@ undefined), the action can not take place. In other words, if you have ...@@ -68,24 +87,6 @@ undefined), the action can not take place. In other words, if you have
not been given the permission explicitly at some point, you don’t have not been given the permission explicitly at some point, you don’t have
it. it.
Possible actions
----------------
Until it is completely added to this documentation, a detailed description of
the actions governed by these permissions can be found in :ref:`Entity permissions`
Typical permissions are:
- ``RETRIEVE:ENTITY``: To retrieve the full entity (name,
description, data type, …) with all parents and properties (unless
prohibited by another rule on the property level).
- ``RETRIEVE:ACL``: To retrieve the full and final ACL of this
entity.
- ``RETRIEVE:ENTITY:1234``: To retrieve the entity ``1234``.
- ``RETRIEVE:*:1234``: For all “retrieve” actions concerning the
entity ``1234``.
Administration permissions Administration permissions
************************** **************************
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment