Helix SAML
Helix Swarm is a browser-based web app that supports web browser single sign-on, the primary use case for the Security Assertion Markup Language (SAML) standard.
The Helix Core clients are not browser-based web apps. Such clients include:
- Helix Command-Line Client (P4)
- Helix Visual Client (P4V)
- Helix Plugin for Visual Studio (P4VS)
- Helix Plugin for File Explorer (P4EXP)
For such clients, the Helix SAML feature provides an integration with SAML 2.0 for authentication that enables the following flow:
When the user of a Helix Core client application attempts any command or action that requires logging in, the Helix SAML agent prompts the user for credentials. The organization's Identity Provider sends a response that the auth-check-sso trigger validates. If the user credentials are verified, the user gains access to the Helix Core client application through the usual Ticket-based authentication.
Prerequisites
- On the server, configure an auth-check-sso trigger that works with your IdP:
- Read "Triggering to use external authentication"
- See the instructions at https://swarm.workshop.perforce.com/projects/perforce_software-helix-saml
- On the Helix Core client, each end-user machine needs an installation of the Helix SAML agent (see "Installation of the Helix SAML agent" below)Note
Helix Swarm is a browser-based web app, and therefore does not need an installation of the Helix SAML agent. For instructions on configuring the Swarm server for this feature, see "Helix SAML authentication PHP config" in the Helix Swarm Guide.
System Requirements
Server
Helix Core18.2 patch server (December 2018 or later)
Client
A Helix Core client, such as:
- P4 (December 2018 or later)
- P4V 18.4
- P4VS 18.4
- P4EXP 18.4
Installation of the Helix SAML agent
- P4V has a Windows installer that includes an option to install the Helix SAML agent
- P4V on Mac or Linux and all of the other Helix Core clients require running the standalone installer for the Helix SAML agent
- Helix Swarm is a web-based application, and therefore does not require an installation of the the Helix SAML agent
For further details, see the release notes for your client.