Log in/Log out

When you are not logged into Swarm, certain features are unavailable to you, such as providing comments to changes or reviews, adding projects, and more.

Log in to Swarm

1. Click the Log in link found at the right of the main toolbar.
Tip

If Helix SAML is configured for your Helix Server and Swarm you will be directed to the sign in process used by your Identity Provider (IdP).

2. Type in your username and password, appropriate for the Helix Server that Swarm is configured to use.

3. Select the Remember Me check box if you prefer to stay logged in between browser restarts.

   Note

   The Helix Server can enforce maximum login times. You may become logged out even if Remember Me is selected. Swarm administrators can change the maximum login time, see Sessions for details.

4. Click the Login button.
Note

If Multi-Factor Authentication (MFA) is configured for your Helix Server, complete your additional MFA steps to log in to Swarm.

Log out of Swarm

1. Click your userid, found at the right of the main toolbar.
2. Select Log out from the drop-down menu.
Tip

• If Helix SAML is configured for your Helix Server, logging out of Swarm will not invalidate your Identity Provider (IdP) login status. If you try to log back in to Swarm while your IdP status is still valid, you will not be prompted to complete the log in steps.

If require_login is also enabled, Swarm will return you to the login and your IdP will automatically log you back in. In this case log out from your Identity Provider page before logging out from Swarm.

• If Multi-Factor Authentication (MFA) is configured for your Helix Server, logging out of Swarm will not invalidate your MFA status. If you log back in to Swarm while your MFA status is still valid, you will not be prompted to complete the additional MFA log in steps.

• If a custom redirect has been configured by your Swarm administrator, you are logged out of Swarm and then redirected to the URL specified by the administrator.

The custom redirect can be set to any internal or external URL, for example:

• Company intranet, extranet, internet, FTP, or Web-mail page
• Industry news website
• Identity Provider page to invalidate your IdP log in status
• MFA provider page to invalidate your MFA log in status

require_login

By default, Swarm requires users to login, which prevents anonymous users from accessing a Helix Server via Swarm. Users who have not logged in see a login page immediately when visiting Swarm:

The steps to log in are identical to using the Login dialog.

Swarm administrators can disable require_login to allow anonymous users to see commits, reviews, etc.