Skip to content

feat(admin_manual/occ_command): add user:welcome and user:sync-account-data #12926

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
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
29 changes: 27 additions & 2 deletions admin_manual/occ_command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1420,8 +1420,8 @@ report showing how many users you have, and when a user was last logged in::
user:report shows how many users have access
user:resetpassword Resets the password of the named user
user:setting Read and modify user settings
user:keys:verify Verify that the stored public key matches
the stored private key
user:sync-account-data Sync user backend data to accounts table for configured users
user:welcome Sends the welcome email


user:add
Expand Down Expand Up @@ -1591,6 +1591,31 @@ user:list

You can use the command ``user:list`` to list users. By default it will limit the output to 500 users but you can override that with options ``--limit`` and ``--offset``. Use ``--disabled`` to only list disabled users.

user:sync-account-data
^^^^^^^^^^^^^^^^^^^^^^

Usually, the account data in the Nextcloud instance database (``oc_accounts``) is updated once a change on another user backend (for example, SAML) is detected.
However, in case of an error, the state between the user backend and the ``oc_accounts`` table might become inconsistent.

You can manually sync user backend data to accounts table with the ``user:sync-account-data`` command::

user:sync-account-data [-l|--limit=500] [-o|--offset=0]

user:welcome
^^^^^^^^^^^^

When you need to manually send the welcome email (for example, if the user was added via LDAP but hasn't logged in yet), you can use the ``user:welcome`` command. The syntax is::

user:welcome [-r|--reset-password] <user>

For example::

user:welcome [email protected]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:
Is it .ltd (Limited?) or .tld (Top Level Domain)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Top Level Domain


Or, if it should contain the reset password link::

user:welcome --reset-password [email protected]

.. _group_commands_label:

Group commands
Expand Down