IS integration

HPA platform use Keycloak product to authenticate users against the different components of HPA platform.

  • OpenID protocol for HPA Portal
  • SAML protocol for HPA Webview (Broadcom webview)

The components redirect the user to keycloak for the authentication flow, Keycloak can be connected to LDAP, or others OAuth/OpenID providers.

Certificates

The protocol used by HPA require as secure https protocol.

To achieve this, each component can expose a certificate, see security config

Keycloak configuration

By default, the keycloak expose his administration portal on [https://:8443](https://:8443).

The default user is : admin
The default password is : hexagon

The realm master is reserved to Keycloak administration.

The realm hexagon-hpa is the one used by HPA components for the authentication flow, this is the one to configure.
Select the realm to configure it.

Keycloak_realm

Realm hexagon-hpa

Select the realm hexagon-hpa in the realm list and then click on User federation

Default user

A default user is created in this realm, you can remove/modify in the Users section.

Groups

Group/role usage

Since version 2024.01.01, an admin role is required on the portal for :

  • Debug session stop/start
  • Alerts management
  • Agent settings

Admin role of HPA is stored in security.config in variable
export HPA_ROLE_ADMIN="Admin"

This variable indicate which role of the user will be considered as Administrator.

On Broadcom Introscope product the profile mechanism is :

  • Administrator : can read/write on all domains
  • User : can read/write on part of the domains
  • Guest : can read on everything.

HPA product do not split the agents in different domains, so only Administrator role is used. The same variable HPA_ROLE_ADMIN is used.

Group/role definition

Keycloak must return the role to the portal and in the saml client com.ca.apm.webview.serviceprovider and the openid client hpa-client

Update to 2024.01.01

See upgrading to 2024.01.01

LDAP integration

See LDAP integration

Identify providers

For others type of integration (SAML, OpenID, …) click on Identity providers

keycloak_identity