Skip to content

Commit

Permalink
[#3192] doc: add IPermissionLabels to authorization docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wardi committed Sep 16, 2016
1 parent c94c268 commit 6f3b1dc
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions doc/maintaining/authorization.rst
Expand Up @@ -86,5 +86,14 @@ Extensions

CKAN extensions can implement custom authorization rules by overriding the
authorization functions that CKAN uses. This is done by implementing the
:py:class:`~ckan.plugins.interfaces.IAuthFunctions` plugin interface. To get
started with writing CKAN extensions, see :doc:`/extensions/index`.
:py:class:`~ckan.plugins.interfaces.IAuthFunctions` plugin interface.

Dataset visibility is determined by permission labels stored in the
search index.
Implement the :py:class:`~ckan.plugins.interfaces.IPermissionLabels`
plugin interface then :ref:`rebuild your search index <rebuild search index>`
to change your dataset visibility rules. There is no
no need to override the ``package_show`` auth function, it will inherit
these changes automatically.

To get started with writing CKAN extensions, see :doc:`/extensions/index`.

0 comments on commit 6f3b1dc

Please sign in to comment.