Setting up authentication for the on-premises gateway
To set up the authentication for the on-premises gateway
- Create a tenant administrator account for BMC Helix SSO:
- Log on to the BMC Helix SSO Admin Console as a SaaS administrator.
- Click Tenant and from the list of tenants, select a tenant.
- Click the pin icon to switch to the BMC Helix SSO Admin Console of the selected tenant.
- On the navigation panel, click the Admin User tab.
The list of administrator users is displayed. - (Optional) Click Add Admin User.
On the Add Admin User page enter the following information and click Save:- Login: Enter a name of the BMC Helix SSO administrator.
- Password: Create a password for the tenant administrator account.
- Confirm Password: Confirm the password for the tenant administrator account.
The tenant administrator account is added and is available in List of Admin Users.
- Register the OAuth client:
- Log on to the BMC Helix SSO Admin Console as a tenant administrator by using the credentials you created in step1(f).
- Click OAuth2.
- On the OAuth2 and OpenID Configuration page, click the Clients tab.
- Click Register Client.
- Enter a name for the OAuth client.
- Ensure that the Enabled check box is selected to enable the client for authorization.
- Click Add Redirect URI, and then add the URI in the following format to which the authorization code is sent after an /authorize request succeeds. The client side must support the URI.
https://<hostName>:<portNumber>/swpui/auth/code/callback
In the URL:- Replace <hostName> with the fully-qualified domain name of the server where the on-premises gateway is installed.
- Replace <portNumber> with a custom port if you are using a port other than the default of 443.
- Select the openid (Scope used for OpenID connect) check box to enable the OAuth client to use the OpenID Connect protocol.
Click Save.
The following information is automatically generated when you register the client:Client ID
Registers the client identifier issued to the client by BMC Helix SSO server during the registration process. You can view this information when you select the registered client.
Client Secret
Shows the client secret (private key) only after you click Save.
The private key is used to sign the JWT, which contains the client authorization. This JWT is different from the one containing the end-user credentials that is used in the JWT assertion grant type.- Save the Client ID and Client Secret values in a file somewhere because these values will not be displayed again.
- Log out of the BMC Helix SSO admin console.
- Add a realm and configure authentication for the realm:
- Log on to the BMC Helix SSO console as a SaaS administrator.
- Click the edit icon corresponding to the realm of the tenant.
- In Application Domain(s), enter the fully-qualified domain name of the server where the on-premises gateway is installed.
- Click Save.
Where to go from here
Deploy the on-premises gateway on Docker or Podman containers:
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*