Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[stable23] Add documentation for the default_property_scope config.php key #8322

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions admin_manual/configuration_user/profile_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,58 @@ To disable profile globally add the following line to your ``config.php``

Please refer to :doc:`../configuration_server/config_sample_php_parameters` for
all available ``config.php`` options.

Property scopes
---------------

User properties (Full name, Address, Website, Role, …) have specific visibility scopes (Private, Local, Federated, Published).

The visibility scopes are explained below:

:Private:
Contact details visible locally only
:Local:
Contact details visible locally and through public link access on local instance
:Federated:
Contact details visible locally, through public link access and on trusted federated servers.
:Published:
Contact details visible locally, through public link access, on trusted federated servers and published to the public lookup server.

The default values for each property for each new user is listed below, but you should consult the declaration of the ``DEFAULT_SCOPES`` constant in the ``OC\Accounts\AccountManager`` class (`see the code <https://github.com/nextcloud/server/blob/master/lib/private/Accounts/AccountManager.php>`_) to make sure these are up-to-date.

+--------------+--------------------------+
| Property | Default visibility scope |
+==============+==========================+
| Full name | Federated |
+--------------+--------------------------+
| Address | Local |
+--------------+--------------------------+
| Website | Local |
+--------------+--------------------------+
| Email | Federated |
+--------------+--------------------------+
| Avatar | Federated |
+--------------+--------------------------+
| Phone | Local |
+--------------+--------------------------+
| Twitter | Local |
+--------------+--------------------------+
| Organisation | Local |
+--------------+--------------------------+
| Role | Local |
+--------------+--------------------------+
| Headline | Local |
+--------------+--------------------------+
| Biography | Local |
+--------------+--------------------------+

If you'd like to override the value for one or several default visibility scopes, use the ``account_manager.default_property_scope`` ``config.php`` configuration key, which defaults to an empty array:

.. code-block:: php

'account_manager.default_property_scope' => [
\OCP\Accounts\IAccountManager::PROPERTY_PHONE => \OCP\Accounts\IAccountManager::SCOPE_PRIVATE
\OCP\Accounts\IAccountManager::PROPERTY_ROLE => \OCP\Accounts\IAccountManager::SCOPE_FEDERATED
]

In the above example, the phone and role properties are respectively overritten to the private and federated scopes. Note that these changes will only apply to *new* users, not existing ones.