diff --git a/src/doc/entity-permission-table.rst b/src/doc/entity-permission-table.rst index f78fbe78c1a42df83a6564abb026f957664fa5fb..1ff75f2138d7ae5382a00ee6fc9a60317fbbed28 100644 --- a/src/doc/entity-permission-table.rst +++ b/src/doc/entity-permission-table.rst @@ -1,4 +1,4 @@ -.. _Entity Permissions: +.. _Entity Permissions Table: Entity Permissions ================== diff --git a/src/doc/permissions.rst b/src/doc/permissions.rst index 7135b1cf2b70780125b8b1b13638a28a117c395e..86932e9b2acdd7db0af472b1db8ec29ade86925f 100644 --- a/src/doc/permissions.rst +++ b/src/doc/permissions.rst @@ -49,6 +49,25 @@ Role 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: Permission calculation @@ -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 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 **************************