# Table of Contents - [Welcome | On-premises | Overleaf docs](#welcome-on-premises-overleaf-docs) - [Intro to Overleaf Commons | Overleaf Commons | Overleaf docs](#intro-to-overleaf-commons-overleaf-commons-overleaf-docs) - [Getting set up | Overleaf Commons | Overleaf docs](#getting-set-up-overleaf-commons-overleaf-docs) - [Configuring SSO | Overleaf Commons | Overleaf docs](#configuring-sso-overleaf-commons-overleaf-docs) - [Single sign-on (SSO) | Overleaf Commons | Overleaf docs](#single-sign-on-sso-overleaf-commons-overleaf-docs) - [User log in options | Overleaf Commons | Overleaf docs](#user-log-in-options-overleaf-commons-overleaf-docs) - [SSO FAQs | Overleaf Commons | Overleaf docs](#sso-faqs-overleaf-commons-overleaf-docs) - [Your Admin Hub | Overleaf Commons | Overleaf docs](#your-admin-hub-overleaf-commons-overleaf-docs) - [User unenrollment | Overleaf Commons | Overleaf docs](#user-unenrollment-overleaf-commons-overleaf-docs) - [Insights and reporting | Overleaf Commons | Overleaf docs](#insights-and-reporting-overleaf-commons-overleaf-docs) - [Your Overleaf portal | Overleaf Commons | Overleaf docs](#your-overleaf-portal-overleaf-commons-overleaf-docs) - [User enrollment | Overleaf Commons | Overleaf docs](#user-enrollment-overleaf-commons-overleaf-docs) - [User management | Overleaf Commons | Overleaf docs](#user-management-overleaf-commons-overleaf-docs) - [Troubleshooting and support | Overleaf Commons | Overleaf docs](#troubleshooting-and-support-overleaf-commons-overleaf-docs) - [Welcome | Groups | Overleaf docs](#welcome-groups-overleaf-docs) - [How to create a group | Groups | Overleaf docs](#how-to-create-a-group-groups-overleaf-docs) - [Accessing your admin settings | Groups | Overleaf docs](#accessing-your-admin-settings-groups-overleaf-docs) - [Buying more licenses and upgrading | Groups | Overleaf docs](#buying-more-licenses-and-upgrading-groups-overleaf-docs) - [Controlling feature availability | Groups | Overleaf docs](#controlling-feature-availability-groups-overleaf-docs) - [Group metrics | Groups | Overleaf docs](#group-metrics-groups-overleaf-docs) - [Adding and removing users and managers | Groups | Overleaf docs](#adding-and-removing-users-and-managers-groups-overleaf-docs) - [Roles and permissions | Groups | Overleaf docs](#roles-and-permissions-groups-overleaf-docs) - [Group subscription audit logs | Groups | Overleaf docs](#group-subscription-audit-logs-groups-overleaf-docs) - [Setting up Group SSO | Groups | Overleaf docs](#setting-up-group-sso-groups-overleaf-docs) - [Updating billing information | Groups | Overleaf docs](#updating-billing-information-groups-overleaf-docs) - [Renewing a subscription | Groups | Overleaf docs](#renewing-a-subscription-groups-overleaf-docs) - [Plan for success | Groups | Overleaf docs](#plan-for-success-groups-overleaf-docs) - [Accessing invoices and receipts | Groups | Overleaf docs](#accessing-invoices-and-receipts-groups-overleaf-docs) - [Step 1: Add Overleaf to your Identity Provider | Groups | Overleaf docs](#step-1-add-overleaf-to-your-identity-provider-groups-overleaf-docs) - [Linking users to Group SSO | Groups | Overleaf docs](#linking-users-to-group-sso-groups-overleaf-docs) - [Switching plans | Groups | Overleaf docs](#switching-plans-groups-overleaf-docs) - [Step 4: Enable SSO for your team | Groups | Overleaf docs](#step-4-enable-sso-for-your-team-groups-overleaf-docs) - [Group SSO FAQs | Groups | Overleaf docs](#group-sso-faqs-groups-overleaf-docs) - [FAQs | Groups | Overleaf docs](#faqs-groups-overleaf-docs) - [Step 2: Configure your SSO settings with IdP metadata | Groups | Overleaf docs](#step-2-configure-your-sso-settings-with-idp-metadata-groups-overleaf-docs) - [Maintaining Group SSO | Groups | Overleaf docs](#maintaining-group-sso-groups-overleaf-docs) - [Managed Users | Groups | Overleaf docs](#managed-users-groups-overleaf-docs) - [Step 3: Verify the connection between your IdP and Overleaf | Groups | Overleaf docs](#step-3-verify-the-connection-between-your-idp-and-overleaf-groups-overleaf-docs) - [Group SSO test troubleshooting | Groups | Overleaf docs](#group-sso-test-troubleshooting-groups-overleaf-docs) - [Skills needed | On-premises | Overleaf docs](#skills-needed-on-premises-overleaf-docs) - [Before you start | On-premises | Overleaf docs](#before-you-start-on-premises-overleaf-docs) - [Email Protection | Cloudflare](#email-protection-cloudflare) - [Integrations and add-ons | Overleaf docs](#integrations-and-add-ons-overleaf-docs) - [Navigating in the editor | Overleaf docs](#navigating-in-the-editor-overleaf-docs) - [Writing and editing | Overleaf docs](#writing-and-editing-overleaf-docs) - [Troubleshooting and support | Overleaf docs](#troubleshooting-and-support-overleaf-docs) - [Managing projects and files | Overleaf docs](#managing-projects-and-files-overleaf-docs) - [Subscriptions, payments, and billing | Overleaf docs](#subscriptions-payments-and-billing-overleaf-docs) --- # Welcome | On-premises | Overleaf docs Overleaf is a collaborative LaTeX editor loved by researchers and tech teams. Our cloud version is available at [overleaf.com](https://www.overleaf.com/) . These docs are specifically for people interested in setting up and maintaining Overleaf Server Pro or Community Edition. [](https://docs.overleaf.com/on-premises#overview-of-server-pro-and-community-edition) Overview of Server Pro and Community Edition ---------------------------------------------------------------------------------------------------------------------------------------- Both Server Pro and Community Edition run in Docker containers, isolating them from other applications on the same host. This provides an additional layer of security by preventing potential cross-application attacks. They can run on air-gapped servers, which means they can be completely isolated from other networks, including the Internet. Docker provides tooling for transferring the application from an internet-connected to an air-gapped environment. After the initial download, no internet connection is required, significantly reducing the risk of external threats. Overleaf Community Edition is intended for use in environments where **all** users are trusted. Community Edition is **not** appropriate for scenarios where isolation of users is required due to Sandbox Compiles not being available. Without sandboxing, LaTeX compiles run with the same privileges as the container, allowing access to its filesystem, network, and environment variables. This creates a risk of data exposure or system compromise. Non-sandboxed compiles should only be used in fully trusted environments; for multi-user or production deployments, Sandbox Compiles are strongly recommended. For more information on Sandbox Compiles check out our [documentation](https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/sandboxed-compiles) . [Server Pro vs. Community Edition](https://docs.overleaf.com/on-premises/welcome/server-pro-vs.-community-edition) [](https://docs.overleaf.com/on-premises#stay-up-to-date) Stay up to date ------------------------------------------------------------------------------ [Subscribe to our mailing list](https://mailchi.mp/overleaf.com/community-edition-and-server-pro) to get updates on: * New releases and features * Enhancements * Security patches All mailing list emails originate from the email address [\[email protected\]](https://docs.overleaf.com/cdn-cgi/l/email-protection) [](https://docs.overleaf.com/on-premises#quick-links) Quick links ---------------------------------------------------------------------- [Before you start](https://docs.overleaf.com/on-premises/getting-started/before-you-start) [Release notes](https://docs.overleaf.com/on-premises/release-notes) [NextServer Pro vs. Community Edition](https://docs.overleaf.com/on-premises/welcome/server-pro-vs.-community-edition) Last updated 4 months ago Was this helpful? * [Overview of Server Pro and Community Edition](https://docs.overleaf.com/on-premises#overview-of-server-pro-and-community-edition) * [Stay up to date](https://docs.overleaf.com/on-premises#stay-up-to-date) * [Quick links](https://docs.overleaf.com/on-premises#quick-links) Was this helpful? --- # Intro to Overleaf Commons | Overleaf Commons | Overleaf docs **Not an admin?** You can get help using Overleaf in our [User docs](https://docs.overleaf.com/) . [](https://docs.overleaf.com/commons#what-is-overleaf-commons) What is Overleaf Commons? --------------------------------------------------------------------------------------------- Overleaf Commons allows universities and organizations to provide access to Overleaf premium features across an entire campus or company, or to specific groups. An Overleaf Commons subscription includes a custom portal, automatic validation and upgrade of eligible users, and an administrator hub and metrics to allow institutions to monitor the usage of their Commons subscription. Enrollment in an Overleaf Commons subscription happens when a user confirms their institutional affiliation and eligibility. For Commons subscriptions that use single sign-on enrollment, the eligibility of authorized users is checked using entitlement data that is sent to Overleaf when the user logs in with SSO. For domain-based enrollment, users are added to the subscription when they confirm an institutional email address that has an entitled institutional domain. [](https://docs.overleaf.com/commons#getting-overleaf-commons) Getting Overleaf Commons -------------------------------------------------------------------------------------------- Overleaf Commons is already available at [many leading institutions](https://www.overleaf.com/for/institutions-using-overleaf) and organizations. If your organization doesn't have an Overleaf Commons subscription but would like one, [please contact us](https://www.overleaf.com/for/contact-sales-universities) . If you have further technical questions that aren't answered on these pages, [please contact Overleaf Support.](https://www.overleaf.com/contact) [NextGetting set up](https://docs.overleaf.com/commons/getting-set-up) Last updated 19 days ago Was this helpful? * [What is Overleaf Commons?](https://docs.overleaf.com/commons#what-is-overleaf-commons) * [Getting Overleaf Commons](https://docs.overleaf.com/commons#getting-overleaf-commons) Was this helpful? --- # Getting set up | Overleaf Commons | Overleaf docs Overleaf Commons subscriptions are set up in collaboration with members of the Overleaf Support and Success teams. As part of the onboarding process, the Overleaf Support team will provide technical assistance and help with [single sign-on](https://docs.overleaf.com/commons/single-sign-on-sso) and [portal](https://docs.overleaf.com/commons/your-overleaf-portal) setup. Once the subscription is enabled, the Overleaf Success team will give an overview of the subscription's usage metrics and provide additional resources and information. [](https://docs.overleaf.com/commons/getting-set-up#the-setup-process) The setup process --------------------------------------------------------------------------------------------- 1 ### [](https://docs.overleaf.com/commons/getting-set-up#kickoff-meeting) Kickoff meeting The Overleaf Commons onboarding process usually begins with a kickoff meeting to answer any questions you might have about your new subscription and how the setup works. During this meeting, we'll explain what information we need to set up the subscription, describe how we gather that information, and outline the steps in the subscription setup. 2 ### [](https://docs.overleaf.com/commons/getting-set-up#portal-page-setup) Portal page setup A Commons subscription comes with an Overleaf portal page—while these are optional, most customers choose to have one. This customizable page provides: * Information about your subscription, including who is eligible to join. * Links to helpful information about how to use the service and access to key resources, including how to maximize the benefits of premium features and information about technical support. * A direct link to your SSO login page (if you choose to have SSO), allowing users to easily register or log in to their Overleaf accounts. You'll need to provide us with information, images, and any wording that you want to include on your portal page. 3 ### [](https://docs.overleaf.com/commons/getting-set-up#single-sign-on-sso-setup) Single sign-on (SSO) setup Overleaf Commons supports a standard SAML single sign-on (SSO) configuration. During the onboarding process, the Overleaf support team will provide you with configuration information and will assist in the setup of the SSO login option. We'll need to work with you and your IT team to get this up and running correctly. There's more about the information you'll need to provide in: [Single sign-on (SSO)](https://docs.overleaf.com/commons/single-sign-on-sso) 4 ### [](https://docs.overleaf.com/commons/getting-set-up#launching-your-commons-subscription) Launching your Commons subscription Once everything is set up correctly, our Customer Success team will work with you to launch and promote the subscription to your users. If you would like to get a head start and begin working on custom promotional materials with our Customer Success team prior to completion of the technical setup, please [contact the Success team](https://docs.overleaf.com/cdn-cgi/l/email-protection#e89b9d8b8b8d9b9ba8879e8d9a848d898ec68b8785) at your convenience [PreviousIntro to Overleaf Commons](https://docs.overleaf.com/commons) [NextSingle sign-on (SSO)](https://docs.overleaf.com/commons/single-sign-on-sso) Last updated 9 months ago Was this helpful? * [The setup process](https://docs.overleaf.com/commons/getting-set-up#the-setup-process) * [Kickoff meeting](https://docs.overleaf.com/commons/getting-set-up#kickoff-meeting) * [Portal page setup](https://docs.overleaf.com/commons/getting-set-up#portal-page-setup) * [Single sign-on (SSO) setup](https://docs.overleaf.com/commons/getting-set-up#single-sign-on-sso-setup) * [Launching your Commons subscription](https://docs.overleaf.com/commons/getting-set-up#launching-your-commons-subscription) Was this helpful? --- # Configuring SSO | Overleaf Commons | Overleaf docs If you're not familiar with your organization's Identity Provider (IdP) and SSO setup, make sure someone who has this information is involved in the SSO setup process. Overleaf Commons provides a standard SAML-based single sign-on (SSO) option which requires your Identity Provider (IdP) to return a small set of SAML attributes to associate users with their Overleaf accounts and verify their participation in the subscription. We're a registered Service Provider in UKAMF. Our SAML metadata is available from UKAMF, other affiliated federations, and [online](https://www.overleaf.com/saml/ukamf/sp/entity) . [](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#configuration-process) Configuration process ------------------------------------------------------------------------------------------------------------------------- The SSO configuration process will be explained during your onboarding. You, or someone from your IT team, will be asked to: 1. Configure your IdP with Overleaf's SAML metadata. All authenticated users should be authorized to access the Overleaf application, and the attributes described on this page should be released. 2. Provide your IdP's metadata to the Overleaf onboarding team and identify which attributes will be used. 3. Assist with testing the trust relationship and verifying that the expected attributes are being sent. Once the configuration is complete and tested, the Service Provider side of the configuration is reviewed by the Overleaf engineering team. SSO is then enabled when the subscription itself is enabled. [](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#required-attributes) Required attributes --------------------------------------------------------------------------------------------------------------------- We ask you to provide attributes as follows: * **A unique, persistent, non-reassigned user identifier**. Typically this is ‘eduPersonPrincipalName’, provided it is unique, persistent, and non-reassigned, but it can be any ID field that meets those requirements. * **An organization/institution email address.** This identifies the user's affiliation in our system and may be used to provide notifications, such as invitations to their collaborators' projects. Usually, this is the ‘mail’ attribute. * **First and last name attributes (optional).** These attributes are used to initialize the user's account information, which can be updated by the user at any time. * **An entitlement attribute (not always required).** The value provided in this attribute can be used to identify users that should be placed on the subscription. [](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#authorization-and-entitlement) Authorization and entitlement ----------------------------------------------------------------------------------------------------------------------------------------- In almost all cases, all authenticated users should be authorized to access the Overleaf service. This allows users who are not participating in the subscription to continue to access the service but remain on the free plan. Subscription enrollment can be restricted by defining a user group through your IdP-provided tools. Group membership status can be sent to Overleaf as part of the SAML data during user authentication. [](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#updating-the-sso-configuration) Updating the SSO Configuration ------------------------------------------------------------------------------------------------------------------------------------------- If any updates to the SSO configuration are required, including the provision of new certificates, please [contact Overleaf Support](https://docs.overleaf.com/commons) . [PreviousSingle sign-on (SSO)](https://docs.overleaf.com/commons/single-sign-on-sso) [NextUser log in options](https://docs.overleaf.com/commons/single-sign-on-sso/user-log-in-options) Last updated 1 year ago Was this helpful? * [Configuration process](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#configuration-process) * [Required attributes](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#required-attributes) * [Authorization and entitlement](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#authorization-and-entitlement) * [Updating the SSO Configuration](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso#updating-the-sso-configuration) Was this helpful? --- # Single sign-on (SSO) | Overleaf Commons | Overleaf docs Overleaf Commons supports a standard SAML single sign-on (SSO) configuration. With Overleaf Commons SSO, new users can create their Overleaf accounts and enrol in the subscription (if eligible) by logging in with SSO. Users who already have an Overleaf account can link their SSO identity to their existing Overleaf account and join the subscription if eligible. We recommend that all authenticated users at an institution be authorized to log in to Overleaf, and if there are restrictions on which users should be added to the subscription, users' entitlements can be verified using data sent at log in time. Users can log in to their Overleaf accounts with SSO either through your portal page or our [main SSO login page](https://www.overleaf.com/sso-login) . [Configuring SSO](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso) [User log in options](https://docs.overleaf.com/commons/single-sign-on-sso/user-log-in-options) [SSO FAQs](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs) [PreviousGetting set up](https://docs.overleaf.com/commons/getting-set-up) [NextConfiguring SSO](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso) Last updated 3 months ago Was this helpful? Was this helpful? --- # User log in options | Overleaf Commons | Overleaf docs When SSO is enabled, there are a few login options for your users. * Log in from the Overleaf login page, which includes a link to [Log in through SSO.](https://www.overleaf.com/sso-login) When a user provides an email with a recognized domain, we will automatically direct them to the institutional SSO portal. * Log in from your Overleaf portal page, which will include a direct login link. * If your institution has a console or other login page, we can provide a link that will facilitate the login process from your side. More information for users on how to log in with SSO is provided in our [user documentation](https://www.overleaf.com/learn/how-to/Institutional_single_sign-on) . [PreviousConfiguring SSO](https://docs.overleaf.com/commons/single-sign-on-sso/configuring-sso) [NextSSO FAQs](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs) Last updated 1 year ago Was this helpful? Was this helpful? --- # SSO FAQs | Overleaf Commons | Overleaf docs ### [](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs#do-you-support-scim) Do you support SCIM? System for Cross-domain Identity Management (SCIM), is a standard for automation of user provisioning. Because your system will not be provisioning users in Overleaf, SCIM is neither supported nor required. Individual users own their Overleaf accounts, these may be provisioned by the users before joining the subscription and can be retained by them after they leave. ### [](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs#do-you-support-just-in-time-jit-provisioning-of-user-accounts) Do you support Just in Time (JIT) Provisioning of user accounts? Yes. If a user signs in via SSO and their SSO identifier does not match one in our system they can either (a) provision a new account or (b) identify an existing account under a different email that should be associated with the SSO identity. ### [](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs#do-you-support-idp-initiated-authentication-flows) Do you support IDP initiated authentication flows? No, Overleaf only directly supports SP initiated flows for authentication. We do provide a url that may be provided to your users that can simulate an IDP initiated flow. [PreviousUser log in options](https://docs.overleaf.com/commons/single-sign-on-sso/user-log-in-options) [NextUser management](https://docs.overleaf.com/commons/user-management) Last updated 1 year ago Was this helpful? * [Do you support SCIM?](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs#do-you-support-scim) * [Do you support Just in Time (JIT) Provisioning of user accounts?](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs#do-you-support-just-in-time-jit-provisioning-of-user-accounts) * [Do you support IDP initiated authentication flows?](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs#do-you-support-idp-initiated-authentication-flows) Was this helpful? --- # Your Admin Hub | Overleaf Commons | Overleaf docs Your Admin Hub displays data about users at your institution and their usage of Overleaf. Managers of the subscription can view the Admin Hub and metrics, and can invite other users to be managers. To access all these features, visit your [subscription page](https://www.overleaf.com/user/subscription) and click through the **View Admin Hub** option. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252FVKFU9QchdeDbOz7F7xFu%252Fsubscription_manager_view.png%3Falt%3Dmedia%26token%3D0ec17c53-86d5-48f9-98ec-03be55a70b09&width=768&dpr=4&quality=100&sign=a3bb4c29&sv=2) View metrics and Admin Hub from a manager's subscription page [](https://docs.overleaf.com/commons/user-management/your-admin-hub#accessing-your-user-list) Accessing your user list --------------------------------------------------------------------------------------------------------------------------- The Admin Hub allows subscription managers to download a user list file (users.csv) that provides useful information about users that are currently affiliated with the institution and who are participating in the Overleaf Commons subscription. To download a list of users, click the **Download CSV** link at the bottom of the page: ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252FomiC8BPKxXTXbEes4XFn%252Fuserdata.jpg%3Falt%3Dmedia%26token%3D05600677-e1d0-4b57-ac98-8d4e6827d507&width=768&dpr=4&quality=100&sign=bc353a96&sv=2) The user list download option on the Admin Hub page The **users.csv** file has several columns which are explained in the following sections. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#user_id) user\_id Unique ID of the user. You may notice that some user IDs appear twice in this list. This is because this list is a list of email addresses, rather than users -- therefore, users who have added more than 1 institutional email address are included more than once in the list. We refer to it as the list of users for simplicity, but please keep in mind that there may be some duplicates. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#email) email The institutional email address of the user. They may have other email addresses on their account, for example, personal ones; these will not appear in this file. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#role) role The role the user has chosen on their Account Settings page. Users can select a role from a default list, or enter their own. department The department the user has chosen on their Account Settings page. They can select a department from a default list or from a department list provided to us during onboarding, or enter their own if they wish. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#created_at) created\_at This is the date the user registered for their Overleaf account. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#last_logged_in_at) last\_logged\_in\_at This is the date they last logged in to Overleaf. Because Overleaf has five-day rolling sessions, very active users who access the service frequently from the same device may not need to log in often. Compare this value with **last\_active\_at** if you are evaluating the Overleaf usage of a particular user. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#license) license This states whether the user is entitled to and participates in the institutional subscription. For institutions without SSO enabled, all users in the CSV list are eligible for the subscription, and therefore all have a value of **TRUE** in this column. For institutions with SSO enabled, the user list may have users with either FALSE or TRUE values. Users listed as license **FALSE** will include: * Users who added their institutional email address but never linked their account via SSO. Some of these could be active but not yet linked, and others may be users who have left the institution. * Users who have linked their account via SSO but are not eligible to participate in the subscription, usually because the subscription is restricted to certain departments or schools. Users who are showing as **FALSE** may be on an individual subscription, a group subscription, or the free plan. Note that if users have multiple email addresses at the institution and use them in their Overleaf account, they can only link one email via SSO. Therefore, because this is a list of email addresses rather than user accounts, you will see their other email address(es) in this list, and since these do not entitle them to the subscription, they would have a value of **FALSE**. Users listed as license **TRUE** will be users who have linked their account via SSO and are eligible for and participating in the subscription. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#sso_identifier) sso\_identifier If SSO is enabled, this is the user's SSO identifier. This is a unique, persistent, and non-reassignable identifier that is sent to Overleaf for each user when they log in, and is used by Overleaf to look up the user account. This attribute may correspond to a particular field in your identity system, but this is opaque to Overleaf (our system is unaware of the meaning of the identifier that is sent). The field sent to Overleaf was decided in consultation with your IT services team when the subscription was set up, and it cannot be changed. #### [](https://docs.overleaf.com/commons/user-management/your-admin-hub#last_active_at) last\_active\_at This is the date the user last opened a project in Overleaf. [PreviousUser unenrollment](https://docs.overleaf.com/commons/user-management/user-unenrollment) [NextInsights and reporting](https://docs.overleaf.com/commons/insights-and-reporting) Last updated 1 year ago Was this helpful? Was this helpful? --- # User unenrollment | Overleaf Commons | Overleaf docs **Administrators do not directly unenroll users from the subscription.** This is done either by the user or automatically in a process called reconfirmation. [](https://docs.overleaf.com/commons/user-management/user-unenrollment#user-self-unenrollment) User self-unenrollment -------------------------------------------------------------------------------------------------------------------------- Users can leave an Overleaf Commons subscription without affecting the contents of their Overleaf account. All Overleaf accounts in an Overleaf Commons subscription are portable, and can freely leave the subscription to be on the free plan or to join another subscription. Users can self-unenroll from the Overleaf Commons subscription by removing their institutional email address from their Overleaf account. Removing an institutional email address will unlink the SSO login that is associated with that address. ### [](https://docs.overleaf.com/commons/user-management/user-unenrollment#primary-and-secondary-email-addresses) Primary and secondary email addresses Anyone leaving your organization or institution should make their personal email address the primary email address on their Overleaf account before they lose access to their institutional email address or SSO identity. All users on Overleaf Commons subscriptions are encouraged to add a personal email address to their Overleaf account as a secondary email address. When they leave, they should make this their primary address instead to ensure they keep access to their account. See our [user documentation](https://www.overleaf.com/learn/how-to/Managing_your_Overleaf_emails_and_login_options) for instructions on managing email addresses and login options. [](https://docs.overleaf.com/commons/user-management/user-unenrollment#reconfirmation-and-automatic-unenrollment) Reconfirmation and automatic unenrollment ---------------------------------------------------------------------------------------------------------------------------------------------------------------- The period of time between user reconfirmation prompts is configured as part of your subscription onboarding process and is usually set at 18 months. To remain enrolled in your subscription, users must periodically reconfirm their institutional affiliation, a process that also validates their eligibility for the Overleaf Commons subscription. Users who don't do this, or who are unable to reconfirm their institutional affiliation, will be removed from the subscription. Removing a user from the subscription doesn't affect their ability to access their Overleaf account, which will revert to the free plan. When a user needs to reconfirm, they will see a prompt on their Overleaf account settings page and a notification on their project dashboard. Reconfirming their institutional email address and affiliation will allow them to remain on the subscription until the next reconfirmation is required. Common user questions about reconfirmation are answered in our [user documentation](https://www.overleaf.com/learn/how-to/Institutional_Email_Reconfirmation) . ### [](https://docs.overleaf.com/commons/user-management/user-unenrollment#non-sso-reconfirmation) Non-SSO reconfirmation If you don't provide SSO, users reconfirm their affiliation by requesting that a confirmation email be sent to their affiliated email address. Their affiliation is reconfirmed by following the instructions provided in the email that is sent to them. ### [](https://docs.overleaf.com/commons/user-management/user-unenrollment#sso-reconfirmation) SSO reconfirmation For institutions that provide SSO, users automatically reconfirm their affiliation each time they log in with SSO. This means that in most cases, users never see a reconfirmation prompt because they are automatically reconfirmed with each login. [PreviousUser enrollment](https://docs.overleaf.com/commons/user-management/user-enrollment) [NextYour Admin Hub](https://docs.overleaf.com/commons/user-management/your-admin-hub) Last updated 11 months ago Was this helpful? * [User self-unenrollment](https://docs.overleaf.com/commons/user-management/user-unenrollment#user-self-unenrollment) * [Primary and secondary email addresses](https://docs.overleaf.com/commons/user-management/user-unenrollment#primary-and-secondary-email-addresses) * [Reconfirmation and automatic unenrollment](https://docs.overleaf.com/commons/user-management/user-unenrollment#reconfirmation-and-automatic-unenrollment) * [Non-SSO reconfirmation](https://docs.overleaf.com/commons/user-management/user-unenrollment#non-sso-reconfirmation) * [SSO reconfirmation](https://docs.overleaf.com/commons/user-management/user-unenrollment#sso-reconfirmation) Was this helpful? --- # Insights and reporting | Overleaf Commons | Overleaf docs You can access a metrics page that provides insights into how people are using Overleaf at your organization. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252FIg3xXvkveVaGxu3zRvh6%252Fsubscription%2520admin.png%3Falt%3Dmedia%26token%3D5118d274-2ed1-494e-9538-748c4d31a854&width=768&dpr=4&quality=100&sign=6d46435e&sv=2) [](https://docs.overleaf.com/commons/insights-and-reporting#date-ranges) Date ranges ----------------------------------------------------------------------------------------- The date range for the metrics defaults to the last 30 days, displayed by day. You can change this to any date range, displayed by day, week, or month, by clicking on the date range and selecting a new one. This option is on the top right-hand side of the Metrics page. [](https://docs.overleaf.com/commons/insights-and-reporting#understanding-the-metrics) Understanding the metrics --------------------------------------------------------------------------------------------------------------------- Each visualization on the metrics page includes a tooltip that provides more information about the displayed graph. When looking at each plot, mouse over the (?) to see tooltips. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252FYzO24XMma2uf69WRpU2y%252Foverleaf_metrics_page_tooltip.png%3Falt%3Dmedia%26token%3D727ea25b-8269-4bc9-8d44-c507170de803&width=768&dpr=4&quality=100&sign=334a6f6e&sv=2) You can also mouse over the plots for additional information and control which categories you see by clicking on the legend. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252F1A5iIyq4ilf3vB8RALfO%252Foverleaf_metrics_page_affiliations_both_on.png%3Falt%3Dmedia%26token%3Dc9006ce3-1f95-488f-99c8-46137f01f6cd&width=768&dpr=4&quality=100&sign=b0653342&sv=2) [](https://docs.overleaf.com/commons/insights-and-reporting#downloading-metrics-data) Downloading metrics data ------------------------------------------------------------------------------------------------------------------- The data provided on the metrics page can be downloaded using the **Download CSV** option on the Metrics page. The data available here is aggregate data. High-level user access data can be downloaded from the Admin Hub page ad described in [User management](https://docs.overleaf.com/commons/user-management) . ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252FomiC8BPKxXTXbEes4XFn%252Fuserdata.jpg%3Falt%3Dmedia%26token%3D05600677-e1d0-4b57-ac98-8d4e6827d507&width=768&dpr=4&quality=100&sign=bc353a96&sv=2) [](https://docs.overleaf.com/commons/insights-and-reporting#types-of-metrics-available) Types of metrics available ----------------------------------------------------------------------------------------------------------------------- Active Projects[](https://docs.overleaf.com/commons/insights-and-reporting#active-projects) This shows the number of unique Overleaf projects edited at least once in the selected time period (day, week, or month). Affiliations[](https://docs.overleaf.com/commons/insights-and-reporting#affiliations) This shows the number of unique affiliated users per time period (day, week, or month). The initial drop in users when we enable the subscription is due to the reconfirmation period, which is usually set to 18 months. Once the subscription is enabled, all users who have not logged in during the last 18 months are removed from the plot. If these users subsequently reconfirm their affiliation, they will be included in the plot again. As time goes on, inactive users (i.e. ones who have not logged in for more than 18 months) will slowly be removed from the metrics, ensuring a more accurate representation of the number of active users. [Read more about this](https://www.overleaf.com/learn/how-to/Institutional_Email_Reconfirmation) . Total Session Duration (hours)[](https://docs.overleaf.com/commons/insights-and-reporting#total-session-duration-hours) This shows the total length of editing sessions, in hours, per time period (day, week, or month). This is how long your users are spending on Overleaf. New Affiliations[](https://docs.overleaf.com/commons/insights-and-reporting#new-affiliations) This shows the number of new unique affiliated users per time period (day, week, or month). Active Users[](https://docs.overleaf.com/commons/insights-and-reporting#active-users) This shows the number of unique users that started at least one Editing Session on a given day, week, or month. An Editing Session starts when a user opens a project and lasts until there are 30 minutes of inactivity. Editing Sessions[](https://docs.overleaf.com/commons/insights-and-reporting#editing-sessions) This shows the number of editing sessions per time period (day, week, or month). An Editing Session starts when a user opens a project and lasts until there is 30 minutes of inactivity. Activity includes moving the cursor, typing, and clicking. Project Activity[](https://docs.overleaf.com/commons/insights-and-reporting#project-activity) This shows the number of projects that had at least one Editing Session within the time period (day, week, or month). The different colors show the breakdown of the total length of Editing Sessions on each of those projects over the past year. Click the dots in the legend to toggle the category display on and off. Double-click on a dot to show only that category. New Projects[](https://docs.overleaf.com/commons/insights-and-reporting#new-projects) This shows how many new projects your users created on Overleaf per time period (day, week, or month). Collaborators[](https://docs.overleaf.com/commons/insights-and-reporting#collaborators) This shows the average number of collaborators per project. Collaborator count is the number of distinct users that had at least one Editing Session during the time period (day, week, or month). To be included, at least one collaborator must belong to your institution, and projects must have had at least one Editing Session. For ‘Internal Collaborators’, only users who belong to your institution are counted. Click the dots in the legend to turn the category display on and off. Collaborations[](https://docs.overleaf.com/commons/insights-and-reporting#collaborations) This shows the number of projects that had more than one collaborator. A collaborator is a user who had at least one Editing Session during the time period. The colors represent the different numbers of collaborators. To be included, at least one collaborator must belong to your institution. Internal Collaborations[](https://docs.overleaf.com/commons/insights-and-reporting#internal-collaborations) This shows the number of projects that had more than one collaborator belonging to your institution. A collaborator is a user who had at least one Editing Session during the time period. The colors represent the different numbers of collaborators. [PreviousYour Admin Hub](https://docs.overleaf.com/commons/user-management/your-admin-hub) [NextYour Overleaf portal](https://docs.overleaf.com/commons/your-overleaf-portal) Last updated 9 months ago Was this helpful? * [Date ranges](https://docs.overleaf.com/commons/insights-and-reporting#date-ranges) * [Understanding the metrics](https://docs.overleaf.com/commons/insights-and-reporting#understanding-the-metrics) * [Downloading metrics data](https://docs.overleaf.com/commons/insights-and-reporting#downloading-metrics-data) * [Types of metrics available](https://docs.overleaf.com/commons/insights-and-reporting#types-of-metrics-available) Was this helpful? --- # Your Overleaf portal | Overleaf Commons | Overleaf docs Overleaf Commons subscription includes a customized portal page where your users can find out more and join the subscription, view relevant templates, and access help resources. During onboarding, we work with you to customize your portal with text, images, and templates for your users. Example of a custom portals can be found on our [list of participating institutions page](https://www.overleaf.com/for/institutions-using-overleaf) . Portal pages typically include these sections: an **Overview**, the **Quick Start** section, a list of **Featured Templates**, and an **FAQ & Help** section. * The **Overview** describes who the subscription is for, which could include all students and staff, or which might be restricted to a particular set of departments or roles. The Overview may state who is providing the subscription, particularly if it is sponsored by a university library or particular faculty. Overviews can optionally point to other pages hosted by the institution, which may provide additional information or reminders about information technology policies. * The portal's **Quick Start** section provides a set of links that help different kinds of users to start using the Overleaf platform. From the Quick Start page, users can start writing a paper, select a template, or access learning resources. The Quick Start section of the portal page is frequently helpful to new Overleaf users. * Overleaf Commons subscribers can optionally identify a set of **Featured Templates** for their users. These are selected templates from the Overleaf Gallery that are either specific for the institution, or of particular interest to its users. * The **FAQ & Help** section provides quick answers to common questions about the Overleaf platform or the subscription. The text and images on portal pages are decided on during the subscription onboarding process. If changes are needed to the portal page, requests for updates can be sent to [the Overleaf Success team](https://docs.overleaf.com/cdn-cgi/l/email-protection#d2a1a7b1b1b7a1a192bda4b7a0beb7b3b4fcb1bdbf) . [](https://docs.overleaf.com/commons/your-overleaf-portal#new-and-future-overleaf-commons-administrators-and-managers) New and future Overleaf Commons administrators and managers --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- As part of the subscription onboarding process, the Overleaf onboarding team will gather the information required to build your portal page and will be available to answer any questions. [](https://docs.overleaf.com/commons/your-overleaf-portal#current-overleaf-commons-administrators-and-managers) Current Overleaf Commons administrators and managers ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If any changes or updates to your portal page are required, please reach out to the [Overleaf Success team](https://docs.overleaf.com/cdn-cgi/l/email-protection#86f5f3e5e5e3f5f5c6e9f0e3f4eae3e7e0a8e5e9eb) . We are happy to help with updating images, text, or FAQs, adding templates to your portal, or any other changes that are needed. [](https://docs.overleaf.com/commons/your-overleaf-portal#faqs) FAQs ------------------------------------------------------------------------- ### [](https://docs.overleaf.com/commons/your-overleaf-portal#how-do-we-add-a-new-template-to-our-featured-templates-page) How do we add a new template to our featured templates page? All the templates on the featured templates page are hosted in the Overleaf Gallery. So the first step in adding a featured template is to ensure that it is available in the Gallery. Please follow the [instructions for publishing in the Gallery](https://www.overleaf.com/learn/how-to/Publishing_templates_and_examples_in_the_Overleaf_Gallery) , and then get in touch with Overleaf Support to let us know to add the template to your featured templates page. [PreviousInsights and reporting](https://docs.overleaf.com/commons/insights-and-reporting) [NextTroubleshooting and support](https://docs.overleaf.com/commons/troubleshooting-and-support) Last updated 11 months ago Was this helpful? * [New and future Overleaf Commons administrators and managers](https://docs.overleaf.com/commons/your-overleaf-portal#new-and-future-overleaf-commons-administrators-and-managers) * [Current Overleaf Commons administrators and managers](https://docs.overleaf.com/commons/your-overleaf-portal#current-overleaf-commons-administrators-and-managers) * [FAQs](https://docs.overleaf.com/commons/your-overleaf-portal#faqs) * [How do we add a new template to our featured templates page?](https://docs.overleaf.com/commons/your-overleaf-portal#how-do-we-add-a-new-template-to-our-featured-templates-page) Was this helpful? --- # User enrollment | Overleaf Commons | Overleaf docs [](https://docs.overleaf.com/commons/user-management/user-enrollment#user-account-provisioning) User account provisioning ------------------------------------------------------------------------------------------------------------------------------ **Users don't need to create a new Overleaf account if they already have one.** Existing Overleaf users can add institutional SSO access and join the subscription with their existing Overleaf account. Overleaf users provision their own Overleaf accounts and can either join an Overleaf Commons subscription with an existing Overleaf account or create a new account to join the subscription. People who don't already have an Overleaf account can create a new account on the main [Overleaf registration page](https://www.overleaf.com/register) or your own [Overleaf portal page](https://docs.overleaf.com/commons/your-overleaf-portal) . [](https://docs.overleaf.com/commons/user-management/user-enrollment#user-enrollment) User enrollment ---------------------------------------------------------------------------------------------------------- **Administrators do not directly enroll users in the subscription.** Users maintain their enrollment by confirming their affiliation and eligibility to participate in the subscription. Overleaf Commons enrollment is based on the user being affiliated with your organization as indicated by a confirmed organization email address. Additional entitlement criteria can be applied (to limit the subscription to specific faculties, departments, or roles) in cases where [single sign-on](https://docs.overleaf.com/commons/single-sign-on-sso) has been configured. Overleaf identifies user affiliation based on email addresses and we maintain a list of domains known to be associated with an organization to enable this. During the onboarding process, customers are asked to confirm the domains that are associated with their organization and are asked to notify Overleaf Support of any domain changes. ### [](https://docs.overleaf.com/commons/user-management/user-enrollment#non-sso-enrollment) Non-SSO enrollment If you don't provide SSO, a user's affiliation and enrollment in the subscription are based on their ability to confirm a valid organization email address. When a user adds an email address to their Overleaf account, they're sent an email and code that can be used to confirm their address. All users with a valid email address belonging to your identified domains will be able to join the subscription. Overleaf Commons subscriptions that do not use SSO can only be restricted based on email domain, no other criteria can be applied. See our [user documentation](https://www.overleaf.com/learn/how-to/Managing_your_Overleaf_emails_and_login_options) for instructions on adding email addresses to an Overleaf account. ### [](https://docs.overleaf.com/commons/user-management/user-enrollment#sso-enrollment) SSO enrollment If you have [set up SSO](https://docs.overleaf.com/commons/single-sign-on-sso) with your subscription, this is used to confirm a user's affiliation. The data that is sent with the authentication response to Overleaf will indicate if the user should be enrolled in the Commons subscription, or if their account should remain on the free plan or their own subscription. [PreviousUser management](https://docs.overleaf.com/commons/user-management) [NextUser unenrollment](https://docs.overleaf.com/commons/user-management/user-unenrollment) Last updated 1 year ago Was this helpful? * [User account provisioning](https://docs.overleaf.com/commons/user-management/user-enrollment#user-account-provisioning) * [User enrollment](https://docs.overleaf.com/commons/user-management/user-enrollment#user-enrollment) * [Non-SSO enrollment](https://docs.overleaf.com/commons/user-management/user-enrollment#non-sso-enrollment) * [SSO enrollment](https://docs.overleaf.com/commons/user-management/user-enrollment#sso-enrollment) Was this helpful? --- # User management | Overleaf Commons | Overleaf docs **Overleaf Commons subscriptions do not require any direct user management.** [Users provision and enroll](https://docs.overleaf.com/commons/user-management/user-enrollment) their own Overleaf accounts in the subscription without any intervention from the subscription managers. Overleaf Commons is a fully managed service. Users provision their own user accounts, and any changes to the subscription are facilitated by [Overleaf support](https://www.overleaf.com/contact) . An Overleaf Commons customer will designate some users at the institution to be **subscription managers**, who can access data about the subscription. An initial set of subscription managers will be designated when the subscription is set up. Existing managers can add or remove other managers from the managers list on their [Subscription page](https://www.overleaf.com/user/subscription) under "Managed institution managers." ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F4216236159-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fns44NLl1ndCqBog3i0v5%252Fuploads%252FmMachEOQfVsXlSoHxNSM%252Fadmin-hub-metrics-managers.png%3Falt%3Dmedia%26token%3D19a135fa-97cc-4290-ae52-12835e18d697&width=768&dpr=4&quality=100&sign=fdd0fc73&sv=2) Subscription managers will have access to an [Admin Hub](https://docs.overleaf.com/commons/user-management/your-admin-hub) , where you can get a snapshot of recent subscription use and download a complete user list. There are also [further insights](https://docs.overleaf.com/commons/insights-and-reporting) available on the metrics page. [](https://docs.overleaf.com/commons/user-management#understanding-how-users-join-or-leave-a-subscription) Understanding how users join or leave a subscription -------------------------------------------------------------------------------------------------------------------------------------------------------------------- The following pages will help you understand how your users enroll or unenroll from an Overleaf subscription. [User enrollment](https://docs.overleaf.com/commons/user-management/user-enrollment) [User unenrollment](https://docs.overleaf.com/commons/user-management/user-unenrollment) [Your Admin Hub](https://docs.overleaf.com/commons/user-management/your-admin-hub) [Insights and reporting](https://docs.overleaf.com/commons/insights-and-reporting) [PreviousSSO FAQs](https://docs.overleaf.com/commons/single-sign-on-sso/sso-faqs) [NextUser enrollment](https://docs.overleaf.com/commons/user-management/user-enrollment) Last updated 2 months ago Was this helpful? Was this helpful? --- # Troubleshooting and support | Overleaf Commons | Overleaf docs Your Commons subscription is a fully managed service. Your IT team shouldn't need to do any direct user management and all user support questions can be directed to [Overleaf Support.](https://www.overleaf.com/contact) [](https://docs.overleaf.com/commons/troubleshooting-and-support#answers-to-some-common-user-issues) Answers to some common user issues -------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://docs.overleaf.com/commons/troubleshooting-and-support#a-user-is-not-seeing-their-account-upgraded) A user is not seeing their account upgraded. For non-SSO subscriptions, enrollment in the subscription is based on the user confirming their email address and that email address having a domain that is recognized as part of the subscription. Users must confirm the email address on their Overleaf account to join the subscription. For SSO-based subscriptions, users must confirm their affiliation and eligibility by logging in to their Overleaf account via SSO. Users who encounter a problem in attempting to do this should [contact Overleaf Support](https://www.overleaf.com/contact) . ### [](https://docs.overleaf.com/commons/troubleshooting-and-support#a-user-is-not-receiving-an-address-confirmation-email) A user is not receiving an address confirmation email. Confirmation emails sometimes end up in a user's spam or junk folder, or in some cases may be blocked by the organization's mail server after having been incorrectly flagged as spam. Users should check any spam folders that they have access to and check with your IT Services team that they can receive emails from [\[email protected\]](https://docs.overleaf.com/cdn-cgi/l/email-protection) . Users who encounter problems here are encouraged to [contact Overleaf Support](https://www.overleaf.com/contact) . ### [](https://docs.overleaf.com/commons/troubleshooting-and-support#a-user-is-seeing-a-something-went-wrong-message-when-logging-in-with-sso) A user is seeing a "something went wrong" message when logging in with SSO. This indicates a problem in processing the SAML response for the user's authentication request. This may be a problem with particular user data or may indicate a more general problem, such as an expired certificate. Please [contact Overleaf Support](https://www.overleaf.com/contact) if this error is observed, our team will check the logs and identify the source of the problem. [PreviousYour Overleaf portal](https://docs.overleaf.com/commons/your-overleaf-portal) Last updated 1 year ago Was this helpful? * [Answers to some common user issues](https://docs.overleaf.com/commons/troubleshooting-and-support#answers-to-some-common-user-issues) * [A user is not seeing their account upgraded.](https://docs.overleaf.com/commons/troubleshooting-and-support#a-user-is-not-seeing-their-account-upgraded) * [A user is not receiving an address confirmation email.](https://docs.overleaf.com/commons/troubleshooting-and-support#a-user-is-not-receiving-an-address-confirmation-email) * [A user is seeing a "something went wrong" message when logging in with SSO.](https://docs.overleaf.com/commons/troubleshooting-and-support#a-user-is-seeing-a-something-went-wrong-message-when-logging-in-with-sso) Was this helpful? --- # Welcome | Groups | Overleaf docs **Not an admin?** If you're an Overleaf user, not an admin, you can find help in our [User docs](https://docs.overleaf.com/) . [](https://docs.overleaf.com/groups#group-standard-vs.-group-professional) Group Standard vs. Group Professional --------------------------------------------------------------------------------------------------------------------- Overleaf has two different plans for groups: Group Standard and Group Professional. In this documentation, wherever a feature is only available on Group Professional, you'll see a "Pro"![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252Ffef3sHxLViLspfQvgbhj%252Fpro%2520icon.png%3Falt%3Dmedia%26token%3De8160556-94be-4050-ab29-66e2b8b6b9f9&width=49&dpr=4&quality=100&sign=7d5756d7&sv=2) icon to indicate this. ![Cover](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FZiBdHFZcW8bjQpVrJNDT%252Fgroup.svg%3Falt%3Dmedia%26token%3De287bf27-7085-4d2a-84a7-cb9ee95bd61c&width=752&dpr=4&quality=100&sign=b7f42ed7&sv=2) **Group Standard** For teams and small departments. Premium features for all group members, including real-time track changes, project history, and much more. ![Cover](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FILtwJ8YBHOWGqjtiOP4o%252Fgroup-add.svg%3Falt%3Dmedia%26token%3D03c6985a-1dde-46a6-a288-96eddc76e2fe&width=752&dpr=4&quality=100&sign=6bc338a2&sv=2) **Group Professional** All the benefits of our Group Standard plan, plus: * Single Sign On (SSO) * Managed User Accounts * Unlimited collaborators per project [Find out more about our plans »](https://www.overleaf.com/user/subscription/plans) [](https://docs.overleaf.com/groups#quick-links) Quick links ----------------------------------------------------------------- [How to create a group](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group) [Renewing a subscription](https://docs.overleaf.com/groups/subscription-management/renewing-a-subscription) [FAQs](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them) [NextHow to create a group](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group) Last updated 19 days ago Was this helpful? * [Group Standard vs. Group Professional](https://docs.overleaf.com/groups#group-standard-vs.-group-professional) * [Quick links](https://docs.overleaf.com/groups#quick-links) Was this helpful? --- # How to create a group | Groups | Overleaf docs 1 ### [](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group#buy-a-group-subscription) Buy a group subscription It's important to note that the person who buys the group subscription is set as the admin for the group. You can give other members manager privileges, but there is only one admin. See [Roles and permissions](https://docs.overleaf.com/groups/user-management/roles-and-permissions) . To create a group on Overleaf, you’ll just need to purchase a group subscription. You can explore the available subscription options on the [Overleaf Plans page](https://www.overleaf.com/plans) . These plans cater to different team sizes and needs, offering flexibility whether you're a small group or a large organization. For organizations that require a purchase order (PO), please note there is a minimum requirement of **5 user seats** to qualify. Payments can be made via debit/credit card or PayPal for smaller groups or teams. If you need a custom number of seats, or help with a PO, please [contact Overleaf](https://www.overleaf.com/contact) . Our team will be able to help you tailor a solution that fits your specific requirements. 2 ### [](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group#manage-your-group-within-overleaf) Manage your group within Overleaf To invite users to your group and manage your group settings, visit the [Subscription page](https://overleaf.com/user/subscription) . The following links will help you with the initial setup: * [Accessing your admin](https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account) [settings](https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account) * [How to add and remove users](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) [PreviousWelcome](https://docs.overleaf.com/groups) [NextAccessing your admin settings](https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account) Last updated 1 month ago Was this helpful? * [Buy a group subscription](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group#buy-a-group-subscription) * [Manage your group within Overleaf](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group#manage-your-group-within-overleaf) Was this helpful? --- # Accessing your admin settings | Groups | Overleaf docs As the admin of your Overleaf group, you can access a range of features and settings that allow you to manage your subscription and users effectively. To access your subscription admin, log in to Overleaf and navigate to the [Subscription page](https://overleaf.com/user/subscription) . You can find this by clicking the **Account** button when logged in to Overleaf. From the **Subscription** page you'll be able to: * Manage group members, including [adding and removing users](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) . * [Manage roles and permissions](https://docs.overleaf.com/groups/user-management/roles-and-permissions) * Manage group settings—including [SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) and [Managed Users](https://docs.overleaf.com/groups/user-management/managed-user-accounts) for Pro groups * Monitor and download usage metrics [PreviousHow to create a group](https://docs.overleaf.com/groups/getting-started/how-to-create-a-group) [NextAdding and removing users and managers](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) Last updated 11 months ago Was this helpful? Was this helpful? --- # Buying more licenses and upgrading | Groups | Overleaf docs [](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading#how-do-i-buy-more-licenses-for-my-group-subscription) How do I buy more licenses for my group subscription? ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Only the group administrator can buy more licenses for a group subscription. When an administrator does buy more licenses for the group, an invoice will be generated automatically and emailed to the administrator when the transaction is completed. If you are a group administrator, to purchase additional licenses click the **Buy more licenses** button. After entering the number of licenses you want to purchase, you'll see a preview of the cost. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FNpEuOJsRa7fpqMIqR3V9%252Fimage_flexible_licensing.png%3Falt%3Dmedia%26token%3Dc52fe2e0-7a9b-4188-ad56-248cc7f626dd&width=768&dpr=4&quality=100&sign=317ed684&sv=2) [](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading#how-do-i-upgrade-my-group-subscription-from-standard-to-professional) How do I upgrade my group subscription from Standard to Professional? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Only the administrator of a group can upgrade the plan. When an admin upgrades their group, an invoice will be generated automatically and emailed to the lead administrator when the transaction is completed. If you are a group administrator, you can upgrade from a Standard group to a Professional group by clicking **Upgrade Plan**. A cost preview will be provided before you confirm the upgrade. Please note that only group subscriptions that were purchased on the Overleaf website can upgrade directly from a Standard plan to a Professional plan using this option. Please [contact us](https://www.overleaf.com/contact) if you wish to upgrade the group you administer and do not see this option available to you. [](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading#i-dont-see-the-option-to-add-licenses-or-upgrade-what-should-i-do) I don't see the option to add licenses or upgrade, what should I do? ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Some administrators may not see the upgrade and add license options described here. This can happen if the group was not purchased through the Overleaf website. If you are the administrator of a group and do not see these options, please [get in touch](https://www.overleaf.com/contact) and let us now how you would like to update your group subscription. [PreviousGroup subscription audit logs](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs) [NextRoles and permissions](https://docs.overleaf.com/groups/user-management/roles-and-permissions) Last updated 7 months ago Was this helpful? * [How do I buy more licenses for my group subscription?](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading#how-do-i-buy-more-licenses-for-my-group-subscription) * [How do I upgrade my group subscription from Standard to Professional?](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading#how-do-i-upgrade-my-group-subscription-from-standard-to-professional) * [I don't see the option to add licenses or upgrade, what should I do?](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading#i-dont-see-the-option-to-add-licenses-or-upgrade-what-should-i-do) Was this helpful? --- # Controlling feature availability | Groups | Overleaf docs Subscription administrators can request that certain Overleaf features be disabled or enabled for members of their subscription. In order to request a change in availability of any of the features described on this page, please [get in touch](https://www.overleaf.com/contact) with our support team. Feature Default behaviour Notes **Overleaf Chat** **enabled** for all groups Overleaf Chat is a standard feature that is available to all Overleaf users unless disablement is requested by the group administrator. **AI Assist** **enabled** at the free level by default for all groups that have not enabled Managed Users **disabled** for Professional groups with Managed Users AI Assist features have both free and premium tiers. When enabled at the group level, the free tier is available to all group members. Only members who have subscribed to the AI Assist add-on can use the premium AI Assist features. **Dropbox Synchronization** **enabled** for all groups Dropbox Synchronization is a premium feature that is available on all group plans unless disablement is requested by the group administrator. [PreviousRoles and permissions](https://docs.overleaf.com/groups/user-management/roles-and-permissions) [NextManaged Users](https://docs.overleaf.com/groups/user-management/managed-user-accounts) Last updated 5 months ago Was this helpful? Was this helpful? --- # Group metrics | Groups | Overleaf docs [](https://docs.overleaf.com/groups/user-management/group-metrics#view-group-metrics) View group metrics ------------------------------------------------------------------------------------------------------------- To view Group Metrics, click the **View Metrics** link. The date range for the metrics defaults to the last 30 days, displayed by day. You can change this to any date range, displayed by day, week, or month, by clicking on the date. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FtEjPtI3lv5IspgqGADdy%252FRyangroup5.png%3Falt%3Dmedia%26token%3D5bc43e5c-1d98-4daa-8678-83c84f9564d8&width=768&dpr=4&quality=100&sign=5d0372a1&sv=2) Please mouse over the **(?)** for tooltips, and mouse over the graphs for additional information. Use the **Download CSV** button at the top of the page to download the data behind the graphs. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252F8IKpWLYOF1gfnYINXu5U%252FRyangroup6.png%3Falt%3Dmedia%26token%3D5810941b-8d6c-4be7-8e0e-cdc4999a4162&width=768&dpr=4&quality=100&sign=ff46840c&sv=2) [](https://docs.overleaf.com/groups/user-management/group-metrics#visualizations) Visualizations ----------------------------------------------------------------------------------------------------- ### [](https://docs.overleaf.com/groups/user-management/group-metrics#active-projects) Active Projects This plot shows the number of unique Overleaf projects edited at least once by users in your group during the time period selected (day, week or month). ### [](https://docs.overleaf.com/groups/user-management/group-metrics#total-session-duration) Total Session Duration This plot shows the total length of editing sessions, in hours, per time period (day, week or month). This is how long the users in your group are spending on Overleaf. ### [](https://docs.overleaf.com/groups/user-management/group-metrics#active-users) Active Users This plot shows the number of unique users within your group that started at least one Editing Session on a given day, week, or month. An Editing Session starts when a user opens a project, and lasts until there is 30 minutes of inactivity. ### [](https://docs.overleaf.com/groups/user-management/group-metrics#project-activity) Project Activity This plot shows the number of projects with at least one Editing Session. The different colours show the breakdown of the total length of Editing Sessions on each of those projects over the past year. Click the dots in the legend to toggle on/off the display of the category. Double click a dot to show only that category. ### [](https://docs.overleaf.com/groups/user-management/group-metrics#editing-sessions) Editing Sessions An Editing Session starts when a user in your group opens a project, and lasts until there's 30 minutes of inactivity. Activity includes moving the cursor, typing and clicking. This plot shows the number of editing sessions per time period (day, week or month). ### [](https://docs.overleaf.com/groups/user-management/group-metrics#new-projects) New Projects This plot shows how many new projects the users in your group created on Overleaf per time period (day, week or month). ### [](https://docs.overleaf.com/groups/user-management/group-metrics#collaborators) Collaborators This plot displays the average number of collaborators per project. Collaborator count is the number of distinct users that had at least one Editing Session during the time period (day, week or month). To be included, at least one collaborator must belong to your group, and projects must have had at least one Editing Session. Internal collaborators are those who are part of the same group. Click the dots in the legend to toggle on/off the display of the category. ### [](https://docs.overleaf.com/groups/user-management/group-metrics#collaborations) Collaborations This plot shows the number of projects that had more than one collaborator. A collaborator is a user that had at least one Editing Session during the time period. The colours represent the different number of collaborators. To be included, at least one collaborator must belong to your group. ### [](https://docs.overleaf.com/groups/user-management/group-metrics#internal-collaborations) Internal Collaborations This shows the number of projects that had more than one collaborator belonging to your group. A collaborator is a user that had at least one Editing Session during the time period. The colours represent the different number of collaborators [PreviousAdding and removing users and managers](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) [NextGroup subscription audit logs](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs) Last updated 7 months ago Was this helpful? * [View group metrics](https://docs.overleaf.com/groups/user-management/group-metrics#view-group-metrics) * [Visualizations](https://docs.overleaf.com/groups/user-management/group-metrics#visualizations) * [Active Projects](https://docs.overleaf.com/groups/user-management/group-metrics#active-projects) * [Total Session Duration](https://docs.overleaf.com/groups/user-management/group-metrics#total-session-duration) * [Active Users](https://docs.overleaf.com/groups/user-management/group-metrics#active-users) * [Project Activity](https://docs.overleaf.com/groups/user-management/group-metrics#project-activity) * [Editing Sessions](https://docs.overleaf.com/groups/user-management/group-metrics#editing-sessions) * [New Projects](https://docs.overleaf.com/groups/user-management/group-metrics#new-projects) * [Collaborators](https://docs.overleaf.com/groups/user-management/group-metrics#collaborators) * [Collaborations](https://docs.overleaf.com/groups/user-management/group-metrics#collaborations) * [Internal Collaborations](https://docs.overleaf.com/groups/user-management/group-metrics#internal-collaborations) Was this helpful? --- # Adding and removing users and managers | Groups | Overleaf docs Administrators and managers of groups are not included in the count of your total users unless they've also added themselves as a member of the group. Administrators and managers who want premium features applied to their accounts must add themselves as group members. [](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#adding-users) Adding users --------------------------------------------------------------------------------------------------------------- If any of the users you add have personal Overleaf subscriptions, please let them know they’ll need to cancel their plans if they no longer want to be charged for them. To access group member management, click **Manage Members** on the [Subscription p](https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account) [age](https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account) . * To add a single user to the group, enter the user’s email address in the **Add more members** field. Then, click **Add**. * To add multiple users, copy and paste a list of email addresses separated by commas. Then, click **Add**. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252Fgit-blob-066b849f2dd46d2cfbfc71d1be2008a3b6e41fcd%252Fadd_members.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=1885c06d&sv=2) [](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#removing-users) Removing users ------------------------------------------------------------------------------------------------------------------- To remove users, tick the box next to the email address(es) of the user(s) you wish to remove, then click **Remove from group**. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252Fgit-blob-c94381d7402718510a0ffcdd389057efdbfde23e%252Fremove_members.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=c63501ff&sv=2) [](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#exporting-a-list-of-users) Exporting a list of users ----------------------------------------------------------------------------------------------------------------------------------------- To download a list of group members, click **Export to CSV**. [](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#add-and-remove-group-managers) Add and remove group managers ------------------------------------------------------------------------------------------------------------------------------------------------- To access group manager management, click the **Manage Group Managers** link. Use the same steps to add and remove group managers as you did to add and remove group members. Group Managers must be current Overleaf account holders. All Group Managers have the same ability to manage users, view metrics, and add and remove managers. Managers do not need to be members, so do not necessarily consume a license. There is only one Group Admin. This is the person who owns the group subscription and receives billing notices and metrics emails. Please contact us at [\[email protected\]](https://docs.overleaf.com/cdn-cgi/l/email-protection#f2818782829d8086b29d8497809e979394dc919d9f) if you need to change the Group Admin. [PreviousAccessing your admin settings](https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account) [NextGroup metrics](https://docs.overleaf.com/groups/user-management/group-metrics) Last updated 7 months ago Was this helpful? * [Adding users](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#adding-users) * [Removing users](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#removing-users) * [Exporting a list of users](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#exporting-a-list-of-users) * [Add and remove group managers](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users#add-and-remove-group-managers) Was this helpful? --- # Roles and permissions | Groups | Overleaf docs **Role** **Permissions** **Admin** * Overall responsibility for the group, including billing. * Can add and remove members and managers. * Can view group metrics. * Can set up Group SSO (Pro plans only) * Can set up Managed Users (Pro plans only) * Does **not** automatically receive a premium subscription. * Must add themselves as a group member to access premium features. **Group manager** * Can add and remove members and managers. * Can view group metrics. * Does **not** automatically receive a premium subscription. * Must add themselves as a group member to access premium features. **Group member** * Automatically receives access to premium features (either Standard or Professional, depending on the group type). [PreviousBuying more licenses and upgrading](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading) [NextControlling feature availability](https://docs.overleaf.com/groups/user-management/controlling-feature-availability) Last updated 6 months ago Was this helpful? Was this helpful? --- # Group subscription audit logs | Groups | Overleaf docs Group subscription administrators can access and download logs of key subscription lifecycle events. These audit logs can assist with troubleshooting subscription level issues, providing information about single sign-on (SSO) enablement, user enrolment, and other high-level subscription lifecycle events. [](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#accessing-the-audit-logs) Accessing the audit logs ----------------------------------------------------------------------------------------------------------------------------------------- Group subscription audit logs can be accessed by the group administrator from their [subscription page](https://www.overleaf.com/user/subscription) . ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252F1N9kp3GyOAP8Y5rri5Ye%252Fgroup%2520logs.png%3Falt%3Dmedia%26token%3D203b496f-8a16-4f6f-9e97-9641b9c607af&width=768&dpr=4&quality=100&sign=a8b7d8de&sv=2) All available logs can be exported in CSV format within a .zip file. Each page (of 100 log entries) will be saved as a separate file, with a timestamp as the file name. ### [](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#group-audit-logs-list-of-events) Group audit logs - list of events The following is the list of events logged in the Group Audit Log view Events for all groups (managed and non-managed)[](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#events-for-all-groups-managed-and-non-managed) Enable SSO Disable SSO Valid SSO config test Delete SSO config Enroll in managed users Join group Leave group AI Features enabled AI Features disabled Dropbox enabled Dropbox disabled Chat enabled Chat disabled Enable domain capture Disable domain capture Billing details updated Group invite sent User Events[](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#user-events) These events are displayed only to admins in managed groups. **Event** Login Reset password Update password Link Dropbox Unlink Dropbox Link Github Unlink Github Delete account Leave group subscription Link Mendeley Unlink Mendeley Link Zotero Unlink Zotero Link Papers Unlink Papers Project Events[](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#project-events) These events are displayed only to admins in managed groups. **Event** **Details** Accept invite projectId Send invite projectId inviteId role (Viewer, Editor, Reviewer) Project created projectId Project deleted projectId Project archived projectId Project unarchived projectId Project trashed projectId Project untrashed projectId Project restored projectId Project cloned projectId Transfer ownership projectId previousOwner newOwner [PreviousGroup metrics](https://docs.overleaf.com/groups/user-management/group-metrics) [NextBuying more licenses and upgrading](https://docs.overleaf.com/groups/user-management/buying-more-licenses-and-upgrading) Last updated 16 days ago Was this helpful? * [Accessing the audit logs](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#accessing-the-audit-logs) * [Group audit logs - list of events](https://docs.overleaf.com/groups/user-management/group-subscription-audit-logs#group-audit-logs-list-of-events) Was this helpful? --- # Setting up Group SSO | Groups | Overleaf docs **Group SSO is available to Overleaf Group Professional subscribers only** and can be used together with [user management features](https://docs.overleaf.com/groups/user-management/managed-user-accounts) that are also included in the [Group Professional plan](https://www.overleaf.com/user/subscription/plans#view=group) . Overleaf Group single sign-on (SSO) allows your team members to easily and securely log in to their Overleaf account, authenticating with your Identity Provider (IdP). Our group SSO uses SAML 2.0, allowing it to integrate with a wide variety of Identity Providers (IdPs), including Microsoft Entra/Azure, Okta, Shibboleth, Jumpcloud, and many others. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso#how-to-set-up-group-sso) How to set up Group SSO -------------------------------------------------------------------------------------------------------------------------------------------- [Plan for success](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/plan-for-success) [Step 1: Add Overleaf to your Identity Provider](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider) [Step 2: Configure your SSO settings with IdP metadata](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata) [Step 3: Verify the connection between your IdP and Overleaf](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf) [Step 4: Enable SSO for your team](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-4-enable-sso-for-your-team) [PreviousManaged Users](https://docs.overleaf.com/groups/user-management/managed-user-accounts) [NextPlan for success](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/plan-for-success) Last updated 1 year ago Was this helpful? Was this helpful? --- # Updating billing information | Groups | Overleaf docs Keeping your billing information up-to-date ensures uninterrupted access to your Overleaf subscription. You can easily update your payment details or billing information through your account settings. [](https://docs.overleaf.com/groups/subscription-management/updating-billing-information#how-to-update-your-billing-information) How to update your billing information ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Sign in to your Overleaf account** Go to [Overleaf](https://www.overleaf.com/) and log in to your account. 2. **Navigate to the Subscription page** Visit your [Subscription page](https://www.overleaf.com/user/subscription) to view and manage your subscription details. 3. **Edit payment information** * If you’re paying via credit/debit card or PayPal: * Click on the **Update your billing details** button. * Enter your new payment details and save your changes. * For manually billed accounts (such as Purchase Orders), please contact the [Overleaf Support Team](https://www.overleaf.com/contact) to update your billing details. 4. **Verify your changes** After updating your information, check that your subscription status is active and the next billing date is correctly listed on your [Subscription page](https://www.overleaf.com/user/subscription) . [PreviousSwitching plans](https://docs.overleaf.com/groups/subscription-management/switching-plans) [NextAccessing invoices and receipts](https://docs.overleaf.com/groups/subscription-management/accessing-invoices-and-receipts) Last updated 11 months ago Was this helpful? Was this helpful? --- # Renewing a subscription | Groups | Overleaf docs Most Overleaf subscriptions are set to automatically renew at the end of their term. You can check the status of your subscription by visiting your [Subscription page](https://www.overleaf.com/user/subscription) while signed in to your Overleaf account. If your subscription has ended, you can start a new subscription by visiting the [Plans page](https://www.overleaf.com/plans) . For subscriptions that are manually billed, our Success team will usually reach out to remind you about the renewal process and assist with any required steps. [PreviousGroup SSO FAQs](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs) [NextSwitching plans](https://docs.overleaf.com/groups/subscription-management/switching-plans) Last updated 1 year ago Was this helpful? Was this helpful? --- # Plan for success | Groups | Overleaf docs Before you set up Overleaf group SSO, make sure you can **answer, "yes," to the following questions.** 1. **Are you the administrator of an Overleaf Group Professional plan?** If you're not the administrator, you'll need to work with the administrator to set up SSO. Only the administrator of the group can access the SSO configuration page. 2. **Do you have access to your organization’s Identity Provider (IdP)?** To complete the SSO configuration, you'll need to set up Overleaf as an application in your IdP and obtain some configuration information from your IdP to complete the setup in Overleaf. If you don't have direct access to your IdP, you will need to work with someone who does (likely a member of your Information Technology (IT) services team). 3. **Do you have a high-level understanding of SAML-based SSO?** While this documentation provides step-by-step instructions, it's not a tutorial on SAML-based SSO. For a better understanding of the concepts mentioned here, you may wish to consult additional tutorials and documentation. [PreviousSetting up Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) [NextStep 1: Add Overleaf to your Identity Provider](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider) Last updated 1 year ago Was this helpful? Was this helpful? --- # Accessing invoices and receipts | Groups | Overleaf docs Overleaf makes it easy to access invoices for your subscription payments. You can view, download, and manage all billing documents directly from your account. [](https://docs.overleaf.com/groups/subscription-management/accessing-invoices-and-receipts#how-to-access-your-invoices) How to access your invoices --------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Sign in to your Overleaf account** Visit [Overleaf](https://www.overleaf.com/) and log in to your account. 2. **Go to the Subscription page** Navigate to your [Subscription page](https://www.overleaf.com/user/subscription) , where you can view your subscription details. 3. **View your invoices** * Click on the **View your invoices** button. * Here, you’ll find a list of past payments, including invoices. * Click on the invoice you wish to view or download. 4. **Download or print a copy** Click the **Print** or **PDF** button on the invoice page. **If your subscription is manually billed** (for example, via Purchase Order), invoices will be sent to the designated billing contact via email. For any issues or if you need additional copies, please contact the [Overleaf Support Team](https://www.overleaf.com/contact) . [](https://docs.overleaf.com/groups/subscription-management/accessing-invoices-and-receipts#remember) Remember: -------------------------------------------------------------------------------------------------------------------- * Ensure your [billing information is up to date](https://docs.overleaf.com/groups/subscription-management/updating-billing-information) for seamless subscription renewals. * If you need help understanding an invoice, or if there are discrepancies, contact our [Support team](https://www.overleaf.com/contact) . [PreviousUpdating billing information](https://docs.overleaf.com/groups/subscription-management/updating-billing-information) [NextFAQs](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them) Last updated 11 months ago Was this helpful? * [How to access your invoices](https://docs.overleaf.com/groups/subscription-management/accessing-invoices-and-receipts#how-to-access-your-invoices) * [Remember:](https://docs.overleaf.com/groups/subscription-management/accessing-invoices-and-receipts#remember) Was this helpful? --- # Step 1: Add Overleaf to your Identity Provider | Groups | Overleaf docs [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#add-overleaf-to-your-identity-provider) Add Overleaf to your Identity Provider ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ For your Identity Provider (IdP) to recognize Overleaf as a trusted service, you must set up Overleaf as a Service Provider (SP). This involves taking information from Overleaf’s SAML metadata and providing it as part of a service definition within your IdP. In some IdPs, this process is referred to as _adding an application_ or _configuring a resource_. Whether this is called adding or configuring a service provider, application, or resource, the process involves taking Overleaf’s metadata and providing it to your IdP by uploading it or pasting it into provided fields. This requires you to log in to your IdP and update its configuration. If you do not have access to your IdP, you will likely have to work with a member of your IT Services team to complete this step. If your IT team requires some information about security and privacy, please note that Overleaf, as part of Digital Science & Research Solutions Limited, is certified in compliance with ISO/IEC 27001:2013 (Information Security Management System). Please see our [Security Overview](https://www.overleaf.com/legal#Security) and [Privacy Notice](https://www.overleaf.com/legal#Privacy) , and if more information is needed, please [contact us](https://www.overleaf.com/contact) . [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#add-overleafs-metadata-in-your-idp) **Add Overleaf’s metadata in your IdP** --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To complete this step, you'll need to provide information about Overleaf to your Identity provider. This usually involves creating an application in your system for Overleaf, and uploading or copying some of the data from Overleaf’s SAML metadata file. Some IdPs allow you to complete a part of the service provider configuration by uploading an XML file that contains the SAML metadata, or by providing a URL to the metadata file. If those options are available, you can provide the XML file provided at this URL: [https://www.overleaf.com/saml/group-sso/meta](https://www.overleaf.com/saml/group-sso/meta) . You can also download the Overleaf Group Professional metadata from your Group subscription settings. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F79z0yOfFaLuqK8XWI2QEoc%2Ff164e73cf61bb9c6302a68322edfca05%2Fsso-config.png&width=768&dpr=4&quality=100&sign=b509bcd0&sv=2) Note that the Overleaf metadata used to set up SSO for your team is not the same metadata that is published for higher-education consumers in UKAMF, Edugain, and other federations. Please be sure to use the metadata described here, and not metadata obtained from these federated sources. Overleaf supports a Service Provider initiated SSO login process. Some IdPs allow you to configure an Identity Provider initiated login process. This isn't supported for logging in to Overleaf. The following data from the Overleaf SAML metadata can also be directly added to the Overleaf service definition in your IdP. Name Value Notes entityID [https://www.overleaf.com/saml/group-sso/meta](https://www.overleaf.com/saml/group-sso/meta) This value is found in the entityID attribute of the EntityDescriptor element in the Overleaf group SAML metadata file The entityID is a unique identifier for the Overleaf Group SSO service. Some IdPs refer to this as the Audience URI, the Service Provider Issuer, the Audience Restriction, or the Relying Party Trust Identifier. SAML signing certificate or X509 Certificate This value is the X509Certificate element in the Overleaf group SAML metadata file. Your (IdP) uses the Overleaf SAML signing certificate to verify the signature sent by Overleaf within its SAML authentication request. This is sometimes referred to as the Signature Certificate, or Verification Certificate. Assertion Consumer Service (ACS) endpoint https://www.overleaf.com/saml/group-sso/callback This value is the Location attribute of the AssertionConsumerService element in the Overleaf group SAML metadata file. This is the endpoint that your IdP will post SAML responses to. This URL is also known as the Single sign-on URL, the destination, recipient, callback URL, reply URL, or SAML Assertion Endpoint. Other information about Overleaf that your IdP may request can include optional configuration of IDP-initiated logins and single log out. These are not currently supported. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#release-claims-to-the-overleaf-service) **Release claims to the Overleaf service** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You will need to send some data to Overleaf when users are authenticated. In some cases, your IdP may have existing attribute release policies or may offer the option to release all claims. Overleaf only requires a minimal set of data to be released. ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#unique-identifier) unique identifier Overleaf only requires one attribute: a unique, persistent, and non-reassignable identifier. We recommend a non-email unique identifier, as emails are not always persistent and often change when a user’s first or last name changes. A unique identifier (system id) that is formatted as an email is acceptable if it is unique, persistent, and non-reassignable. This unique identifier is used by Overleaf to look up each user’s Overleaf account when they log in. In some cases, this is a UUID or System ID. End users will not see this Unique Identifier—it is used behind the scenes during the login process. When using Overleaf, users will identify their accounts using the primary email address that they register with Overleaf, but when logging in with SSO, it is actually the Unique Identifier that is used by the system to identify them. The unique identifier can be released as the NameID or can be released under any attribute name. Make a note of the attribute name for the unique identifier claim that is being released. You will need to provide this name to Overleaf in [Step 2](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata) . ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#first-and-last-name-attributes) first and last name attributes The optional first and last name attributes will be used by Overleaf to fill in the Account Settings of users who register for Overleaf accounts by signing in through SSO. Make a note of the attribute names for the first and last name claims that are being released. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#authorize-access-to-the-overleaf-service) **Authorize access to the Overleaf Service** -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You must authorize access to the Overleaf service for at least one user that will be used to test the SSO trust relationship and attribute release. You can choose to authorize all your team members at this point, or this can be done later. Users who are authorized to access Overleaf through Group SSO must also be invited to the group subscription on the Overleaf side. The test user does not need to be invited to the Overleaf group subscription. Any valid user account in your IdP can be used to test the SSO setup in Overleaf. No data will be saved for this test account, and no Overleaf account will be created for the test user during the testing phase. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#save-the-idp-saml-metadata) **Save the IdP SAML metadata** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You will need to provide metadata from your IdP to Overleaf in [Step 2](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata) . Some IdPs generate specific metadata for each Service Provider, while some use common endpoints and certificates for all Service Providers. In many cases IdP SAML metadata is provided in the form of an XML file. Overleaf will require the single sign-on service HTTP Redirect location and the signing certificate used by your IdP for Overleaf in [Step 2](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata) . [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#how-did-it-go-checklist-for-add-overleaf-to-your-identity-provider) **How did it go? Checklist for “Add Overleaf to your Identity Provider”** --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Overleaf SAML metadata was used to add Overleaf as a service provider in the IdP. * A unique identifier was released as a claim to Overleaf, and the attribute name for this has been recorded. * The first and last name attributes were also released, and the attribute names have been recorded (optional). * At least one test user has been authorized to access the Overleaf service. * The IdP SAML metadata has been saved so this can be added to Overleaf. This may be an XML file, or it may be the Single Sign on HTTP-Redirect endpoint and the signing certificate used by the IdP. [PreviousPlan for success](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/plan-for-success) [NextStep 2: Configure your SSO settings with IdP metadata](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata) Last updated 1 month ago Was this helpful? * [Add Overleaf to your Identity Provider](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#add-overleaf-to-your-identity-provider) * [Add Overleaf’s metadata in your IdP](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#add-overleafs-metadata-in-your-idp) * [Release claims to the Overleaf service](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#release-claims-to-the-overleaf-service) * [unique identifier](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#unique-identifier) * [first and last name attributes](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#first-and-last-name-attributes) * [Authorize access to the Overleaf Service](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#authorize-access-to-the-overleaf-service) * [Save the IdP SAML metadata](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#save-the-idp-saml-metadata) * [How did it go? Checklist for “Add Overleaf to your Identity Provider”](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider#how-did-it-go-checklist-for-add-overleaf-to-your-identity-provider) Was this helpful? --- # Linking users to Group SSO | Groups | Overleaf docs Each user needs to complete the actual linking process individually, but group administrators need to make sure that everything is ready for users to do this. 1. Check that your users have identities in your Identity Provider, and that your users are authorized to use the Overleaf application that has been defined in your IdP. 2. Set up SSO for your group following [our detailed guide](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) . 3. Enable SSO for your group in your Group subscription settings. 4. Make sure that your users are [added as group members.](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) Once SSO is enabled for your group, existing group members will receive an email notification letting them know to log in and link their SSO identities to their Overleaf accounts. Once a user has linked their SSO identity to their Overleaf account, they can use the Overleaf SSO page to log in to their account. Providing their Overleaf primary email address at the Overleaf SSO page will redirect them to your IdP’s login. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/linking-users-to-group-sso#making-sso-an-exclusive-login-option) Making SSO an exclusive login option ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you're the administrator of a Group Professional plan that has [enabled Managed Users](https://www.overleaf.com/learn/how-to/User_Management_in_Overleaf) , then turning on SSO will make it the exclusive login option for users in your group (provided their account is managed). [PreviousStep 4: Enable SSO for your team](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-4-enable-sso-for-your-team) [NextMaintaining Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso) Last updated 1 year ago Was this helpful? Was this helpful? --- # Switching plans | Groups | Overleaf docs If you need to change your Overleaf plan, you can switch to a different plan that better fits your needs. Whether you're upgrading to access additional features or downgrading to a smaller plan, the process is straightforward with the help of our Support and Sales teams. [](https://docs.overleaf.com/groups/subscription-management/switching-plans#options-for-switching-plans) Options for switching plans ----------------------------------------------------------------------------------------------------------------------------------------- * **Upgrade your plan**: Move to a plan with more features or seats, such as upgrading from a Standard to a Professional plan, or adding additional licenses. * **Downgrade your plan**: Switch to a plan with fewer features or seats if your current plan no longer meets your requirements. [](https://docs.overleaf.com/groups/subscription-management/switching-plans#how-to-switch-plans) How to switch plans ------------------------------------------------------------------------------------------------------------------------- To switch plans, please [contact the Overleaf team](https://www.overleaf.com/contact) . Our team can assist you with: 1. Identifying the best plan for your needs. 2. Managing the transition from your current plan to the new plan. 3. Ensuring any billing adjustments are handled appropriately. ### [](https://docs.overleaf.com/groups/subscription-management/switching-plans#remember-that) Remember that: * Plan changes will usually take effect immediately. * If you're in the middle of a subscription term, the cost of the new plan will be pro-rated based on the remaining time of your current plan. * If you're switching to a manually billed subscription, additional steps may be required. Our team will advise you on this. [PreviousRenewing a subscription](https://docs.overleaf.com/groups/subscription-management/renewing-a-subscription) [NextUpdating billing information](https://docs.overleaf.com/groups/subscription-management/updating-billing-information) Last updated 11 months ago Was this helpful? * [Options for switching plans](https://docs.overleaf.com/groups/subscription-management/switching-plans#options-for-switching-plans) * [How to switch plans](https://docs.overleaf.com/groups/subscription-management/switching-plans#how-to-switch-plans) * [Remember that:](https://docs.overleaf.com/groups/subscription-management/switching-plans#remember-that) Was this helpful? --- # Step 4: Enable SSO for your team | Groups | Overleaf docs When you have finished the configuration steps and have completed a successful test, you can return to your subscription’s settings page and enable SSO. You can also wait and enable SSO later. Once SSO is enabled, your team members will receive emails that include a link for them to follow that will allow them to connect their Overleaf account to their SSO identity in your IdP. If they are already logged in to Overleaf, they will see a notification in their Overleaf dashboard letting them know that they can now connect and log in with SSO. More information for your team members can be found on our [login documentation page](https://www.overleaf.com/learn/how-to/Managing_your_Overleaf_emails_and_login_options) . If your team members are managed users, you may want to share our [information for managed users](https://www.overleaf.com/learn/how-to/Understanding_Managed_Overleaf_Accounts) . [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-4-enable-sso-for-your-team#how-did-it-go-checklist-for-enable-sso) **How did it go? Checklist for “Enable SSO”** ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * SSO has been enabled. * Documentation links have been shared with your team. [PreviousGroup SSO test troubleshooting](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting) [NextLinking users to Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/linking-users-to-group-sso) Last updated 1 year ago Was this helpful? Was this helpful? --- # Group SSO FAQs | Groups | Overleaf docs What kind of SSO do you support?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#what-kind-of-sso-do-you-support) Overleaf offers a standard SAML-based SSO integration. How do I set it up?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#how-do-i-set-it-up) If you’re the administrator of an Overleaf Group Professional subscription, group SSO is one of the optional features you can turn on for your group. To set up group SSO your users must be set up in an Identity Provider (IdP) that supports SAML 2.0, and you must be able to add Overleaf as a Service Provider in your IdP. See the [Setting up Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) guide for the steps to follow. Do you support Just in Time (JIT) Provisioning of user accounts?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#do-you-support-just-in-time-jit-provisioning-of-user-accounts) Yes. Overleaf accounts are provisioned by users who receive email invitations to join their account to the group and link to their SSO identity. Do you support SCIM?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#do-you-support-scim) Individual users provision their own Overleaf accounts, System for Cross-domain Identity Management (SCIM), is a standard for automation of user provisioning. Because your system will not be provisioning users in Overleaf, SCIM isn’t supported or required. Does a user need to be created in our IdP before they create an Overleaf account?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#does-a-user-need-to-be-created-in-our-idp-before-they-create-an-overleaf-account) If your subscription has SSO enabled, it’s best to have users created in your IdP before they’re invited to join the subscription. This allows users to create their Overleaf accounts, link to their SSO identity, and join your subscription in one step. However, this is not required, as your team members can link their Overleaf account to their SSO identity at any time. If I delete a user in my identity system, will their Overleaf account be deleted?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#if-i-delete-a-user-in-my-identity-system-will-their-overleaf-account-be-deleted) No. Deleting a user in your IdP will not delete their account in Overleaf. Overleaf accounts are deleted in Overleaf by the account owner. This is either the user themselves or the manager of the account (when [Managed Users](https://docs.overleaf.com/groups/user-management/managed-user-accounts) is enabled). Can SSO be made an exclusive login option?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#can-sso-be-made-an-exclusive-login-option) Yes. If your group uses our [Managed Users](https://docs.overleaf.com/groups/user-management/managed-user-accounts) feature, the managed user accounts will be set to use SSO exclusively. See [Linking users to Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/linking-users-to-group-sso) . Users will have to create a temporary Overleaf-specific password during the account creation and SSO linking process. For each user, SSO will become exclusive once they have linked their SSO identity to their Overleaf account and accepted the invitation to have their account managed. Administrators can check on the management and SSO status of each account on their group administration page. I'm seeing an error when I try to log in—what do I do?[](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs#im-seeing-an-error-when-i-try-to-log-in-what-do-i-do) Please see [Logging in with group single sign-on](https://www.overleaf.com/learn/how-to/Logging_in_with_your_group_single_sign-on) for troubleshooting suggestions. If you’re still having problems, please notify your group administrator and [contact us](https://www.overleaf.com/contact) if the issue cannot be resolved by them. [PreviousMaintaining Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso) [NextRenewing a subscription](https://docs.overleaf.com/groups/subscription-management/renewing-a-subscription) Last updated 11 months ago Was this helpful? Was this helpful? --- # FAQs | Groups | Overleaf docs [](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#plan-management) Plan management ----------------------------------------------------------------------------------------------------------------------------------------- Can I change plans or cancel later?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#can-i-change-plans-or-cancel-later) Yes, you can do this at any time by going to **Account > Subscription** when logged in to Overleaf. You can change plans, switch between monthly and annual billing options, or cancel to downgrade to the free plan. When canceling, your subscription will continue until the end of the billing period. If I change or cancel my Overleaf plan, will I lose my projects?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#if-i-change-or-cancel-my-overleaf-plan-will-i-lose-my-projects) No. Changing or canceling your plan won’t affect your projects, the only change will be to the features available to you. You can see which features are available only on paid plans in the comparison table. Is an Overleaf Group plan more cost effective?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#is-an-overleaf-group-plan-more-cost-effective) Our Group subscriptions allow you to purchase access to our premium features for multiple people. They’re easy to manage, help save on paperwork, and reduce the cost of purchasing multiple subscriptions separately. [](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#payments-and-invoicing) Payments and invoicing ------------------------------------------------------------------------------------------------------------------------------------------------------- Can I pay by invoice or purchase order?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#can-i-pay-by-invoice-or-purchase-order) This is possible when you’re purchasing a group subscription for **five or more people, or a site license**. For individual subscriptions, we can only accept payment online via credit card, debit card, or PayPal. Who is eligible for the educational discount?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#who-is-eligible-for-the-educational-discount) The educational discount for group subscriptions is for students or faculty who are using Overleaf primarily for teaching. [](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#user-management) User management ----------------------------------------------------------------------------------------------------------------------------------------- What’s the difference between users and collaborators on an Overleaf group subscription?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#whats-the-difference-between-users-and-collaborators-on-an-overleaf-group-subscription) On any of our group plans, the number of users refers to the number of people you can invite to join your group. All of these people will have access to the plan’s paid-for features across all their projects, such as real-time track changes and document history. Collaborators are people that your group users may invite to work with them on their projects. So, for example, if you have the Group Standard plan, the users in your group can invite up to 10 people to work with them on a project. And if you have the Group Professional plan, your users can invite as many people to work with them as they want. Can I add more users to my group subscription at a later date?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#can-i-add-more-users-to-my-group-subscription-at-a-later-date) Absolutely. To add more users to your subscription you’ll just need to contact the [Overleaf Support Team](https://www.overleaf.com/contact) . Does the lead admin need to consume a license or can they just manage the group?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#does-the-lead-admin-need-to-consume-a-license-or-can-they-just-manage-the-group) The Lead Admin does not need to consume a license to manage the group. They can oversee group management tasks — such as adding and removing members, assigning roles, and viewing metrics — without using one of the group’s available licenses. However, if the Lead Admin wants to access the Premium subscription features included with the group, they will need to add themselves as a Group Member, which will consume a license. What’s the difference between users in a group and collaborators?[](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#whats-the-difference-between-users-in-a-group-and-collaborators) Users in a group are individuals who are part of an Overleaf group subscription. They benefit from the subscription’s features, such as access to Premium features (depending on the group plan). Group users are managed by the Lead Admin or Group Managers and consume a license from the group subscription. Collaborators, on the other hand, are people you share projects with. They can work on a shared Overleaf project regardless of whether they are part of your group subscription. Collaborators do not need to be members of your group or have a Premium subscription; they can use the free version of Overleaf to access shared projects. [Group SSO FAQs](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs) [PreviousAccessing invoices and receipts](https://docs.overleaf.com/groups/subscription-management/accessing-invoices-and-receipts) Last updated 11 months ago Was this helpful? * [Plan management](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#plan-management) * [Payments and invoicing](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#payments-and-invoicing) * [User management](https://docs.overleaf.com/groups/troubleshooting-and-support/common-problems-and-how-to-fix-them#user-management) Was this helpful? --- # Step 2: Configure your SSO settings with IdP metadata | Groups | Overleaf docs With the information from your IdP gathered in [Step 1](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider) , you will be able to configure the Overleaf side of the trust relationship and identify the attributes that your IdP will be sending Overleaf when your team members log in. The group administrator can configure and enable SSO on an Overleaf Professional subscription. The SSO configuration page is accessible from the group administrator’s subscription page in their Overleaf account: [https://overleaf.com/user/subscription](https://overleaf.com/user/subscription) . ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F573wTyFph05rz4THEoenED%2F525a860e1033ec941476d37e3c74099d%2Fgroup-sso-settings-link.png&width=768&dpr=4&quality=100&sign=309ee93&sv=2) The SSO configuration is saved while it is being tested. Once SSO is enabled, certificates can be added and removed while the rest of the configuration is locked. If any other part of the configuration other than certificates needs to be updated, it will be necessary to temporarily disable SSO. There are additional instructions for [maintaining your Overleaf group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso) . Please provide information from your IdP on the Edit SSO configuration page. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2FX0FIxrxQRxsE2apIrDanA%2Fa2368b13dcda59a80cac909c22c08f22%2Fedit-sso-config.png&width=768&dpr=4&quality=100&sign=eae3b39e&sv=2) Field Description Redirect URL The Redirect URL is an endpoint provided by your IdP. This is sometimes called the Single Sign On Service HTTP-Redirect location. This might be a generic endpoint that is used for all services, or it may be one that is specifically generated by your IdP for Overleaf. This can usually be found in your IdP’s SAML metadata XML file. This URL is sometimes called the “SAML Endpoint” or “SSO URL”. Unique Identifier The Unique Identifier is an attribute or claim that you release to Overleaf which allows us to identify each user. The values sent for this attribute must be unique, persistent, and non-reassignable. You should be able to find the name of this attribute as a released claim in your IdP under the Overleaf service definition. User first name attribute The optional first name attribute will be used to initialize the Overleaf account for users who register through SSO. If the user has already provided this data to Overleaf, the attribute values sent will not be used. Users can update their first name in their Overleaf Account Settings. You should be able to find the name of this attribute as a released claim in your IdP under the Overleaf service definition. User last name attribute The optional last name attribute will be used to initialize the Overleaf account for users who register through SSO. If the user has already provided this data to Overleaf, the attribute values sent will not be used. Users can update their last name in their Overleaf Account Settings. You should be able to find the name of this attribute as a released claim in your IdP under the Overleaf service definition. Primary certificate You only need to provide the Primary Certificate. In most cases, the certificate can be found as a “signing” X509Certificate element within the IdP metadata. This certificate can also be provided from a `.pem` file. If your IdP provides the signing certificate in `.pem` file format, simply paste the contents of the file into this field. The option to provide additional certificates is to allow for a smooth changeover when an existing certificate expires. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata#how-did-it-go-checklist-for-complete-the-group-settings-sso-configuration) **How did it go? Checklist for “Complete the Group Settings SSO configuration”** ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ * The descriptions on this page for each part of the configuration have been reviewed. * All the required fields have been entered on the **Configure SSO** page. * The redirect URL is a valid Single Sign On Service HTTP-Redirect URL that can be accessed by the Overleaf service. * The attributes names (unique identifier, user first name, user last name) match those for the claims being released by the IdP to the Overleaf service. * The attribute identified as the Unique Identifier will have values that are unique, persistent, and non-reassignable. Once you've provided all the configuration data on this page, the SSO configuration in your IdP and Overleaf is ready to be tested. [PreviousStep 1: Add Overleaf to your Identity Provider](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-1-add-overleaf-to-your-identity-provider) [NextStep 3: Verify the connection between your IdP and Overleaf](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf) Last updated 3 months ago Was this helpful? Was this helpful? --- # Maintaining Group SSO | Groups | Overleaf docs This page is for Group Professional administrators who have configured and enabled single sign-on (SSO). Please see [Setting up Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) if this has not already been set up. You can modify your SSO setup to complete tasks such as adding certificates, changing other aspects of your IdP configuration. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#managing-your-users-in-overleaf) Managing your users in Overleaf ------------------------------------------------------------------------------------------------------------------------------------------------------------- ![Group members list](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F5PhtKjmQMO5gI2o37aLX9I%2F675319512bbde2968d7ed17a9b6d4fab%2Fimage4.png&width=300&dpr=4&quality=100&sign=1208cfe7&sv=2) Within your members management page, you're able to see which members are linked to your SSO. Members will receive an email notification to authenticate with your SSO provider once SSO is enabled and they are also encouraged to do so after logging in. (Also see [Adding and removing users and managers](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) .) Your members will now be required to link to your SSO provider. Once linked, they will have the option to log in via SSO or other login methods unless Managed Users is enabled. (See [Linking users to Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/linking-users-to-group-sso) .) ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F3E7qyKVwcZ3mgZfl4JqJ3l%2F621d3cf994bccb4784563e61d6f8fa35%2Fimage12.png&width=768&dpr=4&quality=100&sign=1fb94f87&sv=2) Via the three-dot menu at the end of the row in the members table, there are options to help manage your members. For members who are not linked, you can send an email reminder to authenticate with your SSO provider. For members who are linked, you can unlink them from your SSO provider so that they can reauthenticate. This action should only be taken when you need to correct the unique identifier associated with a specific user. See [Updating your SSO setup](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#updating-your-sso-setup) if the unique identifier needs to be corrected for all group members. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#understanding-errors-reported-by-users) Understanding errors reported by users --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Below are some errors that your users might encounter when authenticating their Overleaf account with your SSO provider for the first time or when trying to log in via your SSO provider. * * * This email address isn’t set up for SSO. Please check it and try again or contact your administrator. Members will see this message if they try to log in via SSO but their account is not yet authenticated with your SSO provider. They will need to log into their Overleaf account as they did before. After logging in, members will be directed to the SSO enrollment page. They can also authenticate with your SSO provider via their user settings page. * * * Sorry, you are trying to log in to X but the identity returned by your identity provider is not the correct one for this Overleaf account. The email address they tried to log in with is not associated with the unique identifier from your IdP. The member will need to log out of your SSO provider and log in with the correct account. * * * Sorry, the information received from your identity provider is not signed (both response and assertion signatures are required). Please contact your administrator for more information. This is a configuration problem within your IdP. The authentication request with your SSO provider failed because your SSO provider is no longer sending a signed response and assertion. * * * [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#updating-your-sso-setup) Updating your SSO setup --------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#unlinking-users-from-your-sso-provider) Unlinking users from your SSO provider Your Overleaf Group SSO settings include an option to Unlink users. If you are migrating to a new IdP or changing the attributes that are being sent to Overleaf by your IdP, you may need to use the Unlink users option. ![Unlink users](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2FmOttqGTiLTUHNGzdZKff9%2F81afff3df24c19d320abe66782039db6%2Fimage9.png&width=300&dpr=4&quality=100&sign=b29607b4&sv=2) The Unlink users option removes the unique identifier from every group member’s account, essentially removing the login option via your SSO provider. This action requires each user to relink their Overleaf account to their SSO identity and they will receive an email notification to do so. There is also the option to unlink individual users to correct issues unique to specific users. See [Managing your users in Overleaf](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#managing-your-users-in-overleaf) . An administrator should unlink all members only if they are making a change to the IdP configuration that changes the name or the values of the Unique Identifier. All other aspects of the SSO configuration, including the Redirect URL and the Certificates can change without requiring the unlinking of users. ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#updating-your-certificate) Updating your certificate The certificates that IdPs use to sign the responses that they send to services expire after a certain period of time. It's important to keep the certificate that has been provided to Overleaf up to date. If your certificate has expired, your users will see an error when attempting to log in to Overleaf. You can check on your certificate expiry dates in the SSO configuration section of your Group Settings. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2FuXM5Me5eDrRjnhc3cpMD6%2F0a9e55798d9efbcf52bcbda3322f9932%2Fcert.png&width=768&dpr=4&quality=100&sign=1d336e74&sv=2) Overleaf's SSO configuration page provides a way to ensure that certificates can be replaced without interrupting access to the Overleaf service. 1. Add the new certificate to Overleaf's SSO configuration page. You will now have two certificates configured: the original certificate and the updated new certificate. 2. You can keep these two certificates in place until you have completed the certificate change over in your IdP. 3. Once your IdP is using the new certificate, you can remove the original certificate in Overleaf. ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#changing-your-idp-configuration) Changing your IdP configuration You might sometimes need to change other aspects of the Identity Provider (IdP) configuration. This can happen if you're changing the solution that you're using for your IdP, for example. In cases like this, you will have to temporarily disable SSO access. You can disable SSO via your group settings page. After disabling, you can click View configuration and then Edit to modify and test your new IdP configuration. When SSO access is disabled, Overleaf users can log in to their Overleaf accounts using their email address and an Overleaf-specific password. Users will receive a notification by email when SSO access is disabled. Once SSO is enabled again, they can log in again via SSO without needing to re-link their Overleaf account to their SSO identity. If your configuration changed the unique identifier then you will need to Unlink users. See [Unlinking users from your SSO provider](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#unlinking-users-from-your-sso-provider) . ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F3qVsiQaEC4mTPAEFpiUgYk%2F5c1bf953977486c0810d570ef81f46b0%2Fimage1.png&width=768&dpr=4&quality=100&sign=d0583858&sv=2) [PreviousLinking users to Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/linking-users-to-group-sso) [NextGroup SSO FAQs](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/group-sso-faqs) Last updated 1 year ago Was this helpful? * [Managing your users in Overleaf](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#managing-your-users-in-overleaf) * [Understanding errors reported by users](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#understanding-errors-reported-by-users) * [Updating your SSO setup](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#updating-your-sso-setup) * [Unlinking users from your SSO provider](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#unlinking-users-from-your-sso-provider) * [Updating your certificate](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#updating-your-certificate) * [Changing your IdP configuration](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso#changing-your-idp-configuration) Was this helpful? --- # Managed Users | Groups | Overleaf docs This feature is only available to [Overleaf Group Professional subscribers](https://www.overleaf.com/user/subscription/plans) . Our Managed Users feature gives you more control over your organization’s use of Overleaf. It ensures tighter management of user access and deletion and allows you to keep control of projects when someone leaves the organization. [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#whats-the-difference-between-a-managed-overleaf-account-and-an-unmanaged-overleaf-account) What’s the difference between a managed Overleaf account and an unmanaged Overleaf account? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you enable Managed Users for your group, members of the subscription will not be able to: * Delete their account * Change their account email address * Have a secondary email address (or add a secondary address) * Link their account to ORCID * Start a new subscription or join another subscription using the same email address * Purchase or use AI features [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#the-group-administrator-role) The group administrator role ----------------------------------------------------------------------------------------------------------------------------------------- Managed Users can only be enabled by a group subscription administrator. Once it's enabled, the administrator and group Managers will have admin rights over managed user accounts. Administrators and Managers will be able to: * Remove any member from the subscription * Delete any subscription members account * Reassign ownership of projects when the original owner’s account is deleted Only **Lead Administrators** can enable Managed Users. [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#enabling-managed-users) Enabling Managed Users ----------------------------------------------------------------------------------------------------------------------------- 1\. As the **Lead Administrator** for the group subscription, first, navigate to your [subscription settings](https://www.overleaf.com/user/subscription) , then click **Manage group settings**. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fsharelatex-wiki-cdn-671420.c.cdn77.org%2Flearn-scripts%2Fimages%2F7%2F74%2FGroup_settings.png&width=768&dpr=4&quality=100&sign=167996ff&sv=2) Screenshot of the group settings menu, found under Subscription 2\. Under **Manage group settings**, go to the Managed Users section and select Enable Managed Users. 3\. You’ll be asked to confirm that you accept [Overleaf’s terms and conditions](https://www.overleaf.com/legal) . Once you’ve done this, you can click Enable Managed Users. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fsharelatex-wiki-cdn-671420.c.cdn77.org%2Flearn-scripts%2Fimages%2Fa%2Fa1%2FEnable_Managed_Users.png&width=768&dpr=4&quality=100&sign=f3c80acd&sv=2) Enable Managed Users 4\. Clicking **Enable Managed Users** will automatically send invitations to all your existing group members to transfer the management of their accounts to you. The email they receive will clearly explain the differences between managed and unmanaged accounts, as well as how to keep their personal projects separate. This information is also available on the [managed user accounts page](https://www.overleaf.com/learn/how-to/Understanding_Managed_Overleaf_Accounts) . [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#reviewing-the-managed-status-of-group-members) Reviewing the managed status of group members --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1\. You can review the managed status of your group members by going to your [subscription settings](https://www.overleaf.com/user/subscription) and selecting Manage group members. 2\. On the Member management page, you’ll see a table of subscription members and people invited to the subscription. Those that are managed will be clearly indicated in the Security column with a green tick and the word “Managed.” 3\. If they’re already a subscription member, but haven't yet accepted your invitation to become managed, there will be a red cross. Those that have been invited to the subscription but haven't yet joined it will show as Pending invite, with a clock icon. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fsharelatex-wiki-cdn-671420.c.cdn77.org%2Flearn-scripts%2Fimages%2F4%2F4c%2FMember_managed_status.png&width=768&dpr=4&quality=100&sign=35dcdf48&sv=2) Member managed status 4\. If a member doesn’t respond to your initial invitation to transfer management of their account, you can send them a reminder email by clicking the three-dot menu and selecting Resend Managed User invite. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fsharelatex-wiki-cdn-671420.c.cdn77.org%2Flearn-scripts%2Fimages%2Ff%2Fff%2FResend_invite.png&width=768&dpr=4&quality=100&sign=1f96b02b&sv=2) Resend invite [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#inviting-new-users-to-your-subscription) Inviting new users to your subscription --------------------------------------------------------------------------------------------------------------------------------------------------------------- You can find out how to invite new members to your group subscription in [Adding and removing users and managers](https://docs.overleaf.com/groups/user-management/how-to-add-and-remove-users) . Depending on whether the person you’re inviting is an existing Overleaf user or a new user, they will either be asked to transfer management of their account or to register for an account that’s managed. In both cases, the concept of managed user accounts and what this means for them will be clearly explained to them in the email invitation to join the subscription. [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#removing-managed-users-from-your-subscription) Removing Managed Users from your subscription --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Group Professional Administrators and Managers with Managed Users enabled have two options for removing user accounts from their group subscription: * **Remove User (Non-Destructive):** This action removes the user account from the group subscription, returning ownership of the account and projects to the original account owner. * **Delete User (Destructive):** This action deletes the user account and transfers ownership of the projects within that account to another designated managed user in the group. ### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#returning-ownership-of-a-managed-account-to-the-original-account-owner) Returning ownership of a managed account to the original account owner #### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#what-does-this-feature-do) What does this feature do? This feature allows Group Pro Administrators and Managers to remove a user from a managed group in a non-destructive way. When a managed user is removed: * They are removed from the group. * They are no longer a managed user. * They retain their existing account on the Overleaf free plan. * They retain ownership of projects currently owned by them. Any collaborators on those projects become read-only, but one collaborator can be given write permissions, in line with free plan limits. * They continue to have access to any projects shared with them. * They will no longer be able to log in with SSO (if enabled) and will need to set an Overleaf password. #### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#when-would-i-use-this-feature) When would I use this feature? This non-destructive option allows for the removal of a managed user from the group subscription while preserving the account holder's project ownership and access to shared projects. Choosing this option would be useful when: * A user has joined the group using the wrong account or with an incorrect email address. * There is a need to offboard group members while allowing them to retain access to projects. * Exempt user accounts from SSO login. #### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#how-do-i-use-this-feature) How do I use this feature? 1\. To remove a user, go to "[Your subscription](https://www.overleaf.com/user/subscription) " settings and select "Group members". 2\. On the "Members management" page, you’ll see a table of subscription members. To remove a user, click the three-dot menu on the row of the table corresponding to that user and select "Remove user". ![A drop down menu containing the options to Resend SSO invite, Delete user and Remove user. Remove user is highlighted.](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FdPveGc3KDz4netykl73o%252FRemove%2520user%2520from%2520Managed%2520Group.png%3Falt%3Dmedia%26token%3Db1f9c15d-701a-4b29-96b8-6f4de9d3ad27&width=768&dpr=4&quality=100&sign=aa0ac726&sv=2) Remove user 3\. The next screen explains the implications of removing the user. As a final step, you’ll be asked to enter the email address associated with the account you’re removing. This is to ensure that you’re absolutely certain you want to remove the account from the subscription without it being deleted. Once you’ve entered the required information, click "Remove user". ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FgXQBsXNLwhcYkT5QjaPM%252FRemover%2520user%2520confirmation%2520screen.png%3Falt%3Dmedia%26token%3D6646f11a-9a26-4ef0-9cdd-7c942850018e&width=768&dpr=4&quality=100&sign=c6953b97&sv=2) Remove user from the managed group ### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#deleting-users-and-transferring-project-ownership) Deleting users and transferring project ownership #### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#what-does-this-feature-do-1) What does this feature do This destructive feature enables Group Pro Administrators and Managers to delete a managed user account. Deleting an account removes the account from your group subscription and transfers ownership of any projects associated with the account to another managed user within the group. When a managed user is deleted: * The account is removed from the group. * The account is **permanently** deleted from Overleaf. * The original account owner will lose access to all projects within the account. * Ownership of projects is transferred to another managed users within the group. #### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#when-would-i-use-this-feature-1) When would I use this feature? This functionality is particularly useful when a managed user leaves your group or organization. Deleting their managed account facilitates their removal from your group subscription. As part of this process, it is necessary to transfer ownership of any projects created by the departing user to another active managed user within the group so that you can retain access to those projects. #### [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#how-do-i-use-this-feature-1) How do I use this feature? 1\. To delete a user, go to "[Your subscription](https://www.overleaf.com/user/subscription) " settings and select "Group members". 2\. On the "Members management" page, you’ll see a table of subscription members. To delete a user, click the three-dot menu on the row of the table corresponding to that user and select "Delete user". ![A drop down menu containing the options to Resend SSO invite, Delete user and Remove user. Delete user is highlighted.](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FHr36BuZFRpCZC02lfsCh%252FDelete%2520user%2520in%2520Managed%2520Group.png%3Falt%3Dmedia%26token%3D87c3d4e4-28a7-4e85-b770-a89b924ffd45&width=768&dpr=4&quality=100&sign=4410883c&sv=2) Delete user 3\. The next screen explains the implications of deleting a user and asks you to select who you would like to transfer the deleted user’s projects to. As a final step, you’ll be asked to enter the email address associated with the account you’re deleting. This is to ensure that you’re absolutely certain you want to delete the account. Once you’ve entered the required information, click "Delete User". ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2F1394141003-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FFkLpFt1iQKGbutGQMi1h%252Fuploads%252FepyRe168YBjgBDb5kDKO%252FDelete%2520user%2520confirmation%2520screen.png%3Falt%3Dmedia%26token%3D5011a052-7e2d-4140-a9cc-a3941e4033e6&width=768&dpr=4&quality=100&sign=c9efaf9d&sv=2) Delete user and transfer files 4\. You will then see a screen showing you the progress of the project transfer. [](https://docs.overleaf.com/groups/user-management/managed-user-accounts#still-need-help) Still need help? ---------------------------------------------------------------------------------------------------------------- If you need help with any aspect of user management, please contact [\[email protected\]](https://docs.overleaf.com/cdn-cgi/l/email-protection#21525451514e5355614e5744534d4440470f424e4c) . [PreviousControlling feature availability](https://docs.overleaf.com/groups/user-management/controlling-feature-availability) [NextSetting up Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) Last updated 3 months ago Was this helpful? * [What’s the difference between a managed Overleaf account and an unmanaged Overleaf account?](https://docs.overleaf.com/groups/user-management/managed-user-accounts#whats-the-difference-between-a-managed-overleaf-account-and-an-unmanaged-overleaf-account) * [The group administrator role](https://docs.overleaf.com/groups/user-management/managed-user-accounts#the-group-administrator-role) * [Enabling Managed Users](https://docs.overleaf.com/groups/user-management/managed-user-accounts#enabling-managed-users) * [Reviewing the managed status of group members](https://docs.overleaf.com/groups/user-management/managed-user-accounts#reviewing-the-managed-status-of-group-members) * [Inviting new users to your subscription](https://docs.overleaf.com/groups/user-management/managed-user-accounts#inviting-new-users-to-your-subscription) * [Removing Managed Users from your subscription](https://docs.overleaf.com/groups/user-management/managed-user-accounts#removing-managed-users-from-your-subscription) * [Returning ownership of a managed account to the original account owner](https://docs.overleaf.com/groups/user-management/managed-user-accounts#returning-ownership-of-a-managed-account-to-the-original-account-owner) * [Deleting users and transferring project ownership](https://docs.overleaf.com/groups/user-management/managed-user-accounts#deleting-users-and-transferring-project-ownership) * [Still need help?](https://docs.overleaf.com/groups/user-management/managed-user-accounts#still-need-help) Was this helpful? --- # Step 3: Verify the connection between your IdP and Overleaf | Groups | Overleaf docs Testing the trust relationship and configuration that has been set up between your IdP and Overleaf involves logging in through your IdP through the testing interface provided by Overleaf. The user account for this test does not need to be invited to the Overleaf group subscription. Any valid user account in your IdP can be used to test the SSO setup in Overleaf. No data will be saved for this test account, and no Overleaf account will be created for the test user during the testing phase. To proceed with the test, click the button on the test screen to be redirected to your IdP to log in. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2FtfFQJ0dUVQRkHU7EJv7rL%2F4f8bfc9e0cf6c59ab69889668a11007e%2Ftest-config.png&width=768&dpr=4&quality=100&sign=7067a77d&sv=2) * If after clicking on Test configuration you arrive at your IdP login screen, provide the username and credentials for your test user and log in as usual. * If you do not see your login page, but see some form of error, don't panic! Errors are not uncommon at this stage. Please see our [test troubleshooting guide](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting) . After logging in, you may see a screen that reports a successful test. If so, that’s great—you can now enable SSO for your team. If you see an error or a warning from the Overleaf test validation page saying that something went wrong, please see [our test troubleshooting guide](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting) . ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F19pkcqQ1R7WiqAGRopoLSn%2F20fd1b9afde96ba0b1b4885aa9513996%2Fsso-successful-test.png&width=768&dpr=4&quality=100&sign=9246bac8&sv=2) [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf#how-did-it-go-checklist-for-testing) **How did it go? Checklist for “Testing”** -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * All errors and warnings identified by the Test configuration process have been addressed. * A successful test has been reported. If you're having trouble, please review the [test troubleshooting guide](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting) . Fixing problems may require adjusting the configuration in your IdP and in Overleaf. If you are unable to complete the test, please [get in touch](https://www.overleaf.com/contact) . [PreviousStep 2: Configure your SSO settings with IdP metadata](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-2-configure-your-sso-settings-with-idp-metadata) [NextGroup SSO test troubleshooting](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting) Last updated 1 year ago Was this helpful? Was this helpful? --- # Group SSO test troubleshooting | Groups | Overleaf docs This page is for administrators of Overleaf Group Professional plans who are testing their [SSO configuration.](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso) The [Maintaining Group SSO](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/maintaining-group-sso) page has information about troubleshooting SSO issues reported by group members. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#four-phases-of-testing) Four phases of testing ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Testing the [Overleaf Group SSO](https://www.overleaf.com/learn/how-to/Overleaf_Group_single_sign-on) consists of four different phases, and it is possible for problems to occur at any stage. The chart below summarizes what is happening at each stage of the testing flow, and identifies some issues which may occur. ![](https://docs.overleaf.com/~gitbook/image?url=https%3A%2F%2Fimages.ctfassets.net%2Fnrgyaltdicpt%2F4vpmsYGoDa7scev60eVoWM%2F59eb3daf305ebaab911795b81fed9306%2FFourPhaseTest.png&width=768&dpr=4&quality=100&sign=52df5234&sv=2) Test flow phase Details Causes of problems 1 An Authentication Request is sent from Overleaf to your IdP. Overleaf sends a SAML request to your IdP’s single sign-on redirect URL (provided to Overleaf in setup [Step 2](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_2._Complete_the_Group_Settings_SSO_Configuration) ) signed with Overleaf’s certificate (provided to your IdP in setup [Step 1](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_1._Add_Overleaf_to_your_Identity_Provider) ). A problem here looks like: An immediate problem after pressing the Test button may be caused by an issue at this phase. If you don’t see your IdP login screen, you have a problem in phase 1. The wrong Redirect Endpoint URL was set in Overleaf (from your IdP). A mistake was made providing Overleaf’s certificate to your IdP. 2 Login at your IdP. Your IdP presents you with a log on screen. You log in using an account that is authorized to access Overleaf (configured in setup [Step 1](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_1._Add_Overleaf_to_your_Identity_Provider) ). A problem here looks like: An error shown by your IdP indicates a problem at this phase. If you don’t get back to Overleaf after logging in, you have a problem in phase 2. Overleaf is not registered as a service or app in your IdP. Your user is not authorized to access Overleaf. 3 Your IdP sends an Authentication Response to Overleaf. Your IdP sends a SAML response to Overleaf’s Assertion Consumer Service endpoint (provided to your IdP in [Step 1](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_1._Add_Overleaf_to_your_Identity_Provider) ) using your IdP’s certificate (provided to Overleaf in setup [Step 2](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_2._Complete_the_Group_Settings_SSO_Configuration) ). A problem here looks like: An unexpected error in Overleaf after logging in. There is a mistake in the Overleaf ACS endpoint that was configured in your IdP. A mistake was made in providing your IdP’s certificate to Overleaf. 4 Overleaf processes the response from your IdP. Overleaf will check the SAML attributes released by your IdP (set up in [Step 1](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_1._Add_Overleaf_to_your_Identity_Provider) ) and compare these with the attributes Overleaf is expecting (set up in setup [Step 2](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_2._Complete_the_Group_Settings_SSO_Configuration) ). A problem here looks like: Overleaf received the authentication response from your IdP, but something is missing or different than expected. The Unique Identifier was not released to Overleaf in your IdP. The Unique Identifier has a different name than what was expected. If there is a misconfiguration either in your IdP or in Overleaf, one or more of these steps might fail. Fixing the problem may require going back and adjusting the configuration either in your IdP or in Overleaf. [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#examples-of-errors) Examples of errors ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-1-problem) Test flow phase 1 problem Clicking on the Test configuration button does not take you to a login screen. * Verify that the Redirect URL provided to Overleaf in [Step 2](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_2._Complete_the_Group_Settings_SSO_Configuration) is the Single Sign On HTTP-Redirect URL from your IdP metadata. * Verify that Overleaf has been configured as a service provider in your IdP, that this configuration is enabled, and that it includes the signing certificate provided in Overleaf’s SAML metadata ([https://www.overleaf.com/saml/group-sso/meta](https://www.overleaf.com/saml/group-sso/meta) ). ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-2-problem) Test flow phase 2 problem An access denied or similar error is shown by your IdP after you log in. * Verify that the test user that you are logging in with has been authorized to access Overleaf in your IdP. This may require creating a security group in your IdP and adding the user to the security group. ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-3-problem) Test flow phase 3 problem A server error is shown from Overleaf after you log in. * Verify that the Overleaf configuration is using the valid signing certificate provided by your IdP. * Verify that the Assertion Consumer Service endpoint provided to your IdP is the Assertion Consumer Service endpoint found in Overleaf’s SAML metadata ([https://www.overleaf.com/saml/group-sso/meta](https://www.overleaf.com/saml/group-sso/meta) ). Another exception or error is raised. * If you see a problem that is not identified on this page, please [contact our support team](https://www.overleaf.com/contact) . Be sure to let us know the email address associated with your Overleaf subscription administrator’s account, and describe the problem you're seeing. Including a screen capture of any error message or problem will help. ### [](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-4-problem) Test flow phase 4 problem A validation warning is shown on the test results page. * Verify that the name you provided for the unique identifier matches the attribute name that was released in your IdP for Overleaf and that this matches the name of the attribute that was sent to Overleaf. Below are some error codes that you might see in a phase 3 or phase 4 problem, along with some details about the problem and some possible remedies. Error code Problem Remedy `SAMLInvalidSignatureError` or `SAMLMissingSignatureError` This could be due to a certificate problem with the certificates that you have provided to Overleaf in setup [Step 2](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_2._Complete_the_Group_Settings_SSO_Configuration) . It could also be due to not setting the correct signing option for the responses sent to Overleaf in [Step 1](https://www.overleaf.com/learn/how-to/Setting_up_Group_single_sign-on#Step_1._Add_Overleaf_to_your_Identity_Provider) . Check the metadata from your IdP and ensure that you are providing a valid X509 signing certificate. Your metadata may include several certificates, some could be out of date. You can add each available X509 signing certificate in Overleaf. We recommend that you remove outdated certificates from the configuration. Also, verify that the responses and assertions returned by your IdP are signed. In Azure, for example, you can choose various signing options as described [here](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/certificate-signing-options) . Please ensure that you have chosen to sign both the SAML response and the assertion. `MISSING_EXTERNAL_USER_ID` or `INVALID_EXTERNAL_USER_ID` Overleaf did not find the Unique Identifier in the SAML that was sent in the Authentication Response. Look at the SAML data shown to see if the Unique Identifier was sent under a different name. It can happen that IdPs will send this data under a different label. Change the configuration in Overleaf to match the name of the attribute that was sent. If there is no attribute that includes the Unique Identifier, it may not have been released by your IdP. Back in the settings for the Overleaf service in your IdP, make sure that this attribute or claim has been released. `MISSING_FIRSTNAME_ATTRIBUTE` `MISSING_LASTNAME_ATTRIBUTE` Overleaf did not find the first name attribute or the last name attribute that was specified in the group SSO setup. Look at the SAML data shown to see if the missing attribute was sent under a different name. It can happen that IdPs will send this data under a different label. Change the configuration in Overleaf to match the name of the attribute that was sent. If there is no attribute that includes the missing information it may not have been released by your IdP. Back in the settings for the Overleaf service in your IdP, make sure that this attribute or claim has been released [PreviousStep 3: Verify the connection between your IdP and Overleaf](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf) [NextStep 4: Enable SSO for your team](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-4-enable-sso-for-your-team) Last updated 11 months ago Was this helpful? * [Four phases of testing](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#four-phases-of-testing) * [Examples of errors](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#examples-of-errors) * [Test flow phase 1 problem](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-1-problem) * [Test flow phase 2 problem](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-2-problem) * [Test flow phase 3 problem](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-3-problem) * [Test flow phase 4 problem](https://docs.overleaf.com/groups/overleaf-group-single-sign-on/setting-up-group-sso/step-3-verify-the-connection-between-your-idp-and-overleaf/group-sso-test-troubleshooting#test-flow-phase-4-problem) Was this helpful? --- # Skills needed | On-premises | Overleaf docs We recommend that the on-site administrator of your Overleaf instance has: * General IT administration skills * Familiarity with Linux command line tools * General networking knowledge and troubleshooting skills * Experience backing up and restoring production systems * Experience running applications using Docker is a bonus * Experience with coordinating maintenance windows for upgrades of live production systems We find that on-site administrators with these skills will be able to provide the best experience for users of Overleaf at your organization. [PreviousRequirements](https://docs.overleaf.com/on-premises/getting-started/requirements) [NextHardware requirements](https://docs.overleaf.com/on-premises/getting-started/requirements/hardware-requirements) Last updated 1 year ago Was this helpful? Was this helpful? --- # Before you start | On-premises | Overleaf docs Before you install Overleaf, it's important to familiarize yourself with the requirements, installation process, configuration options, and upgrade sections of this documentation. It's also crucial to have a solid understanding of your organization's requirements for using Overleaf and the necessary underlying infrastructure needed for its successful operation. [](https://docs.overleaf.com/on-premises/getting-started/before-you-start#what-can-i-do-to-prepare) What can I do to prepare? ---------------------------------------------------------------------------------------------------------------------------------- Understand the requirements for running Overleaf. This involves evaluating your organization's existing server environment, network capabilities and storage resources. Ensure that your infrastructure meets or exceeds the specified requirements outlined in this documentation. Before initiating the installation process, ensure you have administrative access to the server where you intend to deploy Overleaf. This may involve coordinating with your IT team or system administrators to obtain the necessary permissions and resources. Additionally, review any security considerations or network policies that might impact the installation. [Requirements](https://docs.overleaf.com/on-premises/getting-started/requirements) [](https://docs.overleaf.com/on-premises/getting-started/before-you-start#what-if-i-have-a-problem) What if I have a problem? ---------------------------------------------------------------------------------------------------------------------------------- Please note that we are **not** able to provide support for local installations of the free Community Edition. If you encounter any problems, we recommend first consulting the [troubleshooting](https://docs.overleaf.com/on-premises/support/troubleshooting) section of the documentation as it contains common issues and required information needed by the support team if you need to reach out for assistance. By following these steps and thoroughly reading the documentation, you'll be well-prepared to install, configure, and maintain Overleaf according to your organization's requirements. Remember that a solid understanding of your infrastructure and the installation process is key to a successful deployment. [PreviousRelease notes 0.x.x](https://docs.overleaf.com/on-premises/release-notes/release-notes-0.x.x) [NextRequirements](https://docs.overleaf.com/on-premises/getting-started/requirements) Last updated 1 year ago Was this helpful? * [What can I do to prepare?](https://docs.overleaf.com/on-premises/getting-started/before-you-start#what-can-i-do-to-prepare) * [What if I have a problem?](https://docs.overleaf.com/on-premises/getting-started/before-you-start#what-if-i-have-a-problem) Was this helpful? --- # Email Protection | Cloudflare Please enable cookies. Email Protection ================ You are unable to access this email address docs.overleaf.com ------------------------------------------------------------- The website from which you got to this page is protected by Cloudflare. Email addresses on that page have been hidden in order to keep them from being accessed by malicious bots. **You must enable Javascript in your browser in order to decode the e-mail address**. If you have a website and are interested in protecting it in a similar way, you can [sign up for Cloudflare](https://www.cloudflare.com/sign-up?utm_source=email_protection) . * [How does Cloudflare protect email addresses on website from spammers?](https://developers.cloudflare.com/waf/tools/scrape-shield/email-address-obfuscation/) * [Can I sign up for Cloudflare?](https://developers.cloudflare.com/fundamentals/setup/account/create-account/) Cloudflare Ray ID: **9b8abefe2af9d6db** • Your IP: Click to reveal 54.237.218.47 • Performance & security by [Cloudflare](https://www.cloudflare.com/5xx-error-landing) --- # Integrations and add-ons | Overleaf docs There are several integrations and tools that you can link with Overleaf to gain access to even more features for your projects: [Git integration and GitHub synchronization](https://docs.overleaf.com/integrations-and-add-ons/git-integration-and-github-synchronization) [Dropbox](https://docs.overleaf.com/integrations-and-add-ons/dropbox) [Reference Manager integrations](https://docs.overleaf.com/integrations-and-add-ons/reference-manager-integrations) [R code (knitr)](https://docs.overleaf.com/integrations-and-add-ons/r-code-knitr) [AI features](https://docs.overleaf.com/integrations-and-add-ons/ai-features) [Grammarly](https://docs.overleaf.com/integrations-and-add-ons/grammarly) [Google Drive](https://docs.overleaf.com/integrations-and-add-ons/google-drive) Last updated 3 months ago Was this helpful? Was this helpful? --- # Navigating in the editor | Overleaf docs Learn how to use the Overleaf Editor to optimize your workflow and customize your display: [Working with the PDF viewer](https://docs.overleaf.com/navigating-in-the-editor/working-with-the-pdf-viewer) [Selecting and managing files](https://docs.overleaf.com/navigating-in-the-editor/selecting-and-managing-files) [Searching within a project](https://docs.overleaf.com/navigating-in-the-editor/searching-within-a-project) [Editor display font](https://docs.overleaf.com/navigating-in-the-editor/editor-display-font) [Generated files](https://docs.overleaf.com/navigating-in-the-editor/generated-files) [Keyboard shortcuts](https://docs.overleaf.com/navigating-in-the-editor/keyboard-shortcuts) [Vim and Emacs keybinding](https://docs.overleaf.com/navigating-in-the-editor/vim-and-emacs-keybinding) Last updated 3 months ago Was this helpful? Was this helpful? --- # Writing and editing | Overleaf docs Overleaf has features that can reduce the amount of LaTeX code from scratch needed and provide key information about your project: [Inserting images](https://docs.overleaf.com/writing-and-editing/inserting-images) [Generating and inserting tables](https://docs.overleaf.com/writing-and-editing/generating-and-inserting-tables) [Inserting symbols](https://docs.overleaf.com/writing-and-editing/inserting-symbols) [History and versioning](https://docs.overleaf.com/writing-and-editing/history-and-versioning) [Using Word Count](https://docs.overleaf.com/writing-and-editing/using-word-count) Last updated 3 months ago Was this helpful? Was this helpful? --- # Troubleshooting and support | Overleaf docs If you are stuck on an issue, here are some go-to fixes along with Overleaf's troubleshooting features: [Fixing LaTeX errors](https://docs.overleaf.com/troubleshooting-and-support/fixing-latex-errors) [Fixing and preventing compile timeouts](https://docs.overleaf.com/troubleshooting-and-support/fixing-and-preventing-compile-timeouts) [Resolving PDF rendering and project loading problems](https://docs.overleaf.com/troubleshooting-and-support/resolving-pdf-rendering-and-project-loading-problems) [Code Check](https://docs.overleaf.com/troubleshooting-and-support/code-check) [Supported browsers](https://docs.overleaf.com/troubleshooting-and-support/supported-browsers) [Clearing the project cache](https://docs.overleaf.com/troubleshooting-and-support/clearing-the-project-cache) [Stop on first error](https://docs.overleaf.com/troubleshooting-and-support/stop-on-first-error) [Checklist for arXiv submissions](https://docs.overleaf.com/troubleshooting-and-support/checklist-for-arxiv-submissions) [TeX Live](https://docs.overleaf.com/troubleshooting-and-support/tex-live) [File encodings and line endings](https://docs.overleaf.com/troubleshooting-and-support/file-encodings-and-line-endings) [User support policy](https://docs.overleaf.com/troubleshooting-and-support/user-support-policy) Get in touch[](https://docs.overleaf.com/troubleshooting-and-support/troubleshooting-and-support#get-in-touch) [Contact Support](https://www.overleaf.com/contact) Last updated 3 months ago Was this helpful? Was this helpful? --- # Managing projects and files | Overleaf docs Overleaf allows you to take control of your projects through various organizational features: [Renaming a project](https://docs.overleaf.com/managing-projects-and-files/renaming-a-project) [Copying a project](https://docs.overleaf.com/managing-projects-and-files/copying-a-project) [Uploading a project](https://docs.overleaf.com/managing-projects-and-files/uploading-a-project) [Downloading a project](https://docs.overleaf.com/managing-projects-and-files/downloading-a-project) [Archiving, deleting, and leaving projects](https://docs.overleaf.com/managing-projects-and-files/archiving-deleting-and-leaving-projects) [Organizing projects with tags](https://docs.overleaf.com/managing-projects-and-files/organizing-projects-with-tags) [Adding files to a project](https://docs.overleaf.com/managing-projects-and-files/adding-files-to-a-project) [The latexmkrc file](https://docs.overleaf.com/managing-projects-and-files/the-latexmkrc-file) [Adding LaTeX dependencies](https://docs.overleaf.com/managing-projects-and-files/adding-latex-dependencies) Last updated 3 months ago Was this helpful? Was this helpful? --- # Subscriptions, payments, and billing | Overleaf docs Overleaf offers multiple kinds of subscriptions and ways to manage them to suit your needs: [Renewing your subscription](https://docs.overleaf.com/subscriptions-payments-and-billing/renewing-your-subscription) [Group subscription](https://docs.overleaf.com/subscriptions-payments-and-billing/group-subscription) [Commons subscription](https://docs.overleaf.com/subscriptions-payments-and-billing/commons-subscription) [Canceling your subscription](https://docs.overleaf.com/subscriptions-payments-and-billing/canceling-your-subscription) Last updated 3 months ago Was this helpful? Was this helpful? ---