remote/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2026-06-24 01:34:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

Document how actors are displayed (#2792)

Browse source 
Closes #2002
This commit is contained in:
Sebastian Cao 2026-06-24 05:07:56 +08:00 • committed by GitHub
commit a5931594de
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/authentication.rst
View file

@ -21,6 +21,23 @@ The actor dictionary can be any shape - the design of that data structure is lef
Plugins can use the :ref:`plugin_hook_actor_from_request` hook to implement custom logic for authenticating an actor based on the incoming HTTP request.
.. _authentication_actor_display:
How actors are displayed
------------------------
In a number of places - such as the navigation menu and the ``/-/logout`` page - Datasette needs to display a short label representing the currently authenticated actor.
To decide what to show, Datasette looks through the following keys in the actor dictionary and uses the value of the first one that is present and not empty:
* ``display``
* ``name``
* ``username``
* ``login``
* ``id``
If none of those keys have a value the actor dictionary is displayed as a string instead.
.. _authentication_root:
Using the "root" actor