Helix Authentication Service Administrator Guide (2023.2)

About the Helix Authentication Service Administrator Guide

Helix Authentication Service enables you to integrate certain Perforce products with your organization's Identity Provider (IdP).

To get started, see:

What's new in this Guide

2023.2	Web-based administration is a convenient alternative to manually editing the `.env` file to configure OIDC and SAML providers. `SAML_FORCE_AUTHN` can force the user to authenticate with each login request. `OIDC_MAX_AGE` sets the maximum age in seconds before reauthentication is required. CLIENT_CERT_FP and `CLIENT_CERT_CN` support using bracketed list with comma-separated values. If you want to use HAS with Helix Swarm, a script can help you with Swarm troubleshooting. An additional troubleshooting tip is Azure AD SAML authentication method mismatch. The BEARER_TOKEN_FILE setting makes sending your configuration file to Perforce Support more secure. Example Identity Provider configurations have been updated. For a complete list of what's new in the product, see the 2023.2 release notes.
2023.1	Support for a configuration involving Multiple providers `SAML_CERT_FILE` and `SAML_KEY_FILE` for connecting to a SAML IdP and when signing SAML responses for client applications, such as Swarm. For a complete list of what's new in the product, see the 2023.1 release notes.
2022.2	See Warning and workaround for SAML security. Support for debugging for SAML and the provisioning of groups and users. See `DEBUG_SAML` and `DEBUG_SCIM` in Other Settings. Support for debugging HAS when load balancing is involved. See `DEBUG_PROXY` in Other Settings. `CLIENT_CERT_FP` provides additional security (see Other Settings). `OIDC_SELECT_ACCOUNT` has been added to the OpenID Connect settings The Example Helix Swarm configuration has been improved. A new feature in provisioning is How to re-activative a user. For a complete list of what's new in the product, see the 2022.2 release notes.
2022.1	Support for Hansoft, Helix TeamHub, and Helix DAM. See Supported client applications and minimal versions. Implementation of a System for Cross-domain Identity Management (SCIM) for Helix Core user and group provisioning through your cloud service provider. Support for authentication through JSON web tokens. See Settings for JSON web token authentication. Support for Redis with client certificates. See REDIS_CERT_FILE. SVC_GROUP and SVC_USER added as settings for the process that runs Helix Authentication Service. If you are upgrading to 2022.1: rename `ecosystem.config.js` to `ecosystem.config.cjs` change the extension of the file referred to by LOGGING to be `.cjs` instead of `.js` change the extension of the file referred to by IDP_CONFIG_FILE to be `.cjs` instead of `.js` For a complete list of what's new in the product, see the 2022.1 release notes.
2021.2	See the 2021.2 release notes.
2021.1	Simplifies installation and configuration for package and install script users: no need to download and work with pm2 the `example.env` file provides a starting point for your `.env` file. See Configuring Helix Authentication Service. Adds support for using the identity provider's metadata as a file instead of URL. See SAML settings > `SAML_IDP_METADATA_FILE`
2020.2	Supports Installing as a Windows service , as well as running HAS as a Docker container (see Four ways to install HAS)

Additional help

For Helix Core: Helix Core Server Administrator Guide and Helix Core Extensions Developer Guide

For Helix ALM: Helix ALM Server Admin Guide and Helix ALM License Server Admin Guide

For Hansoft: Hansoft System Administrator Guide