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.

Sign up for GitHub

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

Jump to bottom

Document new command ldap:check-group #11079

Merged
merged 2 commits into from
Aug 31, 2023
Merged

Document new command ldap:check-group #11079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dec9032
Document new command ldap:check-group
come-nc Aug 28, 2023
0e1cd69
Apply suggestions from code review
come-nc Aug 31, 2023
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
6 changes: 6 additions & 0 deletions admin_manual/configuration_server/occ_command.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,6 +946,7 @@ you can run the following LDAP commands with ``occ``::

ldap
ldap:check-user checks whether a user exists on LDAP.
ldap:check-group checks whether a group exists on LDAP.
ldap:create-empty-config creates an empty LDAP configuration
ldap:delete-config deletes an existing LDAP configuration
ldap:search executes a user or group search
Expand Down Expand Up @@ -990,6 +991,11 @@ use the ``--force`` option to force it to check all active LDAP connections::

sudo -u www-data php occ ldap:check-user --force robert

``ldap:check-group`` checks whether a group still exists in the LDAP directory.
Use with ``--update`` to update the group membership cache on the Nextcloud side::

sudo -u www-data php occ ldap:check-group --update mygroup

``ldap:create-empty-config`` creates an empty LDAP configuration. The first
one you create has ``configID`` ``s01``, and all subsequent configurations
that you create are automatically assigned IDs::
Expand Down
4 changes: 4 additions & 0 deletions admin_manual/configuration_user/user_auth_ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,10 @@ in batches from all users again. Beside that they are also refreshed during a
login for this user or can be fetched manually via the occ command
``occ ldap:check-user --update USERID`` where ``USERID`` is Nextcloud's user id.

For groups, a cache of memberships is stored in the database to be able to trigger
events when a membership is added or removed. This cache is updated by a background
job, and can be force updated using ``occ ldap:check-group --update GROUPID``.

Caching
^^^^^^^

Expand Down