Creating an administrator user
Overleaf Toolkit deployments:Overleaf Toolkit
Legacy docker-compose
For a programmatic approach you can use the same script to create regular users as well as administrators. For regular users omit the —admin flag.
1
Via the Admin UI
- Log in as an existing administrator.
- Click Admin -> Manage Users.
- Search for the user and click on their name.
- Click the pencil icon.
- Turn Admin on or off.
- Click Save to finish.
Deleting users
It is generally advisable not to delete accounts unless they are no longer required. Deleting an account removes the account and causes collaborators to lose access to projects. To stop a user from logging in and keep their data, disable the account instead. By default, accounts are soft-deleted. For information about permanently removing users from your instance seeENABLE_CRON_RESOURCE_DELETION in the Environment variables guide.
Accounts are soft-deleted by default. See
ENABLE_CRON_RESOURCE_DELETION for permanent deletion behavior.Via Admin -> Manage Users
1
- Log in as an administrator.
- Click Admin -> Manage Users.
- Search for the user and check the box next to their name.
- Click the bin icon.
- Click Delete account to confirm.
Via the command line
User accounts (and their projects) can be deleted using the following commands. Overleaf Toolkit deployments:Overleaf Toolkit
Legacy docker-compose
The deletion script uses a hard-coded force option that ensures deletion proceeds even if the account deletion email fails to send (e.g., when the user’s email is no longer in service).
The option —skip-email can be used to prevent sending an informative email to the deleted user.
Restoring a soft-deleted user
If a user has only been soft-deleted, you can restore their account and the projects deleted with it. Projects the user had deleted themselves stay deleted.1
- Log in as an administrator.
- Click Admin -> Manage Users.
- Search for the user you want to restore.
- Click Display deleted users.
- Click the arrow icon on the user’s row.
- Click Restore to confirm.
When ENABLE_CRON_RESOURCE_DELETION is set to true, soft-deleted accounts can be restored within a 90-day window. After 90 days, account recovery is not possible.
Counting users
You can obtain user counts via the admin UI at https://you-instance-url/admin/user#license. For programmatic checks and exports, the following examples may help. Total number of users:Total number of users
Num active users from metrics
Total number of active users
Updating user account information
How account updates are performed depends on whether SSO is enabled.- If SSO is not used:
- Administrators can modify user account information via Admin -> Manage Users (email, first name, last name, and generate a password reset link).
- Regular users can update their own details via Account -> Account Settings (including changing password and generating Git authentication tokens).
- If SSO is used:
- Ayakaleaf Pro can be configured to update a user’s first and last name during login based on the authentication system.
- When OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN or OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN are true, the user details form on https://your-instance-url/user/settings is disabled and first/last name can only be set in your identity management system.
Q&A
Can I create SSO users in advance, for example with an API?
Can I create SSO users in advance, for example with an API?
Answer: There is no HTTP API for this. Create the account with the
create-user script above (without --admin), or in Admin → Manage Users with Create account. When EXTERNAL_AUTH is set, that form has a Log in with SSO option, which creates the account without a local password and without an activation email or link: the dialog closes after Create. At the first LDAP, SAML or OIDC login, the user gets the existing account with the same email instead of a new one, see Accounts and passwords.Can I export the user list and restore it later?
Can I export the user list and restore it later?
Answer: No. There is no export or import of user accounts, neither in Admin → Manage Users nor as a script. Accounts are stored in MongoDB, so back them up and restore them with a MongoDB backup. The
export-user-projects.mjs script exports users’ projects as zip files, not the accounts, see Exporting projects.How long is the create-user link valid, and how do I reset a password without email?
How long is the create-user link valid, and how do I reset a password without email?
Answer: The link that
create-user prints is valid for 7 days, and it works without SMTP because you copy it from the output. To get a new link, run create-user again with the same email. For an existing account it only prints a fresh link, but it also sets the account’s admin flag to match --admin, so keep --admin when you run it for an administrator.An administrator can also get a reset link without email: in Admin → Manage Users, click the lock icon on the user’s row, then Send reset link, and copy the link from the dialog. It is valid for 1 hour, see Send an activation or reset link.Or set a password directly: click the user’s name, then the pencil icon, enter a New password of at least 8 characters and click Save. Accounts that log in only through LDAP, SAML or OIDC cannot get a password in either way.Last updated 4 months ago This documentation page contains links to external guides and configuration pages. All links and query parameters are preserved as in the original content.

