docs: improve /tokens result-description #256

Merged
cmo merged 1 commit from issue-232 into master 2026-07-21 12:57:27 +00:00

View file

@ -239,6 +239,11 @@ is a JSON objects that corresponds to the collection configuration object
(see :ref:`config_file`), but has an additional ``name`` attribute that
specifies the name of the collection that should be created or updated.
When a collection is deleted via ``DELETE /collections/<name>``, the data that
is stored in storage root is **not** deleted. The collection information is
just removed from the internal configuration database. If a collection is
recreated with identical backend configurations, the data in the storage root
can be accessed again.
Tokens
^^^^^^
@ -279,6 +284,16 @@ token-hash, i.e, a sha256 hash of the plaintext-token in hexdigit format.
The command ``dump-things-hash-token`` can be used to generate a
valid token hash
Note: tokens that are accessible via the `/tokens`-endpoint are stored in the
internal configuration database. They can be used for authentication and if the
authentication source `config` (which is the default, if no authentication
source is defined for a collection) is configured. But tokens are only one way
to authenticate with the service, For example, Forgejo-authentication sources
can be used to authenticate via tokens and teams of a forgejo instance. That
means, to get the complete overview over authentication options for a
collection, the authentication source configuration of the collection has be be
taken into account.
Admin Tokens
^^^^^^^^^^^^